Struct Prototype

pub struct Prototype { /* private fields */ }

The core asset type used to create easily-configurable entity trees.

Trait Implementations

impl Config<Prototype> for ProtoConfig

fn on_register_prototype( &mut self, prototype: &Prototype, handle: Handle<Prototype>, )

Callback method that’s triggered when a prototype is registered.

fn on_reload_prototype( &mut self, prototype: &Prototype, handle: Handle<Prototype>, )

Callback method that’s triggered when a prototype is reloaded.

fn on_unregister_prototype(&mut self, id: &String, handle: Handle<Prototype>)

Callback method that’s triggered when a prototype is unregistered.

fn on_before_apply_prototype( &mut self, prototype: &Prototype, context: &mut SchematicContext<'_, '_>, )

Callback method that’s triggered before a prototype is applied to an entity.

fn on_after_apply_prototype( &mut self, prototype: &Prototype, context: &mut SchematicContext<'_, '_>, )

Callback method that’s triggered after a prototype is applied to an entity.

fn on_before_remove_prototype( &mut self, prototype: &Prototype, context: &mut SchematicContext<'_, '_>, )

Callback method that’s triggered before a prototype is removed from an entity.

fn on_after_remove_prototype( &mut self, prototype: &Prototype, context: &mut SchematicContext<'_, '_>, )

Callback method that’s triggered after a prototype is removed from an entity.

fn on_before_apply_schematic( &mut self, schematic: &DynamicSchematic, context: &mut SchematicContext<'_, '_>, )

Callback method that’s triggered before a schematic is applied to an entity.

fn on_after_apply_schematic( &mut self, schematic: &DynamicSchematic, context: &mut SchematicContext<'_, '_>, )

Callback method that’s triggered after a schematic is applied to an entity.

fn on_before_remove_schematic( &mut self, schematic: &DynamicSchematic, context: &mut SchematicContext<'_, '_>, )

Callback method that’s triggered before a schematic is removed from an entity.

fn on_after_remove_schematic( &mut self, schematic: &DynamicSchematic, context: &mut SchematicContext<'_, '_>, )

Callback method that’s triggered after a schematic is removed from an entity.

fn on_cycle(&self, cycle: &Cycle<'_, '_, Prototype>) -> CycleResponse

Controls how cycles should be handled.

impl Debug for Prototype

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Loader<Prototype> for ProtoLoader

type Error = PrototypeError

Error type returned by this loader during deserialization and loading.

fn deserialize( bytes: &[u8], ctx: &mut ProtoLoadContext<'_, '_, Prototype, Self>, ) -> Result<Prototype, Self::Error>

Deserialize the given slice of bytes into an instance of T.

fn extensions(&self) -> &[&'static str]

A list of supported extensions.

fn on_load_prototype( &self, prototype: T, meta: &ProtoLoadMeta<T>, ) -> Result<T, Self::Error>

Callback for when a prototype is loaded.

impl Prototypical for Prototype

type Id = String

The type used to identify this prototype.

type Child = ProtoChild

The type of the child this prototype uses.

fn id(&self) -> &Self::Id

The ID of this prototype.

fn path(&self) -> &ProtoPath

The path to this prototype’s asset file.

fn requires_entity(&self) -> bool

Whether or not this prototype requires an entity to be spawned.

fn schematics(&self) -> &Schematics

An immutable reference to the collection of Schematics contained in this prototype.

fn schematics_mut(&mut self) -> &mut Schematics

A mutable reference to the collection of Schematics contained in this prototype.

fn templates(&self) -> Option<&Templates>

An immutable reference to the collection of Templates inherited by this prototype, if any.

fn templates_mut(&mut self) -> Option<&mut Templates>

A mutable reference to the collection of Templates inherited by this prototype, if any.

fn dependencies(&self) -> &Dependencies

An immutable reference to the collection of Dependencies used by this prototype.

fn dependencies_mut(&mut self) -> &mut Dependencies

A mutable reference to the collection of Dependencies used by this prototype.

fn children(&self) -> Option<&Children<Self>>

An immutable reference to the collection of Children contained in this prototype, if any.

fn children_mut(&mut self) -> Option<&mut Children<Self>>

A mutable reference to the collection of Children contained in this prototype, if any.

impl PrototypicalChild<Prototype> for ProtoChild

type Key = String

The key used to identify this child as unique.

fn handle(&self) -> &Handle<Prototype>

Get this child’s handle.

fn merge_key(&self) -> Option<&Self::Key>

The optional merge key for this child.

impl TypePath for Prototype

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the moudle the type is in, or None if it is anonymous.

impl TypeUuid for Prototype

const TYPE_UUID: Uuid