Class ButtonSpriteMapData

Definition

Namespace: StardewUI.Data
Assembly: StardewUI.dll

JSON configuration data for a ButtonSpriteMap.

public class ButtonSpriteMapData

Inheritance
Object ⇦ ButtonSpriteMapData

The data is based on having the sprites themselves registered as assets, e.g. via StardewUI.Data.SpriteSheetData.

Name	Description
ButtonSpriteMapData()

Name	Description
Buttons	Map of buttons to the asset name used for that button's sprite.
ControllerBlank	Name of the sprite asset to use for ControllerBlank.
KeyboardBlank	Name of the sprite asset to use for KeyboardBlank.
MouseLeft	Name of the sprite asset to use for MouseLeft.
MouseMiddle	Name of the sprite asset to use for MouseMiddle.
MouseRight	Name of the sprite asset to use for MouseRight.

public ButtonSpriteMapData();

Map of buttons to the asset name used for that button's sprite.

public System.Collections.Generic.Dictionary<StardewModdingAPI.SButton, string> Buttons { get; set; }

Specific button sprites replace the ControllerBlank or KeyboardBlank and therefore must include both the border and inner icon/text.

Name of the sprite asset to use for ControllerBlank.

public string ControllerBlank { get; set; }

Used as the background for any controller button lacking its own unique sprite; the button name is rendered inside as regular text.

Name of the sprite asset to use for KeyboardBlank.

public string KeyboardBlank { get; set; }

Used as the background for any key lacking its own unique sprite; the key name is rendered inside as regular text.

Name of the sprite asset to use for MouseLeft.

public string MouseLeft { get; set; }

Name of the sprite asset to use for MouseMiddle.

public string MouseMiddle { get; set; }

Name of the sprite asset to use for MouseRight.

public string MouseRight { get; set; }