bevy_ecs_ldtk 0.14.0

An ECS-friendly ldtk plugin for bevy.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

use crate::{assets::LevelIndices, ldtk::Level, LevelIid};
use bevy::prelude::*;

/// [`Resource`] for choosing which level(s) to spawn.
///
/// For more explanation and comparison of options for selecting levels to spawn, see the
/// [*Level Selection*](https://trouv.github.io/bevy_ecs_ldtk/v0.14.0/explanation/level-selection.html) <!-- x-release-please-version -->
/// chapter of the `bevy_ecs_ldtk` book.
///
/// [`Resource`]: https://docs.rs/bevy/latest/bevy/ecs/prelude/trait.Resource.html
#[derive(Clone, Eq, PartialEq, Debug, Resource)]
pub enum LevelSelection {
    /// Spawn level with the given identifier.
    Identifier(String),
    /// Spawn level from its indices in the LDtk file's worlds/levels.
    Indices(LevelIndices),
    /// Spawn level with the given level `iid`.
    Iid(LevelIid),
    /// Spawn level with the given level `uid`.
    Uid(i32),
}

impl Default for LevelSelection {
    fn default() -> Self {
        LevelSelection::index(0)
    }
}

impl LevelSelection {
    /// 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");
    /// # assert_eq!(
    /// #     level_selection,
    /// #     LevelSelection::Iid(LevelIid::new("333081f6-7ac1-4fe3-bdcc-fa3704073bbe"))
    /// # );
    /// ```
    pub fn iid(iid: impl Into<String>) -> Self {
        LevelSelection::Iid(LevelIid::new(iid))
    }

    /// 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 index(level_index: usize) -> Self {
        LevelSelection::Indices(LevelIndices::in_root(level_index))
    }

    /// 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 indices(world_index: usize, level_index: usize) -> Self {
        LevelSelection::Indices(LevelIndices::in_world(world_index, level_index))
    }

    /// Returns true if the given level matches this [`LevelSelection`].
    ///
    /// Since levels don't inherently store their index, it needs to be provided separately.
    pub fn is_match(&self, indices: &LevelIndices, level: &Level) -> bool {
        match self {
            LevelSelection::Identifier(s) => *s == level.identifier,
            LevelSelection::Indices(i) => *i == *indices,
            LevelSelection::Iid(i) => *i.get() == level.iid,
            LevelSelection::Uid(u) => *u == level.uid,
        }
    }
}