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 SpriteKind::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
, which should be enforced in
tests, if possible.
collectible_info
must be Some
for a sprite to be collectible.
Adding a loot table to other sprites will not enable collecting
them. is_defined_as_container
is necessary to avoid displaying
items from the default loot table (and all containers are included in
collectible_info
).
NOTE: this is sent to the clients, we may potentionally strip this info on sending.
Trait Implementations§
Source§impl<'de> Deserialize<'de> for SpriteCfg
impl<'de> Deserialize<'de> for SpriteCfg
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for SpriteCfg
impl RefUnwindSafe for SpriteCfg
impl Send for SpriteCfg
impl Sync for SpriteCfg
impl Unpin for SpriteCfg
impl UnwindSafe for SpriteCfg
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<C, M> ConvertSaveload<M> for C
impl<C, M> ConvertSaveload<M> for C
§type Error = Infallible
type Error = Infallible
§fn convert_into<F>(
&self,
_: F,
) -> Result<<C as ConvertSaveload<M>>::Data, <C as ConvertSaveload<M>>::Error>
fn convert_into<F>( &self, _: F, ) -> Result<<C as ConvertSaveload<M>>::Data, <C as ConvertSaveload<M>>::Error>
Data
) using
entity to marker mapping function§fn convert_from<F>(
data: <C as ConvertSaveload<M>>::Data,
_: F,
) -> Result<C, <C as ConvertSaveload<M>>::Error>
fn convert_from<F>( data: <C as ConvertSaveload<M>>::Data, _: F, ) -> Result<C, <C as ConvertSaveload<M>>::Error>
Data
) using
entity to marker mapping function§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<Context> SubContext<Context> for Context
impl<Context> SubContext<Context> for Context
fn sub_context(self) -> Context
§impl<T> TryDefault for Twhere
T: Default,
impl<T> TryDefault for Twhere
T: Default,
§fn try_default() -> Result<T, String>
fn try_default() -> Result<T, String>
§fn unwrap_default() -> Self
fn unwrap_default() -> Self
try_default
and panics on an error case.