Struct YoleckBelongsToLevel

pub struct YoleckBelongsToLevel {
    pub level: Entity,
}

A marker for entities that belongs to the Yoleck level and should be despawned with it.

Yoleck already adds this automatically to entities created from the editor. The game itself should add this to entities created during gameplay, like bullets or spawned enemeis, so that they’ll be despawned when a playtest is finished or restarted.

When removing a YoleckKeepLevel from entity (or removing the entire entity), Yoleck will automatically despawn all the entities that have this component and point to that level.

There is no need to add this to child entities of entities that already has this marker, because Bevy will already despawn them when despawning their parent.

Fields

level: Entity

The entity which was used with YoleckLoadLevel to load the level that this entity belongs to.

Trait Implementations

impl Clone for YoleckBelongsToLevel

fn clone(&self) -> YoleckBelongsToLevel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for YoleckBelongsToLevel

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, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

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 register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its [ComponentHooks].

fn on_add() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

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

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

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

Formats the value using the given formatter.