Struct Level

pub struct Level;

A Level indicates a single visible subset of a map, most commonly used to represent distinct parts of the same logical project.

An example would be a ‘project’ that represents a full roadside tavern which might have a ground floor, a basement and an upper floor for lodging. Each physical floor would be represented under a Level so that all floors are grouped in the same savefile (project) “Roadside Tavern” but the levels are separated so that the user can edit/export each physical floor separately.

Implementations

impl Level

pub fn new(name: impl Into<Cow<'static, str>>) -> impl Bundle

Generates a new [Bundle] with a level to indicate the start of a hierarchy under which a map will be set.

Examples

Here’s how to spawn a simple Level for the ground floor.

    commands.spawn((
        Project::new("Roadside Inn"),
        children![
            Level::new("Ground Floor")
        ]
    ));

Trait Implementations

impl Component for Level

where Self: Send + Sync + 'static,

Required Components: [Transform], [Visibility].

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Immutable

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 Default for Level

fn default() -> Level

Returns the “default value” for a type.