Struct ComponentTags 

pub struct ComponentTags<T: Component>(/* private fields */);

👎Deprecated since 0.3.0: use AddFrom from moonshine-util instead

A Component which merges a set of tags into single Tags component.

Usage

This is similar to WithTags, except that it may be used as a component requirement.

Note that T can be anything. By convention, it is best to use Self to avoid requirement conflicts.

Examples

use bevy::prelude::*;
use moonshine_tag::prelude::*;
use moonshine_util::prelude::*;

tags! { A, B, C };

#[derive(Component)]
#[require(MergeFrom<Self, Tags> = Tags::from(A))]
struct Foo;

#[derive(Component)]
#[require(MergeFrom<Self, Tags> = Tags::from([B, C]))]
struct Bar;

let mut world = World::new();
let entity = world.spawn((Foo, Bar));
assert_eq!(entity.get::<Tags>().unwrap(), [A, B, C]);

Trait Implementations

impl<T: Component> Component for ComponentTags<T>

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn on_add() -> Option<ComponentHook>

Gets the on_add ComponentHook for this Component if one is defined.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl<T: Component, I: Into<Tags>> From<I> for ComponentTags<T>

fn from(tags: I) -> Self

Converts to this type from the input type.