Struct valence::entity::Entities

pub struct Entities<C: Config> { /* private fields */ }

A container for all Entitys on a server.

Spawning Player Entities

Player entities are treated specially by the client. For the player entity to be visible to clients, the player’s UUID must be added to the PlayerList before being loaded by the client.

Implementations

impl<C: Config> Entities<C>

pub fn insert(
    &mut self,
    kind: EntityKind,
    state: C::EntityState
) -> (EntityId, &mut Entity<C>)

Spawns a new entity with a random UUID. A reference to the entity along with its ID is returned.

pub fn insert_with_uuid(
    &mut self,
    kind: EntityKind,
    uuid: Uuid,
    data: C::EntityState
) -> Option<(EntityId, &mut Entity<C>)>

Like Self::insert, but requires specifying the new entity’s UUID.

The provided UUID must not conflict with an existing entity UUID. If it does, None is returned and the entity is not spawned.

pub fn remove(&mut self, entity: EntityId) -> Option<C::EntityState>

Removes an entity from the server.

If the given entity ID is valid, the entity’s EntityState is returned and the entity is deleted. Otherwise, None is returned and the function has no effect.

pub fn retain(&mut self, f: impl FnMut(EntityId, &mut Entity<C>) -> bool)

Removes all entities from the server for which f returns true.

All entities are visited in an unspecified order.

pub fn len(&self) -> usize

Returns the number of entities in this container.

pub fn is_empty(&self) -> bool

Returns true if there are no entities.

pub fn get_with_uuid(&self, uuid: Uuid) -> Option<EntityId>

Gets the EntityId of the entity with the given UUID in an efficient manner.

If there is no entity with the UUID, None is returned.

pub fn get(&self, entity: EntityId) -> Option<&Entity<C>>

Gets a shared reference to the entity with the given EntityId.

If the ID is invalid, None is returned.

pub fn get_mut(&mut self, entity: EntityId) -> Option<&mut Entity<C>>

Gets an exclusive reference to the entity with the given EntityId.

If the ID is invalid, None is returned.

pub fn iter(
    &self
) -> impl ExactSizeIterator<Item = (EntityId, &Entity<C>)> + FusedIterator + Clone + '_

Returns an iterator over all entities on the server in an unspecified order.

pub fn iter_mut(
    &mut self
) -> impl ExactSizeIterator<Item = (EntityId, &mut Entity<C>)> + FusedIterator + '_

Returns a mutable iterator over all entities on the server in an unspecified order.

pub fn par_iter(
    &self
) -> impl ParallelIterator<Item = (EntityId, &Entity<C>)> + Clone + '_

Returns a parallel iterator over all entities on the server in an unspecified order.

pub fn par_iter_mut(
    &mut self
) -> impl ParallelIterator<Item = (EntityId, &mut Entity<C>)> + '_

Returns a parallel mutable iterator over all clients on the server in an unspecified order.