Struct naia_shared::Property

pub struct Property<T: Serde> { /* private fields */ }

A Property of an Component/Message, that contains data which must be tracked for updates

Implementations

impl<T: Serde> Property<T>

pub fn new_local(value: T) -> Self

Create a new Local Property

pub fn host_owned(value: T, mutator_index: u8) -> Self

Create a new host-owned Property

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

Given a cursor into incoming packet data, initializes the Property with the synced value

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

Set an PropertyMutator to track changes to the Property

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

Writes contained value into outgoing byte stream

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

Reads from a stream and immediately writes to a stream Used to buffer updates for later

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

Given a cursor into incoming packet data, updates the Property with the synced value

pub fn equals(&self, other: &Self) -> bool

Compare to another property

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

Set value to the value of another Property, queues for update if value changes

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 Private version

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

Migrate 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

Trait Implementations

impl<T: Clone + Serde> Clone for Property<T>

fn clone(&self) -> Property<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Serde> Deref for Property<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Serde> DerefMut for Property<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.