Struct shipyard::EntitiesView

pub struct EntitiesView<'a> { /* private fields */ }

Shared view over Entities storage.

Methods from Deref<Target = Entities>

pub fn is_alive(&self, entity: EntityId) -> bool

Returns true if entity matches a living entity.

pub fn add_component<S: AddComponent>(
    &self,
    entity: EntityId,
    storages: S,
    component: S::Component
)

Adds component to entity, multiple components can be added at the same time using a tuple.
Entities is only borrowed immutably.

Panics

• entity is not alive.

Example

use shipyard::{Component, EntitiesView, ViewMut, World};

#[derive(Component)]
struct U32(u32);

let mut world = World::new();

let entity = world.add_entity(());

let (entities, mut u32s) = world.borrow::<(EntitiesView, ViewMut<U32>)>().unwrap();

entities.add_component(entity, &mut u32s, U32(0));

pub fn add_distinct_component<S: AddDistinctComponent>(
    &self,
    entity: EntityId,
    storages: S,
    component: S::Component
) -> bool

Adds component to entity, multiple components can be added at the same time using a tuple.
If the entity already has this component, it won’t be replaced. Very useful if you want accurate modification tracking.
Entities is only borrowed immutably.

Returns true if the component was added.

Panics

• entity is not alive.

Example

use shipyard::{Component, EntitiesView, ViewMut, World};

#[derive(Component, PartialEq)]
struct U32(u32);

let mut world = World::new();

let entity = world.add_entity(());

let (entities, mut u32s) = world.borrow::<(EntitiesView, ViewMut<U32>)>().unwrap();

assert!(entities.add_distinct_component(entity, &mut u32s, U32(0)));
assert!(!entities.add_distinct_component(entity, &mut u32s, U32(0)));

pub fn iter(&self) -> EntitiesIter<'_>

Creates an iterator over all entities.

Trait Implementations

impl<'a> BorrowInfo for EntitiesView<'a>

fn borrow_info(info: &mut Vec<TypeInfo>)

This information is used during workload creation to determine which systems can run in parallel.

impl Clone for EntitiesView<'_>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for EntitiesView<'_>

type Target = Entities

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl IntoBorrow for EntitiesView<'_>

type Borrow = EntitiesBorrower

Helper type almost allowing GAT on stable.