Struct ark_api::world::Layer

pub struct Layer { /* private fields */ }

Layer component.

Use to group and identify entities. An added layer to an entity will have its mask initialized to 1 (belonging to the first layer).

Implementations

impl Layer

pub fn mask(&self) -> ValueAccessorReadWrite<u64>

Returns a ValueAccessor for the layer mask of the entity.

Used to set/get the layer mask. It is a bit mask that can be used for filtering collisions, spatial queries among other things.

pub fn set_single(&mut self, index: usize)

Utility function to set to a single layer (an entity can be a member of multiple).

pub const fn mask_from_index(index: usize) -> u64

Generates a layer mask from an index (max index is 63)

Trait Implementations

impl ComponentTrait for Layer

fn get_type() -> ComponentType

The type of the component, as a ComponentType enum.

fn from_entity(handle: Entity) -> Self

Adopt an Entity, wrap in a component struct.

fn try_from_entity(handle: Entity) -> Option<Self>

Try to adopt an Entity, wrapping it in a component struct.

fn entity(&self) -> Entity

Get the entity that the component belongs to.

impl Debug for Layer

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

Formats the value using the given formatter.