Struct Disabled 

pub struct Disabled;

A marker component for disabled entities.

Semantically, this component is used to mark entities that are temporarily disabled (typically for gameplay reasons), but will likely be re-enabled at some point.

Like all disabling components, this only disables the entity itself, not its children or other entities that reference it. To disable an entire tree of entities, use EntityCommands::insert_recursive.

Every World has a default query filter that excludes entities with this component, registered in the DefaultQueryFilters resource. See the module docs for more info.

Trait Implementations

impl Clone for Disabled

fn clone(&self) -> Disabled

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for Disabled

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

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 clone_behavior() -> ComponentCloneBehavior

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

fn on_add() -> Option<ComponentHook>

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

fn on_insert() -> Option<ComponentHook>

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

fn on_replace() -> Option<ComponentHook>

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

fn on_remove() -> Option<ComponentHook>

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

fn on_despawn() -> Option<ComponentHook>

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

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

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 Debug for Disabled

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Disabled

fn default() -> Disabled

Returns the “default value” for a type.