rantz_proto 1.2.4

An opinionated rust library for transforming on-disk assets into Entities in 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

use bevy::prelude::EntityWorldMut;
use std::fmt::Debug;

use crate::id::Id;

/// A trait for building prototypes
pub trait Prototype: Clone + Send + Sync + Debug + 'static {
    /// The name of the prototype, must be unique within as
    /// this is used to identify the prototype in the `PrototypeLibrary`
    fn name(&self) -> String;

    /// Default id of the prototype uses the name with `Id::from_name`
    fn id(&self) -> Id<Self> {
        Id::from_name(&self.name())
    }

    /// Builds the prototype on a target entity
    fn build(&self, target: &mut EntityWorldMut);

    /// Rebuilds the prototype on a target entity if `hot_reload` is enabled
    /// by default this does nothing
    #[cfg(feature = "hot_reload")]
    fn rebuild(&self, _: &mut EntityWorldMut);
}