Struct EntityProperty 

pub struct EntityProperty { /* private fields */ }

A component field that stores an optional reference to another entity, with lifecycle tracking across host/remote/delegated states.

Implementations

impl EntityProperty

pub fn new_for_message() -> Self

Creates an EntityProperty initialized for use inside a Message (no mutator).

pub fn new_for_component(mutator_index: u8) -> Self

Creates an EntityProperty initialized for use inside a Component at the given property index.

pub fn new_read( reader: &mut BitReader<'_>, converter: &dyn LocalEntityAndGlobalEntityConverter, ) -> Result<Self, SerdeErr>

Deserializes a new EntityProperty from the remote host’s bit stream.

pub fn read_write( reader: &mut BitReader<'_>, writer: &mut BitWriter, ) -> Result<(), SerdeErr>

Passes through an entity-property bit field from reader to writer without resolving entities.

pub fn read( &mut self, reader: &mut BitReader<'_>, converter: &dyn LocalEntityAndGlobalEntityConverter, ) -> Result<(), SerdeErr>

Updates this property’s inner relation from the remote host’s bit stream.

pub fn waiting_complete( &mut self, converter: &dyn LocalEntityAndGlobalEntityConverter, )

Resolves a waiting entity relation now that its target entity has arrived.

pub fn remote_publish(&mut self, mutator_index: u8, mutator: &PropertyMutator)

Migrate Remote Property to Public version

pub fn remote_unpublish(&mut self)

Migrate Remote Property to Public version

pub fn enable_delegation( &mut self, accessor: &EntityAuthAccessor, mutator_opt: Option<(u8, &PropertyMutator)>, )

Migrate Host/RemotePublic Property to Delegated version

pub fn disable_delegation(&mut self)

Migrate Delegated Property to Host-Owned (Public) version

pub fn localize(&mut self)

Migrate Host Property to Local version

pub fn set_mutator(&mut self, mutator: &PropertyMutator)

Sets the property mutator used to mark this field dirty on value changes.

pub fn bit_length( &self, converter: &mut dyn LocalEntityAndGlobalEntityConverterMut, ) -> u32

Returns the serialized bit length of this property given converter.

pub fn write( &self, writer: &mut dyn BitWrite, converter: &mut dyn LocalEntityAndGlobalEntityConverterMut, )

Writes this property’s entity reference bits into writer.

pub fn get<E: Copy + Eq + Hash + Sync + Send>( &self, converter: &dyn EntityAndGlobalEntityConverter<E>, ) -> Option<E>

Returns the world entity referenced by this property, translated via converter, or None.

pub fn get_inner(&self) -> Option<GlobalEntity>

Returns the raw GlobalEntity stored in this property, or None.

pub fn set<E: Copy + Eq + Hash + Sync + Send>( &mut self, converter: &dyn EntityAndGlobalEntityConverter<E>, entity: &E, )

Sets this property to point at entity, converting it to a GlobalEntity via converter.

pub fn set_to_none(&mut self)

Clears this property so it no longer references any entity.

pub fn mirror(&mut self, other: &EntityProperty)

Copies the referenced entity from other into self, preserving self’s relation type.

pub fn waiting_remote_entity(&self) -> Option<RemoteEntity>

Returns the RemoteEntity this property is still waiting to resolve, or None if already resolved.

pub fn write_local_entity( &self, converter: &dyn LocalEntityAndGlobalEntityConverter, writer: &mut BitWriter, )

Writes the resolved local entity value; used when splitting component updates on the receive side.

Trait Implementations

impl Clone for EntityProperty

fn clone(&self) -> EntityProperty

Returns a duplicate of the value.

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

Performs copy-assignment from source.