bevy_ecs_tiled 0.11.2

A Bevy plugin for loading Tiled maps
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! Core Tiled integration for `bevy_ecs_tiled`.
//!
//! This module contains the main logic for loading, processing, and managing Tiled maps and worlds within Bevy.
//! It organizes submodules for assets, components, systems, events and utilities related to Tiled support.

pub mod animation;
pub mod event;
pub mod filter;
pub mod helpers;
pub mod image;
pub mod layer;
pub mod map;
pub mod object;
pub mod sets;
pub mod tile;
pub mod world;

pub(crate) mod cache;
pub(crate) mod reader;

#[cfg(feature = "user_properties")]
pub mod properties;

use crate::prelude::*;
use bevy::prelude::*;
use std::{env, path::PathBuf};

/// [`TiledPlugin`] global configuration.
///
/// Example:
/// ```rust,no_run
/// use std::env;
/// use bevy::prelude::*;
/// use bevy_ecs_tiled::prelude::*;
///
/// let mut path = env::current_dir().unwrap_or_default();
/// path.push("my_tiled_export_file.json");
///
/// App::new()
///     .add_plugins(TiledPlugin(TiledPluginConfig {
///         tiled_types_export_file: Some(path),
///         tiled_types_filter: TiledFilter::All,
///     }));
/// ```
#[derive(Resource, Reflect, Clone, Debug)]
#[reflect(Resource, Debug)]
pub struct TiledPluginConfig {
    /// Path to the Tiled types export file.
    ///
    /// If [`None`], will not export Tiled types at startup.
    pub tiled_types_export_file: Option<PathBuf>,
    /// Tiled types filter
    ///
    /// Only types matching this filter will be exported at startup.
    pub tiled_types_filter: TiledFilter,
}

impl Default for TiledPluginConfig {
    fn default() -> Self {
        let mut path = env::current_dir().unwrap_or_default();
        path.push("tiled_types_export.json");
        Self {
            tiled_types_export_file: Some(path),
            tiled_types_filter: TiledFilter::All,
        }
    }
}

/// `bevy_ecs_tiled` main [`Plugin`].
///
/// This [`Plugin`] should be added to your application to actually be able to load a Tiled map.
///
/// Example:
/// ```rust,no_run
/// use bevy::prelude::*;
/// use bevy_ecs_tiled::prelude::*;
///
/// App::new()
///     .add_plugins(TiledPlugin::default());
/// ```
#[derive(Default, Clone, Debug)]
pub struct TiledPlugin(pub TiledPluginConfig);

impl Plugin for TiledPlugin {
    fn build(&self, mut app: &mut App) {
        if !app.is_plugin_added::<bevy_ecs_tilemap::TilemapPlugin>() {
            app = app.add_plugins(bevy_ecs_tilemap::TilemapPlugin);
        }

        app.insert_resource(self.0.clone());
        app.insert_resource(cache::TiledResourceCache::new());
        app.register_type::<TiledPluginConfig>();

        app.add_plugins((
            map::plugin,
            world::plugin,
            animation::plugin,
            cache::plugin,
            event::plugin,
            image::plugin,
            layer::plugin,
            object::plugin,
            tile::plugin,
            sets::plugin,
            filter::plugin,
            #[cfg(feature = "user_properties")]
            properties::plugin,
        ));
    }
}