Skip to main content

ActionContext

Struct ActionContext 

Source
pub struct ActionContext<'a> {
    pub actor: Option<EntityId>,
    pub now: Tick,
    pub instance_id: InstanceId,
    /* private fields */
}
Expand description

Read-only context passed to ActionCompute::compute. Carries the originating actor, current tick, and a borrowed view of the instance for limited introspection.

Fields§

§actor: Option<EntityId>

Optional originating entity (e.g. the player who submitted the action). None for system-injected actions.

§now: Tick

Tick at which step() is processing this action.

§instance_id: InstanceId

InstanceId of the instance the action runs against.

Implementations§

Source§

impl<'a> ActionContext<'a>

Source

pub fn entities_len(&self) -> usize

Number of entities currently registered in the instance.

Source

pub fn components_len(&self) -> usize

Total component count across all entities.

Source

pub fn local_tick(&self) -> u64

Logical local tick of the instance.

Auto Trait Implementations§

§

impl<'a> Freeze for ActionContext<'a>

§

impl<'a> RefUnwindSafe for ActionContext<'a>

§

impl<'a> Send for ActionContext<'a>

§

impl<'a> Sync for ActionContext<'a>

§

impl<'a> Unpin for ActionContext<'a>

§

impl<'a> UnsafeUnpin for ActionContext<'a>

§

impl<'a> UnwindSafe for ActionContext<'a>

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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.