RAIN.Action.IActionExecutor Interface Reference

IActionExecutor is an add-on interface used by ActionExecutors to support setup and management of Actions and Action execution. Most ActionExecutors will implement Action and support IActionExecutor. More...

Inheritance diagram for RAIN.Action.IActionExecutor:
RAIN.Action.ParallelActionExecutor RAIN.Action.SequentialActionExecutor RAIN.Action.TeleoReactiveActionExecutor

List of all members.

Public Member Functions

void Reset (Agent actor)
 Reset the ActionExecutor to its initial state.
void Reset (Agent actor, ActionContext context)
 Reset the ActionExecutor to its initial state, setting the ActionContext to the supplied context when done.
void AddAction (Action action, float delay)
 Add an action to the list of Actions to execute. A delay can be included specifying a time delay between activation/selection of an action and when it can be executed.
void InsertAction (Action action, int sequence)
 Insert an action at the specified position into the list of Actions to execute. A delay can be included specifying a time delay between activation/selection of an action and when it can be executed.
void RemoveAction (string actionName)
 Remove an action from the ActionExecutor. This will cause the Action to be Stopped and unloaded if it is currently executing.
void Pause ()
 Pause will cause execution to be paused until Unpause is called. Paused execution will essentially stop time and cause execution to resume where it left off.
void Unpause (float delay)
 Unpause will resume execution. If a delay is specified, execution will remain paused until after the delay.
void Clear ()
 Clear will cause all Actions to be removed from the ActionExecutor.

Detailed Description

IActionExecutor is an add-on interface used by ActionExecutors to support setup and management of Actions and Action execution. Most ActionExecutors will implement Action and support IActionExecutor.


Member Function Documentation

void RAIN.Action.IActionExecutor.AddAction ( Action  action,
float  delay 
)

Add an action to the list of Actions to execute. A delay can be included specifying a time delay between activation/selection of an action and when it can be executed.

Parameters:
actionAn Action to add
delayA time delay in seconds to wait for before allowing execution of the Action

Implemented in RAIN.Action.ParallelActionExecutor, RAIN.Action.SequentialActionExecutor, and RAIN.Action.TeleoReactiveActionExecutor.

void RAIN.Action.IActionExecutor.Clear ( )

Clear will cause all Actions to be removed from the ActionExecutor.

Implemented in RAIN.Action.ParallelActionExecutor, RAIN.Action.SequentialActionExecutor, and RAIN.Action.TeleoReactiveActionExecutor.

void RAIN.Action.IActionExecutor.InsertAction ( Action  action,
int  sequence 
)

Insert an action at the specified position into the list of Actions to execute. A delay can be included specifying a time delay between activation/selection of an action and when it can be executed.

Parameters:
actionAn Action to insert
delayA time delay in seconds to wait for before allowing execution of the Action

Implemented in RAIN.Action.ParallelActionExecutor, RAIN.Action.SequentialActionExecutor, and RAIN.Action.TeleoReactiveActionExecutor.

void RAIN.Action.IActionExecutor.Pause ( )

Pause will cause execution to be paused until Unpause is called. Paused execution will essentially stop time and cause execution to resume where it left off.

Implemented in RAIN.Action.ParallelActionExecutor, RAIN.Action.SequentialActionExecutor, and RAIN.Action.TeleoReactiveActionExecutor.

void RAIN.Action.IActionExecutor.RemoveAction ( string  actionName)

Remove an action from the ActionExecutor. This will cause the Action to be Stopped and unloaded if it is currently executing.

Parameters:
actionNameThe name of the Action to remove. If more than one Action is loaded with a matching name, all matches will be removed.

Implemented in RAIN.Action.ParallelActionExecutor, RAIN.Action.SequentialActionExecutor, and RAIN.Action.TeleoReactiveActionExecutor.

void RAIN.Action.IActionExecutor.Reset ( Agent  actor,
ActionContext  context 
)

Reset the ActionExecutor to its initial state, setting the ActionContext to the supplied context when done.

Parameters:
actorThe AI agent owning this ActionExecutor
contextThe ActionContext to initialize the ActionExecutor with

Implemented in RAIN.Action.ParallelActionExecutor, RAIN.Action.SequentialActionExecutor, and RAIN.Action.TeleoReactiveActionExecutor.

void RAIN.Action.IActionExecutor.Reset ( Agent  actor)

Reset the ActionExecutor to its initial state.

Parameters:
actorThe AI agent owning this ActionExecutor

Implemented in RAIN.Action.ParallelActionExecutor, RAIN.Action.SequentialActionExecutor, and RAIN.Action.TeleoReactiveActionExecutor.

void RAIN.Action.IActionExecutor.Unpause ( float  delay)

Unpause will resume execution. If a delay is specified, execution will remain paused until after the delay.

Parameters:
delay

Implemented in RAIN.Action.ParallelActionExecutor, RAIN.Action.SequentialActionExecutor, and RAIN.Action.TeleoReactiveActionExecutor.