Trait amethyst::ecs::prelude::Component[−]

pub trait Component: Any {
    type Storage: UnprotectedStorage<Self> + Send + Sync + Any;
}

Abstract component type. Doesn't have to be Copy or even Clone.

Storages

Components are stored in separated collections for maximum cache efficiency. The Storage associated type allows to specify which collection should be used. Depending on how many entities have this component and how often it is accessed, you will want different storages.

The most common ones are VecStorage (use if almost every entity has that component), DenseVecStorage (if you expect many entities to have the component) and HashMapStorage (for very rare components).

Examples

use specs::prelude::*;

pub struct Position {
    pub x: f32,
    pub y: f32,
}

impl Component for Position {
    type Storage = VecStorage<Self>;
}

use specs::prelude::*;

pub enum Light {
    // (Variants would have additional data)
    Directional,
    SpotLight,
}

impl Component for Light {
    type Storage = DenseVecStorage<Self>;
}

use specs::prelude::*;
use specs::storage::HashMapStorage;

pub struct Camera {
    // In an ECS, the camera would not itself have a position;
    // you would just attach a `Position` component to the same
    // entity.
    matrix: [f32; 16],
}

impl Component for Camera {
    type Storage = HashMapStorage<Self>;
}

Associated Types

`type Storage: UnprotectedStorage<Self> + Send + Sync + Any`

Associated storage type for this component.

Implementations on Foreign Types

`impl<I, T> Component for AnimationSet<I, T> where I: Eq + Hash + Send + Sync + 'static, T: AnimationSampling,`
[src]

`type Storage = DenseVecStorage<AnimationSet<I, T>>`

`impl<T> Component for SamplerControlSet<T> where T: AnimationSampling,`
[src]

`type Storage = DenseVecStorage<SamplerControlSet<T>>`

`impl<T> Component for AnimationHierarchy<T> where T: AnimationSampling,`
[src]

`type Storage = DenseVecStorage<AnimationHierarchy<T>>`

`impl<T> Component for RestState<T> where T: AnimationSampling,`
[src]

`type Storage = DenseVecStorage<RestState<T>>`

`impl<I, T> Component for AnimationControlSet<I, T> where I: Send + Sync + 'static, T: AnimationSampling,`
[src]

`type Storage = DenseVecStorage<AnimationControlSet<I, T>>`

`impl Component for Joint`
[src]

`type Storage = DenseVecStorage<Joint>`

`impl<T> Component for AnimationControl<T> where T: AnimationSampling,`
[src]

`type Storage = DenseVecStorage<AnimationControl<T>>`

`impl Component for Skin`
[src]

`type Storage = DenseVecStorage<Skin>`

`impl<A> Component for Handle<A> where A: Asset,`
[src]

`type Storage = <A as Asset>::HandleStorage`

`impl Component for Transform`
[src]

`type Storage = FlaggedStorage<Transform, DenseVecStorage<Transform>>`

`impl Component for GlobalTransform`
[src]

`type Storage = FlaggedStorage<GlobalTransform, DenseVecStorage<GlobalTransform>>`

`impl Component for Parent`
[src]

`type Storage = FlaggedStorage<Parent, DenseVecStorage<Parent>>`

`impl Component for Light`
[src]

`type Storage = DenseVecStorage<Light>`

`impl Component for Camera`
[src]

`type Storage = HashMapStorage<Camera>`

`impl Component for Material`
[src]

`type Storage = DenseVecStorage<Material>`

`impl Component for Transparent`
[src]

`type Storage = NullStorage<Transparent>`

`impl Component for JointTransforms`
[src]

`type Storage = FlaggedStorage<JointTransforms, DenseVecStorage<JointTransforms>>`

`impl Component for AudioListener`
[src]

`type Storage = HashMapStorage<AudioListener>`

`impl Component for AudioEmitter`
[src]

`type Storage = BTreeStorage<AudioEmitter>`

`impl Component for FlyControlTag`
[src]

`type Storage = NullStorage<FlyControlTag>`

`impl Component for ArcBallControlTag`
[src]

`type Storage = HashMapStorage<ArcBallControlTag>`

`impl Component for TextEditing`
[src]

`type Storage = DenseVecStorage<TextEditing>`

`impl Component for UiTransform`
[src]

`type Storage = FlaggedStorage<UiTransform, DenseVecStorage<UiTransform>>`

`impl Component for UiResize`
[src]

`type Storage = FlaggedStorage<UiResize, DenseVecStorage<UiResize>>`

`impl Component for MouseReactive`
[src]

`type Storage = NullStorage<MouseReactive>`

`impl Component for UiText`
[src]

`type Storage = DenseVecStorage<UiText>`

`impl Component for UiImage`
[src]

`type Storage = VecStorage<UiImage>`

`impl<T> Component for Tag<T> where T: Send + Sync + 'static,`
[src]

`type Storage = NullStorage<Tag<T>>`

Implementors

impl Component for World type Storage = DenseVecStorage<World>;