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...
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
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:
-
action | An Action to add |
delay | A time delay in seconds to wait for before allowing execution of the Action |
Clear will cause all Actions to be removed from the ActionExecutor.
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:
-
action | An Action to insert |
delay | A time delay in seconds to wait for before allowing execution of the Action |
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.
Remove an action from the ActionExecutor. This will cause the Action to be Stopped and unloaded if it is currently executing.
- Parameters:
-
actionName | The name of the Action to remove. If more than one Action is loaded with a matching name, all matches will be removed. |
Reset the ActionExecutor to its initial state.
- Parameters:
-
actor | The AI agent owning this ActionExecutor |
Reset the ActionExecutor to its initial state, setting the ActionContext to the supplied context when done.
- Parameters:
-
actor | The AI agent owning this ActionExecutor |
context | The ActionContext to initialize the ActionExecutor with |
Unpause will resume execution. If a delay is specified, execution will remain paused until after the delay.
- Parameters:
-