Actor

Struct Actor 

Source
pub struct Actor(/* private fields */);

Implementations§

Source§

impl Actor

Source

pub fn spawn( world: &mut World, bundle: impl Bundle + Send + Sync + 'static, ) -> Result<Self, WorldError>

Source

pub fn despawn(self, world: &mut World) -> Result<(), WorldError>

Source

pub fn insert( self, world: &mut World, bundle: impl Bundle + Send + Sync + 'static, ) -> Result<(), WorldError>

Source

pub fn remove<T: BundleColumns>( self, world: &mut World, ) -> Result<(), WorldError>

Source

pub fn remove_raw( self, world: &mut World, columns: Vec<ArchetypeColumnInfo>, ) -> Result<(), WorldError>

Source

pub fn exists(self, world: &World) -> bool

Source

pub fn entity(self) -> Entity

Source

pub fn component<const LOCKING: bool, T: Component>( self, world: &World, ) -> Result<ComponentRef<'_, LOCKING, T>, WorldError>

Source

pub fn component_mut<const LOCKING: bool, T: Component>( self, world: &World, ) -> Result<ComponentRefMut<'_, LOCKING, T>, WorldError>

Source

pub fn add_child<const LOCKING: bool>( self, world: &mut World, other: Self, ) -> Result<(), WorldError>

Source

pub fn remove_child<const LOCKING: bool>( self, world: &mut World, other: Self, ) -> Result<(), WorldError>

Source

pub fn children<const LOCKING: bool>( self, world: &World, ) -> impl Iterator<Item = Self> + '_

Source

pub fn parents<const LOCKING: bool>( self, world: &World, ) -> impl Iterator<Item = Self> + '_

Source

pub fn register_message_listener<const LOCKING: bool>( self, world: &World, id: impl ToString, function: ActorMessageFunction, ) -> Result<(), WorldError>

Source

pub fn unregister_message_listener<const LOCKING: bool>( self, world: &World, id: &str, ) -> Result<(), WorldError>

Source

pub fn message_listener<const LOCKING: bool>( self, world: &World, id: &str, ) -> Result<Option<FunctionHandle>, WorldError>

Source

pub fn invoke_message<const LOCKING: bool>( self, world: &World, id: &str, context: &mut Context, registry: &Registry, ) -> Result<(), WorldError>

Source

pub fn dispatch_message<const LOCKING: bool, O: DataStackPack, I: DataStackPack>( self, world: &World, id: &str, context: &mut Context, registry: &Registry, inputs: I, ) -> Result<Option<O>, WorldError>

Source

pub fn dispatch_message_hierarchy<const LOCKING: bool, I: DataStackPack + Clone>( self, world: &World, id: &str, context: &mut Context, registry: &Registry, inputs: I, ) -> Result<(), WorldError>

Trait Implementations§

Source§

impl Clone for Actor

Source§

fn clone(&self) -> Actor

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 Debug for Actor

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Actor

Source§

fn default() -> Actor

Returns the “default value” for a type. Read more
Source§

impl Hash for Actor

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Actor

Source§

fn cmp(&self, other: &Actor) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Actor

Source§

fn eq(&self, other: &Actor) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Actor

Source§

fn partial_cmp(&self, other: &Actor) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Copy for Actor

Source§

impl Eq for Actor

Source§

impl StructuralPartialEq for Actor

Auto Trait Implementations§

§

impl Freeze for Actor

§

impl RefUnwindSafe for Actor

§

impl Send for Actor

§

impl Sync for Actor

§

impl Unpin for Actor

§

impl UnwindSafe for Actor

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<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> Finalize for T

Source§

unsafe fn finalize_raw(data: *mut ())

Safety Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Initialize for T
where T: Default,

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> 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<T> Component for T
where T: Send + Sync + 'static,

Source§

impl<N> NodeTrait for N
where N: Copy + Ord + Hash,

Source§

impl<T> RuleType for T
where T: Copy + Debug + Eq + Hash + Ord,