Frame of Reference Game API  1.0.3
Public Member Functions | Properties | List of all members
FrameOfReference.World.Positionables.Entity Class Reference

An entity that can be placed on a Terrain<TTemplate>. More...

Inheritance diagram for FrameOfReference.World.Positionables.Entity:
AlphaFramework.World.Positionables.EntityBase< Vector2, EntityTemplate > AlphaFramework::World::Positionables::Positionable< class > AlphaFramework::World::Positionables::IUpdateable AlphaFramework::World::Positionables::ITemplated NanoByte::Common::ICloneable< T >

Public Member Functions

override void Update (double elapsedTime)
 
int GetCurrentWaypointIndex (double gameTime)
 Determines the currently active Waypoints entry. More...
 
bool CollisionTest (Vector2 point)
 Determines whether a certain point collides with this entity (based on its Collision<TCoordinates> component). More...
 
bool CollisionTest (Quadrangle area)
 Determines whether a certain area collides with this entity (based on its Collision<TCoordinates> component). More...
 
- Public Member Functions inherited from AlphaFramework.World.Positionables.EntityBase< Vector2, EntityTemplate >
override string ToString ()
 
override Positionable< TCoordinates > Clone ()
 
- Public Member Functions inherited from AlphaFramework::World::Positionables::Positionable< class >
override string ToString ()
 

Properties

float Rotation [get, set]
 The horizontal rotation of the view direction in degrees. More...
 
bool IsPlayerControlled [get, set]
 true if this entity is controlled by a human player, false if it is controlled by the computer. More...
 
int ActiveWaypointIndex = -1 [get, set]
 The Waypoints index of the Waypoint this entity is currently moving towards; -1 for no Waypoint. More...
 
List< WaypointWaypoints = new List<Waypoint>() [get]
 The Waypoints associated with this entity ordered by Waypoint.ActivationTime. More...
 
- Properties inherited from AlphaFramework.World.Positionables.EntityBase< Vector2, EntityTemplate >
string TemplateName
 
TTemplate? TemplateData
 
StoredPath< TCoordinates > CurrentPath
 
- Properties inherited from AlphaFramework::World::Positionables::Positionable< class >
string Name
 
TCoordinates Position
 
- Properties inherited from AlphaFramework::World::Positionables::ITemplated
string TemplateName
 

Additional Inherited Members

- Static Public Member Functions inherited from AlphaFramework.World.Positionables.EntityBase< Vector2, EntityTemplate >
static IDisposable MaskTemplateData ()
 
- Protected Member Functions inherited from AlphaFramework::World::Positionables::Positionable< class >
virtual void OnChanged ()
 
void OnChangedRebuild ()
 
- Events inherited from AlphaFramework::World::Positionables::Positionable< class >
Action< Positionable< TCoordinates > > Changed
 
Action< Positionable< TCoordinates > > ChangedRebuild
 

Detailed Description

An entity that can be placed on a Terrain<TTemplate>.

Member Function Documentation

◆ CollisionTest() [1/2]

bool FrameOfReference.World.Positionables.Entity.CollisionTest ( Vector2  point)
inline

Determines whether a certain point collides with this entity (based on its Collision<TCoordinates> component).

Parameters
pointThe point to check for collision in world space.
Returns
true if the point does collide with this entity, false otherwise.

◆ CollisionTest() [2/2]

bool FrameOfReference.World.Positionables.Entity.CollisionTest ( Quadrangle  area)
inline

Determines whether a certain area collides with this entity (based on its Collision<TCoordinates> component).

Parameters
areaThe area to check for collision in world space.
Returns
true if the area does collide with this entity, false otherwise.

◆ GetCurrentWaypointIndex()

int FrameOfReference.World.Positionables.Entity.GetCurrentWaypointIndex ( double  gameTime)
inline

Determines the currently active Waypoints entry.

Parameters
gameTimeThe current UniverseBase<TCoordinates>.GameTime value.
Returns
The currently active Waypoint; null if none is active.

Property Documentation

◆ ActiveWaypointIndex

int FrameOfReference.World.Positionables.Entity.ActiveWaypointIndex = -1
getset

The Waypoints index of the Waypoint this entity is currently moving towards; -1 for no Waypoint.

◆ IsPlayerControlled

bool FrameOfReference.World.Positionables.Entity.IsPlayerControlled
getset

true if this entity is controlled by a human player, false if it is controlled by the computer.

◆ Rotation

float FrameOfReference.World.Positionables.Entity.Rotation
getset

The horizontal rotation of the view direction in degrees.

◆ Waypoints

List<Waypoint> FrameOfReference.World.Positionables.Entity.Waypoints = new List<Waypoint>()
get

The Waypoints associated with this entity ordered by Waypoint.ActivationTime.


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