Struct hecs::EntityBuilder
source · [−]pub struct EntityBuilder { /* private fields */ }
Expand description
Helper for incrementally constructing a bundle of components with dynamic component types
Prefer reusing the same builder over creating new ones repeatedly.
let mut world = World::new();
let mut builder = EntityBuilder::new();
builder.add(123).add("abc");
let e = world.spawn(builder.build()); // builder can now be reused
assert_eq!(*world.get::<i32>(e).unwrap(), 123);
assert_eq!(*world.get::<&str>(e).unwrap(), "abc");
Implementations
sourceimpl EntityBuilder
impl EntityBuilder
sourcepub fn add<T: Component>(&mut self, component: T) -> &mut Self
pub fn add<T: Component>(&mut self, component: T) -> &mut Self
Add component
to the entity.
If the bundle already contains a component of type T
, it will
be dropped and replaced with the most recently added one.
sourcepub fn add_bundle(&mut self, bundle: impl DynamicBundle) -> &mut Self
pub fn add_bundle(&mut self, bundle: impl DynamicBundle) -> &mut Self
Add all components in bundle
to the entity.
If the bundle contains any component which matches the type of a component
already in the EntityBuilder
, the newly added component from the bundle
will replace the old component and the old component will be dropped.
sourcepub fn build(&mut self) -> BuiltEntity<'_>
pub fn build(&mut self) -> BuiltEntity<'_>
Construct a Bundle
suitable for spawning
sourcepub fn get_mut<T: Component>(&mut self) -> Option<&mut T>
pub fn get_mut<T: Component>(&mut self) -> Option<&mut T>
Uniquely borrow the component of type T
, if it exists
sourcepub fn component_types(&self) -> impl Iterator<Item = TypeId> + '_
pub fn component_types(&self) -> impl Iterator<Item = TypeId> + '_
Enumerate the types of the entity builder’s components
Trait Implementations
sourceimpl Default for EntityBuilder
impl Default for EntityBuilder
sourcefn default() -> EntityBuilder
fn default() -> EntityBuilder
Returns the “default value” for a type. Read more
Auto Trait Implementations
impl RefUnwindSafe for EntityBuilder
impl Send for EntityBuilder
impl Sync for EntityBuilder
impl Unpin for EntityBuilder
impl UnwindSafe for EntityBuilder
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more