Interface IOperationalAction<TAgent, TStateData, TAction>
The required interface for operational actions, as used in executing a plan
Namespace: Unity.AI.Planner.Agent
Syntax
public interface IOperationalAction<TAgent, TStateData, TAction> : IOperationalAction where TAction : IActionKeyType Parameters
| Name | Description |
|---|---|
| TAgent | Agent type |
| TStateData | StateData type (custom per domain) |
| TAction | Action type |
Methods
BeginExecution(TStateData, TAction, TAgent)
Begins the execution of the operational action
Declaration
void BeginExecution(TStateData state, TAction action, TAgent agent)Parameters
| Type | Name | Description |
|---|---|---|
| TStateData | state | Current state |
| TAction | action | Action context for the planner representation of the operational action |
| TAgent | agent | The agent enacting the operational action |
ContinueExecution(TStateData, TAction, TAgent)
Continues the execution of the operational action
Declaration
void ContinueExecution(TStateData state, TAction action, TAgent agent)Parameters
| Type | Name | Description |
|---|---|---|
| TStateData | state | Current state |
| TAction | action | Action context for the planner representation of the operational action |
| TAgent | agent | The agent enacting the operational action |
EndExecution(TStateData, TAction, TAgent)
Ends the execution of the operational action
Declaration
void EndExecution(TStateData state, TAction action, TAgent agent)Parameters
| Type | Name | Description |
|---|---|---|
| TStateData | state | Current state |
| TAction | action | Action context for the planner representation of the operational action |
| TAgent | agent | The agent enacting the operational action |
Status(TStateData, TAction, TAgent)
Reports the execution status of the operational action
Declaration
OperationalActionStatus Status(TStateData state, TAction action, TAgent agent)Parameters
| Type | Name | Description |
|---|---|---|
| TStateData | state | Current state |
| TAction | action | Action context for the planner representation of the operational action |
| TAgent | agent | The agent enacting the operational action |
Returns
| Type | Description |
|---|---|
| OperationalActionStatus | Returns the status of the operational action |