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.Trigger Class Reference

Executes Lua scripts on proximity or timers. More...

Inheritance diagram for FrameOfReference.World.Positionables.Trigger:

Public Member Functions

bool IsInRange (Positionable< Vector2 > entity)
 Determines whether an entity is within range of this trigger. More...
 

Properties

float Range [get, set]
 The maximum distance at which an Entity activates this trigger. More...
 
double DueTime [get, set]
 The UniverseBase{T}.GameTime by which this trigger should have been activated. More...
 
string TargetEntity [get, set]
 The name of the Entity whose proximity causes this trigger to activate. More...
 
string OnActivation [get, set]
 A Lua script to execute when TargetEntity gets within Range. More...
 
string OnTimeout [get, set]
 A Lua script to execute if the trigger was not activated by DueTime. More...
 
bool WasTriggered [get, set]
 Indicates whether this trigger has already been triggered by TargetEntity or has timed out. More...
 
string DependsOn [get, set]
 The name of another Trigger that has to be triggered before this one can be. More...
 

Detailed Description

Executes Lua scripts on proximity or timers.

Member Function Documentation

bool FrameOfReference.World.Positionables.Trigger.IsInRange ( Positionable< Vector2 >  entity)
inline

Determines whether an entity is within range of this trigger.

Property Documentation

string FrameOfReference.World.Positionables.Trigger.DependsOn
getset

The name of another Trigger that has to be triggered before this one can be.

double FrameOfReference.World.Positionables.Trigger.DueTime
getset

The UniverseBase{T}.GameTime by which this trigger should have been activated.

string FrameOfReference.World.Positionables.Trigger.OnActivation
getset

A Lua script to execute when TargetEntity gets within Range.

string FrameOfReference.World.Positionables.Trigger.OnTimeout
getset

A Lua script to execute if the trigger was not activated by DueTime.

float FrameOfReference.World.Positionables.Trigger.Range
getset

The maximum distance at which an Entity activates this trigger.

string FrameOfReference.World.Positionables.Trigger.TargetEntity
getset

The name of the Entity whose proximity causes this trigger to activate.

bool FrameOfReference.World.Positionables.Trigger.WasTriggered
getset

Indicates whether this trigger has already been triggered by TargetEntity or has timed out.


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