emerald 0.3.214

A lite, fully featured 2D game engine.
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
use hecs::Entity;
use rapier2d::na::Vector2;
use serde::{Deserialize, Serialize};

use crate::{
    texture::TextureKey,
    tilemap::{get_tilemap_index, TileId, Tilemap, TilesetResource},
    AssetLoader, Emerald, EmeraldError, World,
};

#[derive(Deserialize, Serialize)]
struct AutoTileRulesetsResource {
    #[serde(default)]
    pub rulesets: Vec<AutoTileRulesetSchema>,
}

pub fn load_autotile_rulesets_from_resource<T: Into<String>>(
    loader: &mut AssetLoader,
    resource_path: T,
) -> Result<Vec<AutoTileRuleset>, EmeraldError> {
    let data = loader.string(resource_path.into())?;
    let resource = crate::toml::from_str::<AutoTileRulesetsResource>(&data)?;
    let rulesets = resource
        .rulesets
        .into_iter()
        .map(|schema| schema.to_ruleset())
        .collect::<Result<Vec<AutoTileRuleset>, EmeraldError>>()?;

    Ok(rulesets)
}

#[derive(Clone, Copy, Debug, PartialEq, Hash, Deserialize, Serialize)]
pub enum AutoTileRulesetValue {
    Any,
    None,
    Tile,
}

const AUTOTILE_RULESET_GRID_SIZE: usize = 5;

#[derive(Deserialize, Serialize)]
struct AutoTileRulesetSchema {
    /// x position of the tile in the tileset this ruleset belongs to
    pub x: usize,
    /// y position of the tile in the tileset this ruleset belongs to
    pub y: usize,

    /// List of tile rules in the ruleset, tiles not given in the 5x5 grid are assumed to be Any
    #[serde(default)]
    pub rules: Vec<AutoTileRulesetSchemaTile>,
}
impl AutoTileRulesetSchema {
    fn to_ruleset(self) -> Result<AutoTileRuleset, EmeraldError> {
        let mut grid = default_ruleset_grid();
        let max_offset = (AUTOTILE_RULESET_GRID_SIZE / 2) as i8;

        for tile in self.rules {
            if tile.x < -max_offset
                || tile.x > max_offset
                || tile.y < -max_offset
                || tile.y > max_offset
            {
                return Err(EmeraldError::new(format!(
                    "Tile {:?} does not fit inside of the 5x5 ruleset grid.",
                    tile
                )));
            }

            let position = Vector2::new(
                (AUTOTILE_RULESET_GRID_SIZE / 2) as i8 + tile.x,
                (AUTOTILE_RULESET_GRID_SIZE / 2) as i8 + tile.y,
            );
            grid[position.x as usize][position.y as usize] = tile.value;
        }

        // We require the center of the grid to be the target tile.
        grid[2][2] = AutoTileRulesetValue::Tile;

        Ok(AutoTileRuleset {
            x: self.x,
            y: self.y,
            grid,
        })
    }
}

#[derive(Deserialize, Serialize, Debug)]
struct AutoTileRulesetSchemaTile {
    /// relative x position to the center tile of the rule grid
    pub x: i8,
    /// relative y position to the center tile of the rule grid
    pub y: i8,

    /// ex. Any, None, Tile
    pub value: AutoTileRulesetValue,
}

fn default_ruleset_grid(
) -> [[AutoTileRulesetValue; AUTOTILE_RULESET_GRID_SIZE]; AUTOTILE_RULESET_GRID_SIZE] {
    let default_row = [
        AutoTileRulesetValue::Any,
        AutoTileRulesetValue::Any,
        AutoTileRulesetValue::Any,
        AutoTileRulesetValue::Any,
        AutoTileRulesetValue::Any,
    ];
    [
        default_row,
        default_row,
        default_row,
        default_row,
        default_row,
    ]
}

#[derive(Deserialize, Serialize)]
pub struct AutoTileRuleset {
    /// X position of the autotile in the tileset
    pub x: usize,
    /// Y position of the autotile in the tileset
    pub y: usize,

    /// A grid determining the ruleset that displays this tile.
    /// Most grids will only need to cover a 3x3 area around the center tile,
    /// however we offer a 5x5 to cover larger rulesets. If you don't care to use all
    /// all of the 5x5 grid, place the outer rings with AutoTile::Any.
    ///
    /// These grids are rotated 90* clockwise visually.
    /// Ex 1.
    /// [
    ///     [Any, Any, Any, Any, Any]
    ///     [Any, None, None, None, Any]
    ///     [Any, None, Tile, None, Any]
    ///     [Any, None, None, None, Any]
    ///     [Any, Any, Any, Any, Any]
    /// ]
    /// The above grid displays the tile when it is completely alone, and not surrounded by any tiles.
    /// The value in the center of the ruleset grid is ignored, as this space is reserved for the AutoTile.
    ///
    /// Ex 2.
    /// [
    ///     [Any, Any, Any, Any, Any]
    ///     [Any, None, Any, None, Any]
    ///     [Any, None, Tile, None, Any]
    ///     [Any, None, Tile, None, Any]
    ///     [Any, Any, Any, Any, Any]
    /// ]
    /// This example will display the given tile, when there is a tile right of the center and
    /// does not care about the tile left of center.
    pub grid: [[AutoTileRulesetValue; AUTOTILE_RULESET_GRID_SIZE]; AUTOTILE_RULESET_GRID_SIZE],
}
impl AutoTileRuleset {
    /// Tests a 5x5 area centering on the given x, y values and determines if it's a match.
    pub(crate) fn matches(
        &self,
        autotiles: &Vec<AutoTile>,
        autotilemap_width: usize,
        autotilemap_height: usize,
        x: usize,
        y: usize,
    ) -> bool {
        match get_tilemap_index(x, y, autotilemap_width, autotilemap_height) {
            Err(_) => {
                return false;
            }
            Ok(index) => {
                if autotiles[index] != AutoTile::Tile {
                    return false;
                }
            }
        }

        for ruleset_x in 0..AUTOTILE_RULESET_GRID_SIZE {
            for ruleset_y in 0..AUTOTILE_RULESET_GRID_SIZE {
                // If center tile or any, skip
                if (ruleset_x == (AUTOTILE_RULESET_GRID_SIZE / 2)
                    && ruleset_y == (AUTOTILE_RULESET_GRID_SIZE / 2))
                    || self.grid[ruleset_x][ruleset_y] == AutoTileRulesetValue::Any
                {
                    continue;
                }

                let autotile_ruleset_value = self.get_autotile_ruleset_value(
                    autotiles,
                    autotilemap_width,
                    autotilemap_height,
                    x as isize - (AUTOTILE_RULESET_GRID_SIZE / 2) as isize + ruleset_x as isize,
                    y as isize - (AUTOTILE_RULESET_GRID_SIZE / 2) as isize + ruleset_y as isize,
                );

                if self.grid[ruleset_x][ruleset_y] != autotile_ruleset_value {
                    return false;
                }
            }
        }

        true
    }

    fn get_autotile_ruleset_value(
        &self,
        autotiles: &Vec<AutoTile>,
        autotilemap_width: usize,
        autotilemap_height: usize,
        x: isize,
        y: isize,
    ) -> AutoTileRulesetValue {
        // Treat tiles outside the boundaries of the map as Any.
        if x < 0 || y < 0 {
            return AutoTileRulesetValue::Any;
        }

        match get_tilemap_index(
            x as usize,
            y as usize,
            autotilemap_width,
            autotilemap_height,
        ) {
            Ok(index) => match autotiles[index] {
                AutoTile::None => AutoTileRulesetValue::None,
                AutoTile::Tile => AutoTileRulesetValue::Tile,
            },
            // Out of bounds, so we assume any
            Err(_) => AutoTileRulesetValue::Any,
        }
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Hash)]
pub enum AutoTile {
    None = 0,
    Tile = 1,
}

fn default_visibility() -> bool {
    true
}

#[derive(Deserialize, Serialize)]
struct AutoTileSchema {
    x: usize,
    y: usize,
}

#[derive(Deserialize, Serialize)]
struct AutoTileMapSchema {
    #[serde(default)]
    pub tileset: Option<TilesetResource>,
    /// Path to the rulesets resource.
    /// Appends onto any defined rulesets in this autotilemap.
    #[serde(default)]
    pub tileset_resource: Option<String>,

    /// Path to the rulesets resource.
    /// Appends onto any defined rulesets in this autotilemap.
    #[serde(default)]
    pub rulesets_resource: Option<String>,

    #[serde(default)]
    pub rulesets: Vec<AutoTileRulesetSchema>,

    pub width: usize,
    pub height: usize,

    #[serde(default)]
    pub tiles: Vec<AutoTileSchema>,

    #[serde(default)]
    pub z_index: f32,

    #[serde(default = "default_visibility")]
    pub visible: bool,
}
impl AutoTileMapSchema {
    pub fn to_autotilemap(self, loader: &mut AssetLoader) -> Result<AutoTilemap, EmeraldError> {
        let mut ruleset_schemas = Vec::new();

        if let Some(resource) = &self.rulesets_resource {
            let toml = loader.string(resource.clone())?;
            let resource = crate::toml::from_str::<AutoTileRulesetsResource>(&toml)?;
            ruleset_schemas = resource.rulesets;
        }

        let tileset_resource = if let Some(resource) = self.tileset {
            resource
        } else {
            let data = loader.string(&self.tileset_resource.unwrap())?;
            crate::toml::from_str::<TilesetResource>(&data)?
        };

        ruleset_schemas.extend(self.rulesets);
        let rulesets = ruleset_schemas
            .into_iter()
            .map(|ruleset_schema| ruleset_schema.to_ruleset())
            .collect::<Result<Vec<AutoTileRuleset>, EmeraldError>>()?;
        let texture = loader.texture(tileset_resource.texture)?;
        let tile_size = Vector2::new(
            texture.size().0 as usize / tileset_resource.width,
            texture.size().1 as usize / tileset_resource.height,
        );
        let mut autotilemap = AutoTilemap::new(
            texture,
            tile_size,
            tileset_resource.width,
            tileset_resource.height,
            self.width,
            self.height,
            rulesets,
        );

        for tile in self.tiles {
            autotilemap.set_tile(tile.x, tile.y)?;
        }

        autotilemap.set_z_index(self.z_index);
        autotilemap.set_visible(self.visible);

        Ok(autotilemap)
    }
}

pub struct AutoTilemap {
    pub(crate) tilemap: Tilemap,
    rulesets: Vec<AutoTileRuleset>,
    autotiles: Vec<AutoTile>,
}
impl AutoTilemap {
    pub fn new(
        tilesheet: TextureKey,
        // Size of a tile in the grid, in pixels
        tile_size: Vector2<usize>,
        // Width of tilesheet in tiles
        tilesheet_width: usize,
        // Height of tilesheet in tiles
        tilesheet_height: usize,
        map_width: usize,
        map_height: usize,
        rulesets: Vec<AutoTileRuleset>,
    ) -> Self {
        let tilemap = Tilemap::new(
            tilesheet,
            tile_size,
            tilesheet_width,
            tilesheet_height,
            map_width,
            map_height,
        );

        let tile_count = map_width * map_height;
        let mut autotiles = Vec::with_capacity(tile_count);
        for _ in 0..tile_count {
            autotiles.push(AutoTile::None);
        }

        Self {
            tilemap,
            rulesets,
            autotiles,
        }
    }

    /// Bakes the inner tileset in accordance to the Autotilemap
    /// TODO: feature(physics): Additionally bakes the colliders
    pub fn bake(&mut self) -> Result<(), EmeraldError> {
        for x in 0..self.width() {
            for y in 0..self.height() {
                let id = self.compute_tileset_tile_id(x, y)?;
                self.tilemap.set_tile(x, y, id)?;
            }
        }

        Ok(())
    }

    pub fn set_z_index(&mut self, z_index: f32) {
        self.tilemap.z_index = z_index;
    }

    pub fn set_visible(&mut self, visible: bool) {
        self.tilemap.visible = visible;
    }

    pub fn width(&self) -> usize {
        self.tilemap.width
    }

    pub fn height(&self) -> usize {
        self.tilemap.height
    }

    pub fn tilesheet(&self) -> TextureKey {
        self.tilemap.tilesheet.clone()
    }

    pub fn tile_size(&self) -> Vector2<usize> {
        self.tilemap.tile_size.clone()
    }

    pub fn add_ruleset(&mut self, ruleset: AutoTileRuleset) {
        self.rulesets.push(ruleset);
    }

    pub fn get_autotile(&mut self, x: usize, y: usize) -> Result<AutoTile, EmeraldError> {
        let index = get_tilemap_index(x, y, self.width(), self.height())?;
        Ok(self.autotiles[index])
    }

    pub fn set_tile(&mut self, x: usize, y: usize) -> Result<(), EmeraldError> {
        self.set_autotile(x, y, AutoTile::Tile)
    }

    pub fn set_none(&mut self, x: usize, y: usize) -> Result<(), EmeraldError> {
        self.set_autotile(x, y, AutoTile::None)
    }

    pub fn set_autotile(
        &mut self,
        x: usize,
        y: usize,
        new_tile_id: AutoTile,
    ) -> Result<(), EmeraldError> {
        let index = get_tilemap_index(x, y, self.width(), self.height())?;
        self.autotiles[index] = new_tile_id;

        Ok(())
    }

    pub fn tiles(&self) -> &Vec<Option<TileId>> {
        &self.tilemap.tiles
    }

    pub fn get_ruleset(&self, tile_id: TileId) -> Option<&AutoTileRuleset> {
        let width = self.width();
        let height = self.height();

        self.rulesets.iter().find(|ruleset| {
            if let Ok(id) = get_tilemap_index(ruleset.x, ruleset.y, width, height) {
                id == tile_id
            } else {
                false
            }
        })
    }

    pub fn remove_ruleset(&mut self, tile_id: TileId) -> Option<AutoTileRuleset> {
        let width = self.width();
        let height = self.height();

        if let Some(index) = self.rulesets.iter().position(|ruleset| {
            if let Ok(id) = get_tilemap_index(ruleset.x, ruleset.y, width, height) {
                id == tile_id
            } else {
                false
            }
        }) {
            return Some(self.rulesets.remove(index));
        }

        None
    }

    /// Computes the tileid for the given autotile position.
    pub fn compute_tileset_tile_id(
        &self,
        x: usize,
        y: usize,
    ) -> Result<Option<TileId>, EmeraldError> {
        let width = self.width();
        let height = self.height();

        if let Some(ruleset) = self
            .rulesets
            .iter()
            .find(|ruleset| ruleset.matches(&self.autotiles, width, height, x, y))
        {
            let id = get_tilemap_index(
                ruleset.x,
                ruleset.y,
                self.tilemap.tilesheet_width,
                self.tilemap.tilesheet_height,
            )?;
            return Ok(Some(id));
        }

        Ok(None)
    }
    pub fn get_tile_id(&self, x: usize, y: usize) -> Result<Option<TileId>, EmeraldError> {
        self.tilemap.get_tile(x, y)
    }
}

pub(crate) fn load_ent_autotilemap<'a>(
    loader: &mut AssetLoader<'a>,
    entity: Entity,
    world: &mut World,
    toml: &toml::Value,
) -> Result<(), EmeraldError> {
    let schema: AutoTileMapSchema = toml::from_str(&toml.to_string())?;
    let mut autotilemap = schema.to_autotilemap(loader)?;
    autotilemap.bake()?;
    world.insert_one(entity, autotilemap)?;

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::{AutoTileMapSchema, AutoTileRulesetSchema, AutoTileRulesetValue};

    #[test]
    fn deser_ruleset() {
        let ruleset_toml = r#"
            x = 10
            y = 11

            [[rules]]
            x = -1
            y = -1
            value = "None"

            [[rules]]
            x = -1
            y = 0
            value = "None"

            [[rules]]
            x = 1
            y = 1
            value = "Tile"
        "#;
        let schema: AutoTileRulesetSchema = crate::toml::from_str(ruleset_toml).unwrap();
        let ruleset = schema.to_ruleset().unwrap();
        assert_eq!(ruleset.x, 10);
        assert_eq!(ruleset.y, 11);
        assert_eq!(ruleset.grid[1][1], AutoTileRulesetValue::None);
        assert_eq!(ruleset.grid[1][2], AutoTileRulesetValue::None);
        assert_eq!(ruleset.grid[3][3], AutoTileRulesetValue::Tile);

        // Check target tile is a tile
        assert_eq!(ruleset.grid[2][2], AutoTileRulesetValue::Tile);

        let out_of_bounds_ruleset = r#"
            x = 10
            y = 11

            [[rules]]
            x = -3
            y = 0
            value = "None"
        "#;
        let schema: AutoTileRulesetSchema = crate::toml::from_str(out_of_bounds_ruleset).unwrap();
        assert!(schema.to_ruleset().is_err());
    }

    #[test]
    fn deser_autotilemap() {
        let autotilemap_toml = r#"
            width = 10
            height = 11
            [tileset]
            texture = "test"
            width = 1
            height = 2
        "#;
        let schema: AutoTileMapSchema = crate::toml::from_str(&autotilemap_toml).unwrap();
        assert_eq!(schema.width, 10);
        assert_eq!(schema.height, 11);
        assert_eq!(&schema.tileset.as_ref().unwrap().texture, "test");
        assert_eq!(schema.tileset.as_ref().unwrap().width, 1);
        assert_eq!(schema.tileset.as_ref().unwrap().height, 2);

        let missing_map_size = r#"
            tile_width = 32
            tile_height = 32
        "#;
        let schema = crate::toml::from_str::<AutoTileMapSchema>(&missing_map_size);
        assert!(schema.is_err());
    }
}