Frame of Reference Game API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
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:

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...
 

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 [get, set]
 The Waypoints index of the Waypoint this entity is currently moving towards; -1 for no Waypoint. More...
 
List< WaypointWaypoints = -1 [get]
 The Waypoints associated with this entity ordered by Waypoint.ActivationTime. More...
 

Detailed Description

An entity that can be placed on a Terrain{TTemplate}.

Member Function Documentation

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.
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.
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

int FrameOfReference.World.Positionables.Entity.ActiveWaypointIndex
getset

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

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.

float FrameOfReference.World.Positionables.Entity.Rotation
getset

The horizontal rotation of the view direction in degrees.

List<Waypoint> FrameOfReference.World.Positionables.Entity.Waypoints = -1
get

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


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