Crystal AI  1.0.0
Crystal.IAction Interface Reference

AI Actions Interface. This is the "bottom-line" in that all decision making eventually leads to the execution of a class that implements this interface. More...

Inheritance diagram for Crystal.IAction:
Crystal.IAiPrototype< IAction > Crystal.ActionBase< TContext > Crystal.ActionBase< TContext > Crystal.ITransition Crystal.AiTransition Crystal.BehaviourTransition

Public Member Functions

void Execute (IContext context)
 Executes the AI Action. More...
 
- Public Member Functions inherited from Crystal.IAiPrototype< IAction >
Clone ()
 Creates a new instance of the implementing class. Note that the semantics here are somewhat vague, however, by convention the "Prototype Pattern" uses a "Clone" function. Note that this may have very different semantics when compared with either shallow or deep cloning. When implementing this remember to include only the defining characteristics of the class and not its state! More...
 

Properties

string NameId [get]
 A unique identifier for this action. More...
 
float ElapsedTime [get]
 The Time that this action has been running for since it has been started in seconds. More...
 
float Cooldown [get, set]
 The required cool-down time, in seconds, needed before this action executes again. More...
 
bool InCooldown [get]
 This returns true if the cool-down time for this action has not yet elapsed. More...
 
ActionStatus ActionStatus [get]
 Gets the action status. More...
 

Detailed Description

AI Actions Interface. This is the "bottom-line" in that all decision making eventually leads to the execution of a class that implements this interface.

See also
T:Crystal.IAiPrototype`1

Member Function Documentation

void Crystal.IAction.Execute ( IContext  context)

Executes the AI Action.

Parameters
contextAI Context.

Implemented in Crystal.ActionBase< TContext >.

Property Documentation

ActionStatus Crystal.IAction.ActionStatus
get

Gets the action status.

float Crystal.IAction.Cooldown
getset

The required cool-down time, in seconds, needed before this action executes again.

float Crystal.IAction.ElapsedTime
get

The Time that this action has been running for since it has been started in seconds.

bool Crystal.IAction.InCooldown
get

This returns true if the cool-down time for this action has not yet elapsed.

string Crystal.IAction.NameId
get

A unique identifier for this action.


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