Class UiSprites

Definition

Namespace: StardewUI.Graphics
Assembly: StardewUI.dll

Included game sprites that are required for many UI/menu widgets.

public static class UiSprites

Inheritance
Object ⇦ UiSprites

Members

Properties

Name	Description
BannerBackground	Background for the a banner or "scroll" style text, often used for menu/dialogue titles.
ButtonDark	Button with a darker background, usually the neutral state.
ButtonLight	Button with a lighter background, usually used to show hover state.
CaretLeft	A caret-style directional arrow pointing left.
CaretRight	A caret-style directional arrow pointing right.
CheckboxChecked	Checkbox with a green "X" through it.
CheckboxUnchecked	Unchecked checkbox, i.e. only the border.
CloseButton	Red X with border/background, generally used as upper-right close button for menus.
ControlBorder	Border/background sprite for an individual control, such as a button. Less prominent than MenuBorder.
ControlBorderUncolored	Colorless border/background sprite for an individual control, such as a button. Less prominent than MenuBorderUncolored.
Digits	List of sprites for the outlined "tiny digits" 0-9, in that order.
DropDownBackground	Background of a drop-down menu.
DropDownButton	Button to pull down a drop-down menu.
GenericHorizontalDivider	Simpler, lighter horizontal divider than the MenuHorizontalDivider, used as a horizontal rule to separate content areas without sectioning the entire menu.
GenericHorizontalDividerUncolored	Colorless horizontal divider that is simpler and lighter the MenuHorizontalDividerUncolored, used as a horizontal rule to separate content areas without sectioning the entire menu.
LargeDownArrow	Large down arrow, used for macro navigation.
LargeLeftArrow	Large left arrow, used for macro navigation.
LargeRightArrow	Large right arrow, used for macro navigation.
LargeUpArrow	Large up arrow, used for macro navigation.
MenuBackground	Background used for the in-game menu, not including borders.
MenuBackgroundUncolored	Colorless background used for the in-game menu, not including borders.
MenuBorder	Modified 9-slice sprite used for the menu border, based on menu "tiles". Used for drawing the outer border of an entire menu UI.
MenuBorderThickness	The actual distance from the outer edges of the MenuBorder sprite to where the actual "border" really ends, in terms of pixels. The border tiles are quite large, so this tends to be needed in order to determine where the content should go without adding a ton of extra padding.
MenuBorderUncolored	Colorless version of the modified 9-slice sprite used for the menu border, based on menu "tiles". Used for drawing the outer border of an entire menu UI.
MenuHorizontalDivider	Modified 9-slice sprite used for the menu's horizontal divider, meant to be drawn over top of the MenuBorder to denote separate "sub-panels" or "sections" of the menu to group logically very different menu functions (as opposed to lines on a grid).
MenuHorizontalDividerMargin	Margin adjustment to apply to content adjacent to a MenuHorizontalDivider to make content flush with the border; adjusts for internal sprite padding.
MenuHorizontalDividerUncolored	Colorless version of the modified 9-slice sprite used for the menu's horizontal divider, meant to be drawn over top of the MenuBorderUncolored to denote separate "sub-panels" or "sections" of the menu to group logically very different menu functions (as opposed to lines on a grid).
MenuSlotInset	Inset-style background and border, often used to hold an item or represent a slot.
MenuSlotInsetUncolored	Colorless inset-style background and border, often used to hold an item or represent a slot.
MenuSlotOutset	Outset-style background and border, often used to hold an item or represent a slot.
MenuSlotTransparent	Single-line rectangular border with a slight inset look.
MenuSlotTransparentUncolored	Colorless single-line rectangular border with a slight inset look.
MenuVerticalDivider	Modified 9-slice sprite used for the menu's vertical divider, meant to be drawn over top of the MenuBorder to denote separate "sub-panels" or "sections" of the menu to group logically very different menu functions (as opposed to lines on a grid).
MenuVerticalDividerMargin	Margin adjustment to apply to content adjacent to a MenuVerticalDivider to make content flush with the border; adjusts for internal sprite padding.
MenuVerticalDividerUncolored	Colorless version of the modified 9-slice sprite used for the menu's vertical divider, meant to be drawn over top of the MenuBorderUncolored to denote separate "sub-panels" or "sections" of the menu to group logically very different menu functions (as opposed to lines on a grid).
ScrollBarTrack	Background for the scroll bar track (which the thumb is inside).
SliderBackground	Background of a slider control.
SliderButton	The movable part of a slider control ("button").
SmallDownArrow	Small down arrow, typically used for scroll bars.
SmallGreenPlus	A small green "+" icon.
SmallLeftArrow	Small left arrow, typically used for top-level list navigation.
SmallRightArrow	Small right arrow, typically used for top-level list navigation.
SmallTrashCan	Small and tall trash can, larger than the TinyTrashCan and more suitable for tall rows.
SmallUpArrow	Small up arrow, typically used for scroll bars.
TabTopEmpty	Top-facing tab with no inner content, used for tab controls.
TextBox	Border/background for a text input box.
ThinHorizontalDivider	Simple horizontal divider, typically used to divide sections of uniform content, e.g. grid rows.
ThinHorizontalDividerUncolored	Simple, colorless horizontal divider, typically used to divide sections of uniform content, e.g. grid rows.
ThinVerticalDivider	Simple vertical divider, typically used to divide sections of uniform content, e.g. grid columns.
ThinVerticalDividerUncolored	Simple, colorless vertical divider, typically used to divide sections of uniform content, e.g. grid columns.
TinyTrashCan	Very small trash can, e.g. to be used in lists/subforms as "remove" button.
VerticalScrollThumb	Thumb sprite used for vertical scroll bars.
White	A single white pixel.
WhiteBorder	Nine-slice sprite consisting of 8 white edge pixels and a transparent center. Used for simple borders.

Details

Properties

BannerBackground

Background for the a banner or "scroll" style text, often used for menu/dialogue titles.

public static StardewUI.Graphics.Sprite BannerBackground { get; }

Property Value

Sprite

ButtonDark

Button with a darker background, usually the neutral state.

public static StardewUI.Graphics.Sprite ButtonDark { get; }

Property Value

Sprite

ButtonLight

Button with a lighter background, usually used to show hover state.

public static StardewUI.Graphics.Sprite ButtonLight { get; }

Property Value

Sprite

CaretLeft

A caret-style directional arrow pointing left.

public static StardewUI.Graphics.Sprite CaretLeft { get; }

Property Value

Sprite

Remarks

Can be used to show expanded/collapsed state, or illustrate a movement direction.

CaretRight

A caret-style directional arrow pointing right.

public static StardewUI.Graphics.Sprite CaretRight { get; }

Property Value

Sprite

Remarks

Can be used to show expanded/collapsed state, or illustrate a movement direction.

CheckboxChecked

Checkbox with a green "X" through it.

public static StardewUI.Graphics.Sprite CheckboxChecked { get; }

Property Value

Sprite

CheckboxUnchecked

Unchecked checkbox, i.e. only the border.

public static StardewUI.Graphics.Sprite CheckboxUnchecked { get; }

Property Value

Sprite

CloseButton

Red X with border/background, generally used as upper-right close button for menus.

public static StardewUI.Graphics.Sprite CloseButton { get; }

Property Value

Sprite

ControlBorder

Border/background sprite for an individual control, such as a button. Less prominent than MenuBorder.

public static StardewUI.Graphics.Sprite ControlBorder { get; }

Property Value

Sprite

ControlBorderUncolored

Colorless border/background sprite for an individual control, such as a button. Less prominent than MenuBorderUncolored.

public static StardewUI.Graphics.Sprite ControlBorderUncolored { get; }

Property Value

Sprite

Digits

List of sprites for the outlined "tiny digits" 0-9, in that order.

public static System.Collections.Generic.IReadOnlyList<StardewUI.Graphics.Sprite> Digits { get; }

Property Value

IReadOnlyList<Sprite>

DropDownBackground

Background of a drop-down menu.

public static StardewUI.Graphics.Sprite DropDownBackground { get; }

Property Value

Sprite

DropDownButton

Button to pull down a drop-down menu.

public static StardewUI.Graphics.Sprite DropDownButton { get; }

Property Value

Sprite

GenericHorizontalDivider

Simpler, lighter horizontal divider than the MenuHorizontalDivider, used as a horizontal rule to separate content areas without sectioning the entire menu.

public static StardewUI.Graphics.Sprite GenericHorizontalDivider { get; }

Property Value

Sprite

GenericHorizontalDividerUncolored

Colorless horizontal divider that is simpler and lighter the MenuHorizontalDividerUncolored, used as a horizontal rule to separate content areas without sectioning the entire menu.

public static StardewUI.Graphics.Sprite GenericHorizontalDividerUncolored { get; }

Property Value

Sprite

LargeDownArrow

Large down arrow, used for macro navigation.

public static StardewUI.Graphics.Sprite LargeDownArrow { get; }

Property Value

Sprite

LargeLeftArrow

Large left arrow, used for macro navigation.

public static StardewUI.Graphics.Sprite LargeLeftArrow { get; }

Property Value

Sprite

LargeRightArrow

Large right arrow, used for macro navigation.

public static StardewUI.Graphics.Sprite LargeRightArrow { get; }

Property Value

Sprite

LargeUpArrow

Large up arrow, used for macro navigation.

public static StardewUI.Graphics.Sprite LargeUpArrow { get; }

Property Value

Sprite

MenuBackground

Background used for the in-game menu, not including borders.

public static StardewUI.Graphics.Sprite MenuBackground { get; }

Property Value

Sprite

MenuBackgroundUncolored

Colorless background used for the in-game menu, not including borders.

public static StardewUI.Graphics.Sprite MenuBackgroundUncolored { get; }

Property Value

Sprite

MenuBorder

Modified 9-slice sprite used for the menu border, based on menu "tiles". Used for drawing the outer border of an entire menu UI.

public static StardewUI.Graphics.Sprite MenuBorder { get; }

Property Value

Sprite

MenuBorderThickness

The actual distance from the outer edges of the MenuBorder sprite to where the actual "border" really ends, in terms of pixels. The border tiles are quite large, so this tends to be needed in order to determine where the content should go without adding a ton of extra padding.

public static StardewUI.Layout.Edges MenuBorderThickness { get; }

Property Value

Edges

MenuBorderUncolored

Colorless version of the modified 9-slice sprite used for the menu border, based on menu "tiles". Used for drawing the outer border of an entire menu UI.

public static StardewUI.Graphics.Sprite MenuBorderUncolored { get; }

Property Value

Sprite

MenuHorizontalDivider

Modified 9-slice sprite used for the menu's horizontal divider, meant to be drawn over top of the MenuBorder to denote separate "sub-panels" or "sections" of the menu to group logically very different menu functions (as opposed to lines on a grid).

public static StardewUI.Graphics.Sprite MenuHorizontalDivider { get; }

Property Value

Sprite

MenuHorizontalDividerMargin

Margin adjustment to apply to content adjacent to a MenuHorizontalDivider to make content flush with the border; adjusts for internal sprite padding.

public static StardewUI.Layout.Edges MenuHorizontalDividerMargin { get; }

Property Value

Edges

MenuHorizontalDividerUncolored

Colorless version of the modified 9-slice sprite used for the menu's horizontal divider, meant to be drawn over top of the MenuBorderUncolored to denote separate "sub-panels" or "sections" of the menu to group logically very different menu functions (as opposed to lines on a grid).

public static StardewUI.Graphics.Sprite MenuHorizontalDividerUncolored { get; }

Property Value

Sprite

MenuSlotInset

Inset-style background and border, often used to hold an item or represent a slot.

public static StardewUI.Graphics.Sprite MenuSlotInset { get; }

Property Value

Sprite

MenuSlotInsetUncolored

Colorless inset-style background and border, often used to hold an item or represent a slot.

public static StardewUI.Graphics.Sprite MenuSlotInsetUncolored { get; }

Property Value

Sprite

MenuSlotOutset

Outset-style background and border, often used to hold an item or represent a slot.

public static StardewUI.Graphics.Sprite MenuSlotOutset { get; }

Property Value

Sprite

MenuSlotTransparent

Single-line rectangular border with a slight inset look.

public static StardewUI.Graphics.Sprite MenuSlotTransparent { get; }

Property Value

Sprite

MenuSlotTransparentUncolored

Colorless single-line rectangular border with a slight inset look.

public static StardewUI.Graphics.Sprite MenuSlotTransparentUncolored { get; }

Property Value

Sprite

MenuVerticalDivider

Modified 9-slice sprite used for the menu's vertical divider, meant to be drawn over top of the MenuBorder to denote separate "sub-panels" or "sections" of the menu to group logically very different menu functions (as opposed to lines on a grid).

public static StardewUI.Graphics.Sprite MenuVerticalDivider { get; }

Property Value

Sprite

MenuVerticalDividerMargin

Margin adjustment to apply to content adjacent to a MenuVerticalDivider to make content flush with the border; adjusts for internal sprite padding.

public static StardewUI.Layout.Edges MenuVerticalDividerMargin { get; }

Property Value

Edges

MenuVerticalDividerUncolored

Colorless version of the modified 9-slice sprite used for the menu's vertical divider, meant to be drawn over top of the MenuBorderUncolored to denote separate "sub-panels" or "sections" of the menu to group logically very different menu functions (as opposed to lines on a grid).

public static StardewUI.Graphics.Sprite MenuVerticalDividerUncolored { get; }

Property Value

Sprite

ScrollBarTrack

Background for the scroll bar track (which the thumb is inside).

public static StardewUI.Graphics.Sprite ScrollBarTrack { get; }

Property Value

Sprite

SliderBackground

Background of a slider control.

public static StardewUI.Graphics.Sprite SliderBackground { get; }

Property Value

Sprite

SliderButton

The movable part of a slider control ("button").

public static StardewUI.Graphics.Sprite SliderButton { get; }

Property Value

Sprite

SmallDownArrow

Small down arrow, typically used for scroll bars.

public static StardewUI.Graphics.Sprite SmallDownArrow { get; }

Property Value

Sprite

SmallGreenPlus

A small green "+" icon.

public static StardewUI.Graphics.Sprite SmallGreenPlus { get; }

Property Value

Sprite

Remarks

Technically used to represent energy buffs, can sometimes be tinted to communicate a concept like "add to list".

SmallLeftArrow

Small left arrow, typically used for top-level list navigation.

public static StardewUI.Graphics.Sprite SmallLeftArrow { get; }

Property Value

Sprite

SmallRightArrow

Small right arrow, typically used for top-level list navigation.

public static StardewUI.Graphics.Sprite SmallRightArrow { get; }

Property Value

Sprite

SmallTrashCan

Small and tall trash can, larger than the TinyTrashCan and more suitable for tall rows.

public static StardewUI.Graphics.Sprite SmallTrashCan { get; }

Property Value

Sprite

SmallUpArrow

Small up arrow, typically used for scroll bars.

public static StardewUI.Graphics.Sprite SmallUpArrow { get; }

Property Value

Sprite

TabTopEmpty

Top-facing tab with no inner content, used for tab controls.

public static StardewUI.Graphics.Sprite TabTopEmpty { get; }

Property Value

Sprite

TextBox

Border/background for a text input box.

public static StardewUI.Graphics.Sprite TextBox { get; }

Property Value

Sprite

ThinHorizontalDivider

Simple horizontal divider, typically used to divide sections of uniform content, e.g. grid rows.

public static StardewUI.Graphics.Sprite ThinHorizontalDivider { get; }

Property Value

Sprite

ThinHorizontalDividerUncolored

Simple, colorless horizontal divider, typically used to divide sections of uniform content, e.g. grid rows.

public static StardewUI.Graphics.Sprite ThinHorizontalDividerUncolored { get; }

Property Value

Sprite

ThinVerticalDivider

Simple vertical divider, typically used to divide sections of uniform content, e.g. grid columns.

public static StardewUI.Graphics.Sprite ThinVerticalDivider { get; }

Property Value

Sprite

ThinVerticalDividerUncolored

Simple, colorless vertical divider, typically used to divide sections of uniform content, e.g. grid columns.

public static StardewUI.Graphics.Sprite ThinVerticalDividerUncolored { get; }

Property Value

Sprite

TinyTrashCan

Very small trash can, e.g. to be used in lists/subforms as "remove" button.

public static StardewUI.Graphics.Sprite TinyTrashCan { get; }

Property Value

Sprite

VerticalScrollThumb

Thumb sprite used for vertical scroll bars.

public static StardewUI.Graphics.Sprite VerticalScrollThumb { get; }

Property Value

Sprite

White

A single white pixel.

public static StardewUI.Graphics.Sprite White { get; }

Property Value

Sprite

WhiteBorder

Nine-slice sprite consisting of 8 white edge pixels and a transparent center. Used for simple borders.

public static StardewUI.Graphics.Sprite WhiteBorder { get; }

Property Value

Sprite