Struct SpriteCfg

pub struct SpriteCfg {
    pub unlock: Option<UnlockKind>,
    pub content: Option<Content>,
    pub loot_table: Option<String>,
}

Fields

unlock: Option<UnlockKind>

Signifies that this sprite needs an item to be unlocked.

content: Option<Content>

Signifies a text associated with this sprite. This also allows (but not requires) internationalization.

Notice boards are an example of sprite that uses this.

loot_table: Option<String>

Signifies a loot table associated with this sprite. The string referes to the loot table asset identifier.

Chests are an example of sprite that can use this. For simple sprites like flowers using default_loot_spec() method is recommended instead.

If you place a custom loot table on a sprite, make sure it’s listed in SpriteKind::is_defined_as_container() to avoid minor bugs, which should be enforced in tests, in possible.

NOTE: this is sent to the clients, we may potentionally strip this info on sending.

Trait Implementations

impl Clone for SpriteCfg

fn clone(&self) -> SpriteCfg

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpriteCfg

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SpriteCfg

fn default() -> SpriteCfg

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SpriteCfg

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SpriteCfg

fn eq(&self, other: &SpriteCfg) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SpriteCfg

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SpriteCfg