Class Agent

The brain of the Utility AI. It controls the states and uses the UtilityPlanner to find the best action.

Inheritance
Object
Agent
Namespace: TinnyStudios.AIUtility
Assembly: UtilityAIFramework.dll
Syntax
public class Agent : MonoBehaviour

Fields

Actions

Declaration
public List<IUtilityAction> Actions
Field Value
Type Description
List<IUtilityAction>

Events

Declaration
public Agent.AgentEvents Events
Field Value
Type Description
Agent.AgentEvents

MoveSystem

Declaration
public MoveSystemBase MoveSystem
Field Value
Type Description
MoveSystemBase

PauseRoutine

Declaration
public Coroutine PauseRoutine
Field Value
Type Description
Coroutine

PropertySet

Declaration
public PropertySetRuntime PropertySet
Field Value
Type Description
PropertySetRuntime

State

Declaration
public EAgentState State
Field Value
Type Description
EAgentState

StateNames

Declaration
public Dictionary<EAgentState, string> StateNames
Field Value
Type Description
Dictionary<EAgentState, String>

UtilityPlanner

Declaration
public UtilityPlanner UtilityPlanner
Field Value
Type Description
UtilityPlanner

Properties

Context

Declaration
public IAgentDataContext Context { get; }
Property Value
Type Description
IAgentDataContext

CurrentAction

Declaration
public IUtilityAction CurrentAction { get; }
Property Value
Type Description
IUtilityAction

Methods

AbortPlan()

Declaration
public void AbortPlan()

AddAction(UtilityAction)

Add and set up the action.

Declaration
public void AddAction(UtilityAction utilityAction)
Parameters
Type Name Description
UtilityAction utilityAction

Awake()

Declaration
protected virtual void Awake()

ExecutePlan()

Declaration
public void ExecutePlan()

FindPlan()

Find a plan and returns true if it exists.

Declaration
public bool FindPlan()
Returns
Type Description
Boolean

FixedUpdate()

Declaration
protected virtual void FixedUpdate()

GetContext<T>()

Declaration
public T GetContext<T>()
    where T : IAgentDataContext
Returns
Type Description
T
Type Parameters
Name Description
T

GoToState(EAgentState)

Declaration
public void GoToState(EAgentState state)
Parameters
Type Name Description
EAgentState state

Initialize()

Declaration
public virtual void Initialize()

IsCurrentActionValid()

Is the current action valid to use?

Declaration
public virtual bool IsCurrentActionValid()
Returns
Type Description
Boolean

LateUpdate()

Declaration
protected virtual void LateUpdate()

PauseFor(Single, EAgentState, Action)

Set UtilityPlanner pause to true and transition to idle for duration and then transition to planning.

Declaration
public virtual Coroutine PauseFor(float duration, EAgentState postState = EAgentState.Plan, Action postAction = null)
Parameters
Type Name Description
Single duration
EAgentState postState
Action postAction
Returns
Type Description
Coroutine

Perform()

Declaration
public virtual void Perform()

ReplaceActions(List<IUtilityAction>)

Declaration
public void ReplaceActions(List<IUtilityAction> actions)
Parameters
Type Name Description
List<IUtilityAction> actions

ResetCurrentAction()

Declaration
public void ResetCurrentAction()

SearchForActionsInParent()

Searches for actions available on the Agent.

Declaration
public virtual void SearchForActionsInParent()

SetupAction(IUtilityAction)

Declaration
public virtual void SetupAction(IUtilityAction utilityAction)
Parameters
Type Name Description
IUtilityAction utilityAction

SetupActions()

Declaration
public virtual void SetupActions()

StartPlan()

Declaration
protected virtual Coroutine StartPlan()
Returns
Type Description
Coroutine

Update()

Declaration
protected virtual void Update()

Extension Methods