Struct components::engine::d2::Entity

pub struct Entity {
    pub id: EntityID,
    pub parent: Option<EntityID>,
    pub first_child: Option<EntityID>,
    pub next: Option<EntityID>,
    pub first_component: Option<Component>,
    pub z_order: i32,
    pub order_of_arrival: i32,
    pub global_order_of_arrival: i32,
}

A node in the entity hierarchy, and a collection of components.

To iterate over the hierarchy, use the parent, first_child, next and first_component fields. For example:

Fields

id: EntityID

parent: Option<EntityID>

This entity’s parent

first_child: Option<EntityID>

This entity’s first child

next: Option<EntityID>

This entity’s next sibling, for iteration

first_component: Option<Component>

This entity’s first component

z_order: i32

order_of_arrival: i32

global_order_of_arrival: i32

Implementations

impl Entity

pub fn new() -> Entity

pub fn add(&self, component: Component) -> &Entity

Add a component to this entity. Any previous component of this type will be replaced. @returns This instance, for chaining.

pub fn remove(&self, component: &Component) -> bool

Remove a component from this entity. @return Whether the component was removed.

pub fn add_child(
    &self,
    entity: Entity,
    append: bool,
    z_order: Option<i32>
) -> &Entity

Gets a component by name from this entity. Adds a child to this entity. @param append Whether to add the entity to the end or beginning of the child list. @returns This instance, for chaining.

pub fn set_zorder(&mut self, z: i32)

pub fn remove_child(&self, entity: &Entity)

pub fn dispose_children(&self)

Dispose all of this entity’s children, without touching its own components or removing itself from its parent.

Trait Implementations

impl AsRef<MoviePlayer> for Entity

fn as_ref(&self) -> &MoviePlayer

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> AsRef<Option<&'a Sprite>> for Entity

fn as_ref(&self) -> &Option<&'a Sprite>

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Sprite> for Entity

fn as_ref(&self) -> &Sprite

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Entity

fn clone(&self) -> Entity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl Default for Entity

fn default() -> Entity

Returns the “default value” for a type.

impl Display for Entity

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

Formats the value using the given formatter.

impl Disposable for Entity

fn dispose(&self)

Removes this entity from its parent, and disposes all its components and children.

impl EntityManager<Component> for Entity

fn get(&self) -> Option<Component>

impl EntityManager<EmitterSprite> for Entity

fn get(&self) -> Option<EmitterSprite>

impl EntityManager<FillSprite> for Entity

fn get(&self) -> Option<FillSprite>

impl EntityManager<Flipbook> for Entity

fn get(&self) -> Option<Flipbook>

impl EntityManager<ImageSprite> for Entity

fn get(&self) -> Option<ImageSprite>

impl EntityManager<MoviePlayer> for Entity

fn get(&self) -> Option<MoviePlayer>

impl EntityManager<MovieSprite> for Entity

fn get(&self) -> Option<MovieSprite>

impl EntityManager<PatternSprite> for Entity

fn get(&self) -> Option<PatternSprite>

impl EntityManager<Scene2D> for Entity

fn get(&self) -> Option<Scene2D>

impl EntityManager<SpeedAdjuster> for Entity

fn get(&self) -> Option<SpeedAdjuster>

impl EntityManager<Sprite> for Entity

fn get(&self) -> Option<Sprite>

impl EntityManager<TextSprite> for Entity

fn get(&self) -> Option<TextSprite>

impl PartialEq<Entity> for Entity

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Entity> for Entity

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Entity