bevy_tiles 0.1.0

Bevy library for working with entities in grids.
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

//! A general purpose grided entity library meant to support tilemap libraries,
//! or other libraries that require accessing entities in a grid based manner.
//!
//! The goal is to keep the API surface as simple and intuitive as possible,
//! and to avoid deferred operations/states where possible to make the structures more intuitive work with.
//!  (ex: an update in one system should be seen by the following system, not the following frame.)

#![deny(missing_docs)]

use bevy::app::Plugin;

/// Provides chunk level utilities.
pub mod chunks;
/// Provides commands for interacting with tilemaps.
pub mod commands;
/// Provides helper functions for interacting with coordiantes.
pub mod coords;
/// Provides map level utilities.
pub mod maps;
/// Provides tile level utilities.
pub mod tiles;

/// Helper aliases for working with 2d grids
pub mod tiles_2d {
    use bevy::ecs::system::Commands;

    /// 2d [crate::tiles::TileCoord] alias.
    pub type TileCoord = crate::tiles::TileCoord<2>;

    /// 2d [crate::tiles::TileMapQuery] alias.
    pub type TileMapQuery<'w, 's, Q, F = ()> = crate::tiles::TileMapQuery<'w, 's, Q, F, 2>;

    /// 2d [crate::chunks::ChunkCoord] alias.
    pub type ChunkCoord = crate::chunks::ChunkCoord<2>;

    /// 2d [crate::chunks::ChunkMapQuery] alias.
    pub type ChunkMapQuery<'w, 's, Q, F = ()> = crate::chunks::ChunkMapQuery<'w, 's, Q, F, 2>;

    /// 2d [crate::commands::TileMapCommands] alias.
    pub type TileMapCommands<'a, 'w, 's, const N: usize> =
        crate::commands::TileMapCommands<'a, 'w, 's, 2>;

    /// 2d [crate::commands::TileCommandExt] alias.
    pub trait TileCommandExt<'w, 's>: crate::commands::TileCommandExt<'w, 's, 2> {}

    impl<'w, 's> TileCommandExt<'w, 's> for Commands<'w, 's> {}
}

/// Helper aliases for working with 2d grids
pub mod tiles_3d {
    use bevy::ecs::system::Commands;

    /// 3d [crate::tiles::TileCoord] alias.
    pub type TileCoord = crate::tiles::TileCoord<3>;

    /// 3d [crate::tiles::TileMapQuery] alias.
    pub type TileMapQuery<'w, 's, Q, F = ()> = crate::tiles::TileMapQuery<'w, 's, Q, F, 3>;

    /// 3d [crate::chunks::ChunkCoord] alias.
    pub type ChunkCoord = crate::chunks::ChunkCoord<3>;

    /// 3d [crate::chunks::ChunkMapQuery] alias.
    pub type ChunkMapQuery<'w, 's, Q, F = ()> = crate::chunks::ChunkMapQuery<'w, 's, Q, F, 3>;

    /// 3d [crate::commands::TileMapCommands] alias.
    pub type TileMapCommands<'a, 'w, 's, const N: usize> =
        crate::commands::TileMapCommands<'a, 'w, 's, 3>;

    /// 3d [crate::commands::TileCommandExt] alias.
    pub trait TileCommandExt<'w, 's>: crate::commands::TileCommandExt<'w, 's, 3> {}

    impl<'w, 's> TileCommandExt<'w, 's> for Commands<'w, 's> {}
}

/// Adds Tiles dependencies to the App.
pub struct TilesPlugin;

impl Plugin for TilesPlugin {
    fn build(&self, _app: &mut bevy::prelude::App) {}
}