Enum LevelSelection

pub enum LevelSelection {
    Identifier(String),
    Indices(LevelIndices),
    Iid(LevelIid),
    Uid(i32),
}

Resource for choosing which level(s) to spawn.

For more explanation and comparison of options for selecting levels to spawn, see the Level Selection chapter of the bevy_ecs_ldtk book.

Variants

Identifier(String)

Spawn level with the given identifier.

Indices(LevelIndices)

Spawn level from its indices in the LDtk file’s worlds/levels.

Iid(LevelIid)

Spawn level with the given level iid.

Uid(i32)

Spawn level with the given level uid.

Implementations

impl LevelSelection

pub fn iid(iid: impl Into<String>) -> Self

Construct a LevelSelection::Iid using the given iid.

This iid only needs to implement Into<String>.

Example

use bevy_ecs_ldtk::prelude::*;

let level_selection = LevelSelection::iid("333081f6-7ac1-4fe3-bdcc-fa3704073bbe");

pub fn index(level_index: usize) -> Self

Construct a LevelSelection::Indices using the given level index.

This will point to the level with the given index in the project root. If you have a multi-worlds project, you should use LevelSelection::indices instead.

Example

use bevy_ecs_ldtk::prelude::*;

let level_selection = LevelSelection::index(3);

assert_eq!(level_selection, LevelSelection::Indices(LevelIndices::in_root(3)));

pub fn indices(world_index: usize, level_index: usize) -> Self

Construct a LevelSelection::Indices using the given world and level indices.

This will point to the level with the given world+level indices in the project worlds. If your project isn’t multi-worlds, you should use LevelSelection::index instead.

Example

use bevy_ecs_ldtk::prelude::*;

let level_selection = LevelSelection::indices(1, 2);

assert_eq!(level_selection, LevelSelection::Indices(LevelIndices::in_world(1, 2)));

pub fn is_match(&self, indices: &LevelIndices, level: &Level) -> bool

Returns true if the given level matches this LevelSelection.

Since levels don’t inherently store their index, it needs to be provided separately.

Trait Implementations

impl Clone for LevelSelection

fn clone(&self) -> LevelSelection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LevelSelection

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

Formats the value using the given formatter.

impl Default for LevelSelection

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for LevelSelection

fn eq(&self, other: &LevelSelection) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for LevelSelection

impl Resource for LevelSelection

where Self: Send + Sync + 'static,

impl StructuralPartialEq for LevelSelection