Skip to content

Interface ISpriteMap<T>

Definition

Namespace: StardewUI.Graphics
Assembly: StardewUI.dll

Provides a single method to obtain a sprite for some key, such as SButton.

public interface ISpriteMap<T>

Type Parameters

T
Type of key for which to obtain sprites.

Members

Methods

Name Description
Get(T, Boolean) Gets the sprite corresponding to a particular key.

Details

Methods

Get(T, Boolean)

Gets the sprite corresponding to a particular key.

StardewUI.Graphics.Sprite Get(T key, out System.Boolean isPlaceholder);
Parameters

key   T
The key to retrieve.

isPlaceholder   Boolean
true if the returned Sprite is not specific to the key, but is instead a placeholder (border/background) in which some substitute, typically normal text, must be drawn. false if the Sprite is a complete self-contained representation of the key.

Returns

Sprite

The precise or generic sprite for the given key.