Trait Prototypical

Source

pub trait Prototypical: Asset + Sized {
    type Id: Clone + Debug + Eq + Hash + Send + Sync + ToString;
    type Child: PrototypicalChild<Self>;

    // Required methods
    fn id(&self) -> &Self::Id;
    fn path(&self) -> &ProtoPath;
    fn schematics(&self) -> &Schematics;
    fn schematics_mut(&mut self) -> &mut Schematics;
    fn templates(&self) -> Option<&Templates>;
    fn templates_mut(&mut self) -> Option<&mut Templates>;
    fn dependencies(&self) -> &Dependencies;
    fn dependencies_mut(&mut self) -> &mut Dependencies;
    fn children(&self) -> Option<&Children<Self>>;
    fn children_mut(&mut self) -> Option<&mut Children<Self>>;

    // Provided method
    fn requires_entity(&self) -> bool { ... }
}

Expand description

The trait used to define a prototype.

Prototypes are containers for Schematics that can be spawned in at runtime. They may also inherit from other prototypes (where the inherited prototypes are known as Templates) and contain a hierarchy of Children.

Required Associated Types§

Source

type Id: Clone + Debug + Eq + Hash + Send + Sync + ToString

The type used to identify this prototype.

This can be used to control how a prototype is accessed. For example, if we wanted to split prototypes into “packages”, then we could require a package identifier along with the prototype name in order to access the prototype:

#[derive(Clone, Debug, PartialEq, Eq, Hash)]
struct MyProtoId {
  package: String,
  name: String,
}

impl Display for MyProtoId {
  fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
    write!(f, "{}::{}", self.package, self.name)
  }
}