Struct YoleckLoadLevel

pub struct YoleckLoadLevel(pub Handle<YoleckRawLevel>);

Command Yoleck to load a level.

fn level_loading_system(
    asset_server: Res<AssetServer>,
    mut commands: Commands,
) {
    commands.spawn(YoleckLoadLevel(asset_server.load("levels/level1.yol")));
}

After the level is loaded, YoleckLoadLevel will be removed and YoleckKeepLevel will be added instead. To unload the level, either remove YoleckKeepLevel or despawn the entire level entity.

Immediately after the level is loaded, but before the populate systems get to run, Yoleck will run the YoleckSchedule::LevelLoaded schedule, allowing the game to register systems there and interfere with the level entities while they are still just freshly deserialized YoleckComponent data. During that time, the entities of the levels that were just loaded will be marked with YoleckLevelJustLoaded, allowing to these systems to distinguish them from already existing levels.

Note that the entities inside the level will not be children of the level entity. Games that want to load multiple levels and dynamically position them should use VpeolRepositionLevel.

Tuple Fields

0: Handle<YoleckRawLevel>

Trait Implementations

impl Component for YoleckLoadLevel

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]