Crystal AI  1.0.0
Crystal.AiTransition Class Reference

AiTransition is an T:Crystal.IAction that when executed triggers a selection of an action in another AI. More...

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

Classes

class  TargetAiDoesNotExistException
 
class  TargetAiNullException
 

Public Member Functions

override 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...
 
IAction Select (IContext context)
 Triggers the action selection mechanism of the associated T:Crystal.IBehaviour or T:Crystal.IUtilityAi. More...
 
 AiTransition (IUtilityAi ai)
 Initializes a new instance of the AiTransition class. More...
 
 AiTransition (string nameId, string aiNameId, IAiCollection collection)
 Initializes a new instance of the AiTransition class. More...
 
- Public Member Functions inherited from Crystal.IAction
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...
 

Additional Inherited Members

- Properties inherited from Crystal.IAction
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

AiTransition is an T:Crystal.IAction that when executed triggers a selection of an action in another AI.

See also
T:Crystal.ActionBase, T:Crystal.ITransition

Constructor & Destructor Documentation

Crystal.AiTransition.AiTransition ( IUtilityAi  ai)
inline

Initializes a new instance of the AiTransition class.

Parameters
aiThe ai.
Exceptions
Crystal.AiTransition.TargetAiNullException
Crystal.AiTransition.AiTransition ( string  nameId,
string  aiNameId,
IAiCollection  collection 
)
inline

Initializes a new instance of the AiTransition class.

Parameters
nameIdThe name identifier.
aiNameIdThe ai name identifier.
collectionThe collection.
Exceptions
Crystal.ActionBase.NameIdEmptyOrNullException

Member Function Documentation

override IAction Crystal.AiTransition.Clone ( )
inline

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!

Returns
IAction Crystal.AiTransition.Select ( IContext  context)
inline

Triggers the action selection mechanism of the associated T:Crystal.IBehaviour or T:Crystal.IUtilityAi.

Parameters
contextThe context.
Returns

Implements Crystal.ITransition.


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