Struct goggles::world::World

pub struct World { /* fields omitted */ }

Implementations

impl World

pub fn new() -> Self

pub fn entities(&self) -> Entities<'_>

pub fn create_entity(&mut self) -> Entity

pub fn delete_entity(&mut self, e: Entity) -> Result<(), WrongGeneration>

pub fn insert_resource<R>(&mut self, r: R) -> Option<R> where
    R: Send + 'static, 

pub fn remove_resource<R>(&mut self) -> Option<R> where
    R: Send + 'static, 

pub fn contains_resource<T>(&self) -> bool where
    T: Send + 'static, 

pub fn read_resource<R>(&self) -> ReadResource<'_, R> where
    R: Send + Sync + 'static, 

Borrow the given resource immutably.

Panics

Panics if the resource has not been inserted or is already borrowed mutably.

pub fn write_resource<R>(&self) -> WriteResource<'_, R> where
    R: Send + 'static, 

Borrow the given resource mutably.

Panics

Panics if the resource has not been inserted or is already borrowed.

pub fn get_resource_mut<R>(&mut self) -> &mut R where
    R: Send + 'static, 

Panics

Panics if the resource has not been inserted.

pub fn insert_component<C>(&mut self) -> Option<ComponentStorage<C>> where
    C: Component + 'static,
    C::Storage: Default + Send, 

Insert a new, fresh storage for the given component.

If the component was already inserted, this will clear the storage for the component first.

pub fn remove_component<C>(&mut self) -> Option<ComponentStorage<C>> where
    C: Component + 'static,
    C::Storage: Default + Send, 

Remove storage for the given component.

pub fn contains_component<C>(&self) -> bool where
    C: Component + 'static,
    C::Storage: Send, 

pub fn read_component<C>(&self) -> ReadComponent<'_, C> where
    C: Component + 'static,
    C::Storage: Send + Sync, 

Borrow the given component immutably.

Panics

Panics if the component has not been inserted or is already borrowed mutably.

pub fn write_component<C>(&self) -> WriteComponent<'_, C> where
    C: Component + 'static,
    C::Storage: Send, 

Borrow the given component mutably.

Panics

Panics if the component has not been inserted or is already borrowed.

pub fn get_component_mut<C>(
    &mut self
) -> ComponentAccess<'_, C, &mut ComponentStorage<C>> where
    C: Component + 'static,
    C::Storage: Send, 

Panics

Panics if the component has not been inserted.

pub fn fetch<'a, F>(&'a self) -> F where
    F: FetchResources<'a, Source = World, Resources = RwResources<WorldResourceId>>, 

pub fn merge(&mut self)

Merge any pending atomic entity operations.

Merges atomically allocated entities into the normal entity BitSet for performance, and finalizes any entities that were requested to be deleted.

No entity is actually removed until this method is called.

Trait Implementations

impl Default for World

fn default() -> World

Returns the "default value" for a type.