nuuro 0.1.5

A specialized 2D game library
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

// Copyright 2020-2020 Juan Villacorta
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Traits related to asset enums that are generated by "nuuro_build".
//!
//! The user is not expected to implement these traits themselves directly.
//! Rather, the generated code from "nuuro_build" will implement these traits.
//! Nuuro build will generate four enums: `SpriteId`, `MusicId`, and `SoundId`,
//! that implement `IdU16`.
//! It will also generate a collection type `AssetId` that implements `AppAssetId`.

/// A value that can be converted to a `u16` ID, implemented by asset enums.
pub trait IdU16: Sized {
    /// Converts self to a `u16` ID.
    ///
    /// This will be value between `0` (inclusive) and `Self::count()` (exclusive).
    fn id_u16(self) -> u16;

    /// Returns the number of IDs in this enum.
    fn count() -> u16;

    /// Converts a `u16` ID to the asset enum value, or `None` if `id >= Self::count()`
    fn from_u16(id: u16) -> Option<Self>;
}

/// A convenience collection of all asset ID types.
pub trait AppAssetId {
    /// Sprite asset enum
    type Sprite: IdU16;
    /// Music asset enum
    type Music: IdU16;
    /// Sound asset enum
    type Sound: IdU16;
}

/// Simple that allow return a tile from a tiled sprite.
///
/// First parameter is the name of the `asset_id` generated module, the parameter is
/// the sprite name, and the third and last parameter are the X and Y coords of the tile on the
/// sprite.
#[macro_export]
macro_rules! tiled_sprite_id {
    ($enum: expr, $sprite_name:expr, $x:expr, $y:expr) => {
        $crate::paste::expr! {
            $enum::[<$sprite_name R $x C $y>]
        }
    };
}