Trait shipyard::AddComponent

pub trait AddComponent {
    type Component;
    fn add_component_unchecked(
        &mut self, 
        entity: EntityId, 
        component: Self::Component
    );
}

Defines how components are added to an existing entity.

Associated Types

type Component

Loading content...

Required methods

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

Adds component to entity, multiple components can be added at the same time using a tuple.
This function does not check entity is alive. It’s possible to add components to removed entities.
Use Entities::add_component if you’re unsure.

Example

use shipyard::{World, EntitiesViewMut, ViewMut, AddComponent};

let world = World::new();

let (mut entities, mut u32s) = world.borrow::<(EntitiesViewMut, ViewMut<u32>)>().unwrap();
let entity = entities.add_entity((), ());

u32s.add_component_unchecked(entity, 0);

Loading content...

Implementations on Foreign Types

impl AddComponent for ()

type Component = ()

fn add_component_unchecked(&mut self, _: EntityId, _: Self::Component)

impl<ViewA: AddComponent> AddComponent for (ViewA,)

type Component = (ViewA::Component,)

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

impl<ViewA: AddComponent, ViewB: AddComponent> AddComponent for (ViewA, ViewB)

type Component = (ViewA::Component, ViewB::Component)

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

impl<ViewA: AddComponent, ViewB: AddComponent, ViewC: AddComponent> AddComponent for (ViewA, ViewB, ViewC)

type Component = (ViewA::Component, ViewB::Component, ViewC::Component)

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

impl<ViewA: AddComponent, ViewB: AddComponent, ViewC: AddComponent, ViewD: AddComponent> AddComponent for (ViewA, ViewB, ViewC, ViewD)

type Component = (ViewA::Component, ViewB::Component, ViewC::Component, ViewD::Component)

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

impl<ViewA: AddComponent, ViewB: AddComponent, ViewC: AddComponent, ViewD: AddComponent, ViewE: AddComponent> AddComponent for (ViewA, ViewB, ViewC, ViewD, ViewE)

type Component = (ViewA::Component, ViewB::Component, ViewC::Component, ViewD::Component, ViewE::Component)

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

impl<ViewA: AddComponent, ViewB: AddComponent, ViewC: AddComponent, ViewD: AddComponent, ViewE: AddComponent, ViewF: AddComponent> AddComponent for (ViewA, ViewB, ViewC, ViewD, ViewE, ViewF)

type Component = (ViewA::Component, ViewB::Component, ViewC::Component, ViewD::Component, ViewE::Component, ViewF::Component)

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

impl<ViewA: AddComponent, ViewB: AddComponent, ViewC: AddComponent, ViewD: AddComponent, ViewE: AddComponent, ViewF: AddComponent, ViewG: AddComponent> AddComponent for (ViewA, ViewB, ViewC, ViewD, ViewE, ViewF, ViewG)

type Component = (ViewA::Component, ViewB::Component, ViewC::Component, ViewD::Component, ViewE::Component, ViewF::Component, ViewG::Component)

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

impl<ViewA: AddComponent, ViewB: AddComponent, ViewC: AddComponent, ViewD: AddComponent, ViewE: AddComponent, ViewF: AddComponent, ViewG: AddComponent, ViewH: AddComponent> AddComponent for (ViewA, ViewB, ViewC, ViewD, ViewE, ViewF, ViewG, ViewH)

type Component = (ViewA::Component, ViewB::Component, ViewC::Component, ViewD::Component, ViewE::Component, ViewF::Component, ViewG::Component, ViewH::Component)

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

impl<ViewA: AddComponent, ViewB: AddComponent, ViewC: AddComponent, ViewD: AddComponent, ViewE: AddComponent, ViewF: AddComponent, ViewG: AddComponent, ViewH: AddComponent, ViewI: AddComponent> AddComponent for (ViewA, ViewB, ViewC, ViewD, ViewE, ViewF, ViewG, ViewH, ViewI)

type Component = (ViewA::Component, ViewB::Component, ViewC::Component, ViewD::Component, ViewE::Component, ViewF::Component, ViewG::Component, ViewH::Component, ViewI::Component)

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

impl<ViewA: AddComponent, ViewB: AddComponent, ViewC: AddComponent, ViewD: AddComponent, ViewE: AddComponent, ViewF: AddComponent, ViewG: AddComponent, ViewH: AddComponent, ViewI: AddComponent, ViewJ: AddComponent> AddComponent for (ViewA, ViewB, ViewC, ViewD, ViewE, ViewF, ViewG, ViewH, ViewI, ViewJ)

type Component = (ViewA::Component, ViewB::Component, ViewC::Component, ViewD::Component, ViewE::Component, ViewF::Component, ViewG::Component, ViewH::Component, ViewI::Component, ViewJ::Component)

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

Loading content...

Implementors

impl<T: 'static> AddComponent for &mut ViewMut<'_, T>

type Component = T

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

impl<T: 'static> AddComponent for ViewMut<'_, T>

type Component = T

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

Loading content...