Search Results for

    Show / Hide Table of Contents

    Class BaseTask

    Inheritance
    Object
    BaseTask
    AgentBaseTask
    Implements
    ITask
    Namespace: i5.VirtualAgents
    Assembly: cs.temp.dll.dll
    Syntax
    public abstract class BaseTask : ITask

    Properties

    State

    Declaration
    public TaskState State { get; set; }
    Property Value
    Type Description
    TaskState

    Methods

    EvaluateTaskState()

    Called by the executing agent on running tasks Performs frame-to-frame task execution updates This is e.g. useful for tracking movements towards a target and determinig when the agent has reached the target

    Declaration
    public virtual TaskState EvaluateTaskState()
    Returns
    Type Description
    TaskState

    StartExecution(Agent)

    Gets the reference to the agent which will execute this task Starts the task's execution

    Declaration
    public virtual void StartExecution(Agent executingAgent)
    Parameters
    Type Name Description
    Agent executingAgent

    StopAsFailed()

    Can be used to fail the task outside of its Update method

    Declaration
    public void StopAsFailed()

    StopAsSucceeded()

    Can be used to let the task succseed outside of its Update method

    Declaration
    public void StopAsSucceeded()

    StopExecution()

    Called when the task succeedes or fails

    Declaration
    public virtual void StopExecution()

    Tick(Agent)

    Declaration
    public TaskState Tick(Agent excutingAgent)
    Parameters
    Type Name Description
    Agent excutingAgent
    Returns
    Type Description
    TaskState

    Implements

    ITask
    In This Article
    Back to top Documentation of the Virtual Agents Framework