Property

Struct Property 

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

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

Implementations§

Source§

impl<T: Serde> Property<T>

Source

pub fn new_local(value: T) -> Self

Create a new Local Property

Source

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

Create a new host-owned Property

Source

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

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

Source

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

Set an PropertyMutator to track changes to the Property

Source

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

Writes contained value into outgoing byte stream

Source

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

Source

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

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

Source

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

Compare to another property

Source

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

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

Source

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

Migrate Remote Property to Public version

Source

pub fn remote_unpublish(&mut self)

Migrate Remote Property to Private version

Source

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

Migrate Property to Delegated version

Source

pub fn disable_delegation(&mut self)

Migrate Delegated Property to Host-Owned (Public) version

Source

pub fn localize(&mut self)

Migrate Host Property to Local version

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

type Target = T

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

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

Source§

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

Mutably dereferences the value.

Auto Trait Implementations§

§

impl<T> Freeze for Property<T>
where T: Freeze,

§

impl<T> !RefUnwindSafe for Property<T>

§

impl<T> Send for Property<T>
where T: Send,

§

impl<T> Sync for Property<T>
where T: Sync,

§

impl<T> Unpin for Property<T>
where T: Unpin,

§

impl<T> !UnwindSafe for Property<T>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> ErasedDestructor for T
where T: 'static,