Struct RegionMap

pub struct RegionMap {
    regions: IndexMap<Vec2<i32>, Region, DefaultHashBuilder>,
    tracked_entities: BitSet,
    entity_to_region: Vec<Vec2<i32>>,
    entities_to_move: Vec<(usize, u32, Vec3<i32>)>,
    entities_to_remove: Vec<(usize, u32)>,
    tick: u64,
}

A region system that tracks where entities are.

Note, this structure is primarily intended for tracking which entities need to be synchronized to which clients (and as part of that what entities are already synchronized). If an entity is marked to not be synchronized to other clients it may not appear here.

Fields

regions: IndexMap<Vec2<i32>, Region, DefaultHashBuilder>

tracked_entities: BitSet

If an entity isn’t here it needs to be added to a region.

entity_to_region: Vec<Vec2<i32>>

If an entity is in tracked_entities this will contain the key of the region containing that entity.

Indexed by entity ID.

Ideally, this would be the index of the region but then we would need to update this whenever removing regions

entities_to_move: Vec<(usize, u32, Vec3<i32>)>

entities_to_remove: Vec<(usize, u32)>

tick: u64

Implementations

impl RegionMap

pub fn new() -> Self

pub fn tick( &mut self, pos: ReadStorage<'_, Pos>, vel: ReadStorage<'_, Vel>, presence: ReadStorage<'_, Presence>, entities: Entities<'_>, )

pub fn entity_deleted(&mut self, entity: Entity) -> Option<Vec2<i32>>

Must be called immediately after succesfully deleting an entity from the ecs (i.e. when deleting the entity did not generate a WrongGeneration error).

Returns the region key if this entity was tracked in a region.

fn add_entity(&mut self, id: u32, pos: Vec3<i32>, from: Option<Vec2<i32>>)

Returns index of the region that the entity is added to.

fn pos_key<P: Into<Vec2<i32>>>(pos: P) -> Vec2<i32>

pub fn key_pos(key: Vec2<i32>) -> Vec2<i32>

pub fn in_region_map(&self, entity: Entity) -> bool

Checks if this entity is located in the RegionMap.

pub fn get(&self, key: Vec2<i32>) -> Option<&Region>

Returns a region given a key.

pub fn iter(&self) -> impl Iterator<Item = (Vec2<i32>, &Region)>

Returns an iterator of (Position, Region).

Trait Implementations

impl Default for RegionMap

fn default() -> RegionMap

Returns the “default value” for a type.