Interface IOperationalAction<TAgent>

The required interface for operational actions, as used in executing a plan

Namespace: Unity.AI.Planner.Agent

Syntax

public interface IOperationalAction<TAgent> : IOperationalAction

Type Parameters

Name	Description
TAgent	Agent type

Methods

BeginExecution(Entity, ActionContext, TAgent)

Begins the execution of the operational action

Declaration

void BeginExecution(Entity stateEntity, ActionContext action, TAgent agent)

Parameters

Type	Name	Description
Entity	stateEntity	Entity corresponding to the current state
ActionContext	action	Action context for the planner representation of the operational action
TAgent	agent	The agent enacting the operational action

ContinueExecution(Entity, ActionContext, TAgent)

Continues the execution of the operational action

Declaration

void ContinueExecution(Entity stateEntity, ActionContext action, TAgent agent)

Parameters

Type	Name	Description
Entity	stateEntity	Entity corresponding to the current state
ActionContext	action	Action context for the planner representation of the operational action
TAgent	agent	The agent enacting the operational action

EndExecution(Entity, ActionContext, TAgent)

Ends the execution of the operational action

Declaration

void EndExecution(Entity stateEntity, ActionContext action, TAgent agent)

Parameters

Type	Name	Description
Entity	stateEntity	Entity corresponding to the current state
ActionContext	action	Action context for the planner representation of the operational action
TAgent	agent	The agent enacting the operational action

Status(Entity, ActionContext, TAgent)

Reports the execution status of the operational action

Declaration

OperationalActionStatus Status(Entity stateEntity, ActionContext action, TAgent agent)

Parameters

Type	Name	Description
Entity	stateEntity	Entity corresponding to the current state
ActionContext	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