Struct hecs::EntityBuilderClone

pub struct EntityBuilderClone { /* private fields */ }

Variant of EntityBuilder that clones components on use

let mut world = World::new();
let mut builder = EntityBuilderClone::new();
builder.add(123).add("abc");
let bundle = builder.build();
let e = world.spawn(&bundle);
let f = world.spawn(&bundle); // `&bundle` can be used many times
assert_eq!(*world.get::<&i32>(e).unwrap(), 123);
assert_eq!(*world.get::<&&str>(e).unwrap(), "abc");
assert_eq!(*world.get::<&i32>(f).unwrap(), 123);
assert_eq!(*world.get::<&&str>(f).unwrap(), "abc");

Implementations

impl EntityBuilderClone

pub fn new() -> Self

Create a builder representing an entity with no components

pub fn add<T: Component + Clone>(&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.

pub fn add_bundle(&mut self, bundle: impl DynamicBundleClone) -> &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.

pub fn build(self) -> BuiltEntityClone

Convert into a value whose shared references are DynamicBundles suitable for repeated spawning

pub fn has<T: Component>(&self) -> bool

Checks to see if the component of type T exists

pub fn get<'a, T: ComponentRefShared<'a>>(&'a self) -> Option<T>

Borrow a shared reference T to some component type, if it exists

Takes a reference as its type parameter for consistency with EntityRef::get, even though it cannot be a unique reference because EntityBuilderClone does not perform dynamic borrow checking.

pub fn get_mut<'a, T: ComponentRef<'a>>(&'a mut self) -> Option<T>

Borrow a shared or unique reference T to some component type, if it exists

pub fn component_types(&self) -> impl Iterator<Item = TypeId> + '_

Enumerate the types of the entity builder’s components

pub fn clear(&mut self)

Drop previously added components

The builder is cleared implicitly when an entity is built, so this doesn’t usually need to be called.

Trait Implementations

impl Clone for EntityBuilderClone

fn clone(&self) -> EntityBuilderClone

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for EntityBuilderClone

fn default() -> EntityBuilderClone

Returns the “default value” for a type.

impl From<BuiltEntityClone> for EntityBuilderClone

fn from(x: BuiltEntityClone) -> Self

Converts to this type from the input type.

impl From<EntityBuilderClone> for BuiltEntityClone

fn from(x: EntityBuilderClone) -> Self

Converts to this type from the input type.