AlphaFramework API  1.0.3
Public Member Functions | Public Attributes | Properties | List of all members
AlphaFramework.World.Templates.EntityTemplateBase< TSelf > Class Template Reference

A common base for entity templates (collection of components used as a prototype for constructing new entities). Defines the behavior and look for a certain class of EntityBase<TCoordinates,TTemplate>. More...

Inheritance diagram for AlphaFramework.World.Templates.EntityTemplateBase< TSelf >:
AlphaFramework.World.Templates.Template< TSelf > NanoByte.Common.INamed< TSelf > NanoByte::Common::Controls::IHighlightColor NanoByte::Common::ICloneable< T >

Public Member Functions

override TSelf Clone ()
 Creates a deep copy of this EntityTemplateBase<TSelf>. More...
 
- Public Member Functions inherited from AlphaFramework.World.Templates.Template< TSelf >
override string ToString ()
 

Public Attributes

Collection< RenderRender => _render
 Controls how this class of entities shall be rendered. More...
 

Properties

Movement Movement [get, set]
 Controls the basic movement parameters. More...
 
- Properties inherited from AlphaFramework.World.Templates.Template< TSelf >
string Name [get, set]
 The name of this class. Used in map files as a reference. Must be unique and is case-sensitive! More...
 
Color HighlightColor [get]
 The color to highlight this class with in list representations. Color.Empty for no highlighting. More...
 
string Description [get, set]
 A short English description of this class for developers. More...
 
static NamedCollection< TSelf > All [get]
 A list of all loaded Template<TSelf>s. More...
 
- Properties inherited from NanoByte.Common.INamed< TSelf >
string Name
 
- Properties inherited from NanoByte::Common::Controls::IHighlightColor
Color HighlightColor
 

Additional Inherited Members

- Static Public Member Functions inherited from AlphaFramework.World.Templates.Template< TSelf >
static void LoadAll ()
 Loads the list of Template<TSelf>s from FileName. More...
 
- Static Public Attributes inherited from AlphaFramework.World.Templates.Template< TSelf >
static string FileName => typeof(TSelf).Name + "s.xml"
 The XML file Template<TSelf> instances are stored in. More...
 

Detailed Description

A common base for entity templates (collection of components used as a prototype for constructing new entities). Defines the behavior and look for a certain class of EntityBase<TCoordinates,TTemplate>.

Type Constraints
TSelf :EntityTemplateBase<TSelf> 

Member Function Documentation

◆ Clone()

override TSelf AlphaFramework.World.Templates.EntityTemplateBase< TSelf >.Clone ( )
inlinevirtual

Creates a deep copy of this EntityTemplateBase<TSelf>.

Returns
The cloned EntityTemplateBase<TSelf>.

Reimplemented from AlphaFramework.World.Templates.Template< TSelf >.

Member Data Documentation

◆ Render

Controls how this class of entities shall be rendered.

Property Documentation

◆ Movement

Controls the basic movement parameters.


The documentation for this class was generated from the following file: