Skip to main content

EntityData

Struct EntityData 

Source
pub struct EntityData<T> { /* private fields */ }
Expand description

A value kept on each entity, by uuid, at its key (the mod’s own: <mod>:<key>); its default where the entity has none yet.

ⓘ
static HITS: EntityData<u32> = EntityData::new("hits");
HITS.with_mut(&damage.uuid, |n| *n += 1);

Implementations§

Source§

impl<T: Schema + Default> EntityData<T>

Source

pub const fn new(key: &'static str) -> Self

Saved with the entity.

Source

pub const fn session(key: &'static str) -> Self

Kept while the entity is loaded, not saved (a Yog Script member synced and not saved).

Source

pub fn with<R>(&self, uuid: &str, read: impl FnOnce(&T) -> R) -> R

What read makes of entity uuid’s value: the server’s where it runs here, else what this client was sent.

Source

pub fn with_mut<R>(&self, uuid: &str, change: impl FnOnce(&mut T) -> R) -> R

Entity uuid’s value changed by change, and set (server side: sent to the players who see it by the tick’s end).

Auto Trait Implementations§

§

impl<T> Freeze for EntityData<T>
where PhantomData<fn() -> T>: Freeze,

§

impl<T> RefUnwindSafe for EntityData<T>
where PhantomData<fn() -> T>: RefUnwindSafe,

§

impl<T> Send for EntityData<T>
where PhantomData<fn() -> T>: Send,

§

impl<T> Sync for EntityData<T>
where PhantomData<fn() -> T>: Sync,

§

impl<T> Unpin for EntityData<T>
where PhantomData<fn() -> T>: Unpin,

§

impl<T> UnsafeUnpin for EntityData<T>
where PhantomData<fn() -> T>: UnsafeUnpin,

§

impl<T> UnwindSafe for EntityData<T>
where PhantomData<fn() -> T>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Arg<T> for T

Source§

fn arg(self) -> T

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.