pub struct World<S = SoaStorage> { /* private fields */ }
Expand description
Implementations§
source§impl<S> World<S>where
S: Storage,
impl<S> World<S>where
S: Storage,
sourcepub fn matcher<'s, Q>(
&'s self
) -> impl Iterator<Item = <<Q as Query<'s>>::Iter as Iterator>::Item> + 'swhere
Q: Query<'s> + Matcher,
Q::Borrow: RegisterBorrow,
pub fn matcher<'s, Q>(
&'s self
) -> impl Iterator<Item = <<Q as Query<'s>>::Iter as Iterator>::Item> + 'swhere
Q: Query<'s> + Matcher,
Q::Borrow: RegisterBorrow,
sourcepub fn matcher_with_entities<'s, Q>(
&'s self
) -> impl Iterator<Item = (Entity, <<Q as Query<'s>>::Iter as Iterator>::Item)> + 'swhere
Q: Query<'s> + Matcher,
Q::Borrow: RegisterBorrow,
pub fn matcher_with_entities<'s, Q>(
&'s self
) -> impl Iterator<Item = (Entity, <<Q as Query<'s>>::Iter as Iterator>::Item)> + 'swhere
Q: Query<'s> + Matcher,
Q::Borrow: RegisterBorrow,
Same as World::matcher
but also returns the corresponding Entity
.
ⓘ
fn update(world: &mut World) {
world
.matcher_with_entities::<All<(Write<Position>, Read<Velocity>)>>()
.for_each(|(entity, (p, v))| {
p.x += v.dx;
p.y += v.dy;
});
}
source§impl<S> World<S>where
S: Storage + RegisterComponent,
impl<S> World<S>where
S: Storage + RegisterComponent,
sourcepub fn append_components<A, I>(&mut self, i: I)where
A: AppendComponents + BuildStorage,
I: IntoIterator<Item = A>,
pub fn append_components<A, I>(&mut self, i: I)where
A: AppendComponents + BuildStorage,
I: IntoIterator<Item = A>,
Appends the components and also creates the necessary Entity
s behind the scenes.
If you only want to append a single set of components then you can do
ⓘ
world.append_components(Some((a, b, c)));
sourcepub fn is_entity_valid(&self, entity: Entity) -> bool
pub fn is_entity_valid(&self, entity: Entity) -> bool
Compares the version of the entity with the version in World
and returns true if they
match. Because version
wraps around this is not a hard guarantee.
sourcepub fn has_component<C: Component>(&self, e: Entity) -> bool
pub fn has_component<C: Component>(&self, e: Entity) -> bool
Returns true if the entity owns the requested component.
sourcepub fn get_component<C: Component>(&self, e: Entity) -> Option<&C>
pub fn get_component<C: Component>(&self, e: Entity) -> Option<&C>
Retrieves a component for a specific Entity
.
sourcepub fn get_component_mut<C: Component>(&mut self, e: Entity) -> Option<&mut C>
pub fn get_component_mut<C: Component>(&mut self, e: Entity) -> Option<&mut C>
Same as World::get_component
but mutable.
sourcepub fn remove_entities<I>(&mut self, entities: I)where
I: IntoIterator<Item = Entity>,
pub fn remove_entities<I>(&mut self, entities: I)where
I: IntoIterator<Item = Entity>,
Removes the specified entities from World
. Those entities are now considered invalid,
which can be checked with World::is_entity_valid
.
Trait Implementations§
Auto Trait Implementations§
impl<S = SoaStorage> !RefUnwindSafe for World<S>
impl<S> Send for World<S>where
S: Send,
impl<S> Sync for World<S>where
S: Sync,
impl<S> Unpin for World<S>where
S: Unpin,
impl<S> UnwindSafe for World<S>where
S: UnwindSafe,
Blanket Implementations§
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read moresource§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read moresource§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read moresource§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more