AlphaFramework API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Protected Member Functions | Properties | Events | List of all members
AlphaFramework.World.Positionables.Positionable< TCoordinates > Class Template Reference

An object that can be positioned in the game world. More...

Inheritance diagram for AlphaFramework.World.Positionables.Positionable< TCoordinates >:
AlphaFramework.World.Positionables.CameraState< TCoordinates > AlphaFramework.World.Positionables.EntityBase< TCoordinates, TTemplate > AlphaFramework.World.Positionables.Water AlphaFramework.World.Positionables.BenchmarkPoint< TCoordinates >

Public Member Functions

override string ToString ()
 
virtual Positionable
< TCoordinates > 
Clone ()
 Creates a deep copy of this Positionable{TCoordinates}. More...
 

Protected Member Functions

virtual void OnChanged ()
 To be called when a property relevant for rendering has changed. More...
 
void OnChangedRebuild ()
 To be called when a property has changed that requires visual representations to rebuilt from scratch (usually a template). More...
 

Properties

string Name [get, set]
 Used for identification in scripts, debugging, etc. More...
 
TCoordinates Position [get, set]
 The Positionable{TCoordinates}'s position. More...
 

Events

Action< Positionable
< TCoordinates > > 
Changed
 Occurs when a property relevant for rendering has changed. More...
 
Action< Positionable
< TCoordinates > > 
ChangedRebuild
 Occurs when a property has changed that requires visual representations to rebuilt from scratch (usually a template). More...
 

Detailed Description

An object that can be positioned in the game world.

Template Parameters
TCoordinatesData type for storing position coordinates of objects in the game world.
Type Constraints
TCoordinates :struct 

Member Function Documentation

virtual Positionable<TCoordinates> AlphaFramework.World.Positionables.Positionable< TCoordinates >.Clone ( )
inlinevirtual

Creates a deep copy of this Positionable{TCoordinates}.

Returns
The cloned Positionable{TCoordinates}.

Reimplemented in AlphaFramework.World.Positionables.EntityBase< TCoordinates, TTemplate >.

virtual void AlphaFramework.World.Positionables.Positionable< TCoordinates >.OnChanged ( )
inlineprotectedvirtual

To be called when a property relevant for rendering has changed.

void AlphaFramework.World.Positionables.Positionable< TCoordinates >.OnChangedRebuild ( )
inlineprotected

To be called when a property has changed that requires visual representations to rebuilt from scratch (usually a template).

Property Documentation

string AlphaFramework.World.Positionables.Positionable< TCoordinates >.Name
getset

Used for identification in scripts, debugging, etc.

TCoordinates AlphaFramework.World.Positionables.Positionable< TCoordinates >.Position
getset

The Positionable{TCoordinates}'s position.

Event Documentation

Action<Positionable<TCoordinates> > AlphaFramework.World.Positionables.Positionable< TCoordinates >.Changed

Occurs when a property relevant for rendering has changed.

Action<Positionable<TCoordinates> > AlphaFramework.World.Positionables.Positionable< TCoordinates >.ChangedRebuild

Occurs when a property has changed that requires visual representations to rebuilt from scratch (usually a template).


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