Struct edict::system::ActionEncoderState

pub struct ActionEncoderState { /* private fields */ }

FnArgState for ActionEncoder argument.

Trait Implementations

impl Default for ActionEncoderState

fn default() -> ActionEncoderState

Returns the “default value” for a type.

impl FnArgState for ActionEncoderState

type Arg<'a> = ActionEncoder<'a>

Corresponding argument type of the function-system.

fn new() -> Self

Constructs the state instance.

fn is_local(&self) -> bool

Returns true for local arguments that can be used only for local function-systems.

fn world_access(&self) -> Option<Access>

Returns access type performed on the entire World.

fn visit_archetype(&self, _archetype: &Archetype) -> bool

Checks if this argument will visit specified archetype. Called only for scheduling purposes.

fn borrows_components_at_runtime(&self) -> bool

Returns true if components accessed by the argument are borrowed at runtime, allowing other args that conflict with it run if they too borrow components at runtime.

fn component_access(&self, _comp: &ComponentInfo) -> Option<Access>

Returns access type to the specified component type this argument may perform. Called only for scheduling purposes.

fn resource_type_access(&self, _ty: TypeId) -> Option<Access>

Returns access type to the specified resource type this argument may perform. Called only for scheduling purposes.

unsafe fn get_unchecked<'a>( &'a mut self, world: NonNull<World>, queue: &mut dyn ActionBufferQueue, ) -> ActionEncoder<'a>

Extracts argument from the world. This method is called with synchronization guarantees provided according to requirements returned by FnArgState::is_local, FnArgState::world_access, FnArgState::visit_archetype, FnArgState::component_access and FnArgState::resource_type_access.

unsafe fn flush_unchecked( &mut self, _world: NonNull<World>, queue: &mut dyn ActionBufferQueue, )

Flushes the argument state. This method is called after system execution, when Arg is already dropped.