Struct bevy_ecs::storage::Table

pub struct Table { /* fields omitted */ }

Implementations

impl Table

pub const fn new(grow_amount: usize) -> Table

pub fn with_capacity(
    capacity: usize,
    column_capacity: usize,
    grow_amount: usize
) -> Table

pub fn entities(&self) -> &[Entity]

pub fn add_archetype(&mut self, archetype_id: ArchetypeId)

pub fn add_column(&mut self, component_info: &ComponentInfo)

pub unsafe fn swap_remove_unchecked(&mut self, row: usize) -> Option<Entity>

Removes the entity at the given row and returns the entity swapped in to replace it (if an entity was swapped in)

Safety

row must be in-bounds

pub unsafe fn move_to_and_forget_missing_unchecked(
    &mut self,
    row: usize,
    new_table: &mut Table
) -> TableMoveResult

Moves the row column values to new_table, for the columns shared between both tables. Returns the index of the new row in new_table and the entity in this table swapped in to replace it (if an entity was swapped in). missing columns will be “forgotten”. It is the caller’s responsibility to drop them

Safety

Row must be in-bounds

pub unsafe fn move_to_and_drop_missing_unchecked(
    &mut self,
    row: usize,
    new_table: &mut Table
) -> TableMoveResult

Moves the row column values to new_table, for the columns shared between both tables. Returns the index of the new row in new_table and the entity in this table swapped in to replace it (if an entity was swapped in).

Safety

row must be in-bounds

pub unsafe fn move_to_superset_unchecked(
    &mut self,
    row: usize,
    new_table: &mut Table
) -> TableMoveResult

Moves the row column values to new_table, for the columns shared between both tables. Returns the index of the new row in new_table and the entity in this table swapped in to replace it (if an entity was swapped in).

Safety

row must be in-bounds. new_table must contain every component this table has

pub fn get_column(&self, component_id: ComponentId) -> Option<&Column>

pub fn get_column_mut(
    &mut self,
    component_id: ComponentId
) -> Option<&mut Column>

pub fn has_column(&self, component_id: ComponentId) -> bool

pub fn reserve(&mut self, amount: usize)

pub unsafe fn allocate(&mut self, entity: Entity) -> usize

Allocates space for a new entity

Safety

the allocated row must be written to immediately with valid values in each column

pub fn capacity(&self) -> usize

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn iter(&self) -> impl Iterator<Item = &Column>