Struct ark_api::world::Entity

source · [−]

#[repr(transparent)]
pub struct Entity(pub EntityHandle);

Expand description

An Entity is a single “thing” in the gameworld.

It can have multiple components attached, giving it a position in the world, a mesh to display, physical properties, and so forth.

The Entity struct has accessors to access its components, like transform, mesh_style, physics and so on.

Represents a raw non-owned reference to an entity, an EntityHandle with functionality. Use EntityOwned if you want the entity to get destroyed if it goes out of scope.

Tuple Fields

0: EntityHandle

Implementations

source

pub fn is_valid_handle(self) -> bool

Check if handle is valid

NOTE: This does not check whether there’s actually an entity represented by this entity handle. For that, use World::is_valid_entity.

source

pub fn invalid() -> Self

Returns an eternally invalid entity handle.

source

pub fn try_from_ffi(h: EntityHandle) -> Option<Self>

source

pub fn try_to_ffi(self) -> Option<EntityHandle>

source

impl Entity

Non-owning reference to an entity

source

pub fn create_empty(name: &str) -> Self

Creates an empty world entity with just a name.

Add components of your preference to it.

source

pub fn create(name: &str) -> Self

Creates a world entity with Transform, Render, Physics, and MeshStyle components.

name - only used for display in the inspector and similar, it cannot later be changed or queried to affect the game so don’t store data in it.

source

pub fn create_non_physics(name: &str) -> Self

Creates a world entity with Transform, Render and MeshStyle components.

name - only used for display in the inspector and similar, it cannot later be changed or queried to affect the game so don’t store data in it.

source

pub fn create_camera(name: &str) -> Self

Creates a world entity with a Camera and Transform component.

An entity with a Camera component is special in that the rotation of its transform component will be controlled directly by the client. See the documentation of Camera for more details.

source

pub fn from_entity_owned(entity: &EntityOwned) -> Self

Creates a reference to an entity from an owned entity. This one won’t be owning the entity.

source

pub fn try_into_entity_owned(self) -> Option<EntityOwned>

If the entity exists in the global arena, you can use this to get ownership of this entity

source

pub fn is_valid(self) -> bool

Lets you check whether this entity still exists and is valid.

source

pub fn clone_entity(self, name: &str) -> Self

Clones this world entity and all its components.

name - only used for display in the inspector and similar, it cannot later be changed or queried to affect the game so don’t store data in it. Will be concatenated to the name of the source of the clone.

Will always be cloned and placed in the global EntityArena.

source

pub fn try_destroy(self)

Destroys the entity if it is in a global arena.

Further access to the entity (like by keeping the id around) after this is an error.

source

pub fn schedule_for_destruction(self)

Schedules the entity for destruction if it is in a global arena. A call to EntityArena::global().destroy_pending_entities() will execute the order. Should usually be executed at the beginning of the update function to destroy entities after an update step.

Further access to the entity (like by keeping the id around) after EntityArena::global().destroy_pending_entities() has been executed is an error.

source