Struct ark_api::world::EntityOwned

pub struct EntityOwned { /* private fields */ }

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.

This type will own its entity and destroy it when drop is called (i.e. when it goes out of scope).

Implementations

impl EntityOwned

pub fn is_valid(&self) -> bool

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

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

Creates an empty world entity with just a name.

Add components of your preference to it.

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.

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.

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.

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.

pub fn add_component(&self, component_type: ComponentType)

Adds a component to an entity.

pub fn add<T: ComponentTrait>(&self) -> T

Adds a component to an entity.

pub fn copy_component(&self, src: Entity, component_type: ComponentType)

Copies a component from the entity in src.

pub fn copy<T: ComponentTrait>(&self, src: Entity) -> T

Copies a component from the entity in src.

pub fn has<T: ComponentTrait>(&self) -> bool

Returns whether the entity has the component or not.

pub fn get<T: ComponentTrait>(&self) -> Option<T>

Gets an interface to the component.

Returns an option, none if the component doesn’t exist.

pub fn has_component(&self, component_type: ComponentType) -> bool

Returns whether the entity has the component or not.

pub fn remove_component(&self, component_type: ComponentType)

Removes a component from an entity.

pub fn remove<T: ComponentTrait>(&self)

Removes a component from an entity.

pub fn mesh_style(&self) -> MeshStyle

Accessor for the MeshStyle component, if it exists.

pub fn transform(&self) -> Transform

Accessor for the Transform component, if it exists.

pub fn physics(&self) -> Physics

Accessor for the Physics component, if it exists.

pub fn render(&self) -> Render

Accessor for the Render component, if it exists.

pub fn d6_joint(&self) -> D6Joint

Accessor for the D6Joint component, if it exists.

pub fn camera(&self) -> Camera

Accessor for the Camera component, if it exists.

pub fn bounds(&self) -> Bounds

Accessor for the Bounds component, if it exists.

pub fn tag(&self) -> Tag

Accessor for the Tag component, if it exists.

pub fn layer(&self) -> Layer

Accessor for the Layer component, if it exists.

pub fn sdf_model(&self) -> SdfModel

Accessor for the Sdf component, if it exists.

pub fn audio_source(&self) -> AudioSource

Accessor for the AudioSource component, if it exists.

pub fn as_ffi(&self) -> EntityHandle

Gets the raw entity id.

pub fn as_entity(&self) -> Entity

Gets the inner Entity

pub fn name(&self) -> String

Retrieves the name of the entity

Trait Implementations

impl AsRef<Entity> for EntityOwned

fn as_ref(&self) -> &Entity

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

impl Debug for EntityOwned

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

Formats the value using the given formatter.

impl Drop for EntityOwned

fn drop(&mut self)

Executes the destructor for this type.

impl From<&EntityOwned> for Entity

fn from(item: &EntityOwned) -> Self

Converts to this type from the input type.

impl Hash for EntityOwned

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<EntityOwned> for EntityOwned

fn eq(&self, other: &EntityOwned) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for EntityOwned

impl StructuralEq for EntityOwned

impl StructuralPartialEq for EntityOwned