Search Results for

    Show / Hide Table of Contents

    Class UtilityAction

    The base implementation for Utility Action to be used by the planner. See the interface IUtilityAction for detailed comments.

    Inheritance
    Object
    UtilityAction
    BuySwordAction
    EatAction
    GiveSwordAction
    SleepAction
    SwordFightAction
    WorkAction
    SpellAttackAction
    Implements
    IUtilityAction
    Namespace: TinnyStudios.AIUtility
    Assembly: UtilityAIFramework.dll
    Syntax
    public abstract class UtilityAction : MonoBehaviour, IUtilityAction

    Fields

    Considerations

    Declaration
    public List<Consideration> Considerations
    Field Value
    Type Description
    List<Consideration>

    Events

    Declaration
    public UtilityAction.ActionEvents Events
    Field Value
    Type Description
    UtilityAction.ActionEvents

    MinScore

    Declaration
    public float MinScore
    Field Value
    Type Description
    Single

    MoveData

    Declaration
    public ActionMoveData MoveData
    Field Value
    Type Description
    ActionMoveData

    Name

    Declaration
    public string Name
    Field Value
    Type Description
    String

    PerformData

    Declaration
    public ActionPerformData PerformData
    Field Value
    Type Description
    ActionPerformData

    PropertySet

    Declaration
    public PropertySetRuntime PropertySet
    Field Value
    Type Description
    PropertySetRuntime

    State

    Declaration
    public EActionStatus State
    Field Value
    Type Description
    EActionStatus

    Weight

    Declaration
    public float Weight
    Field Value
    Type Description
    Single

    Properties

    Agent

    Declaration
    public Agent Agent { get; }
    Property Value
    Type Description
    Agent

    FoldOutEnabled

    Declaration
    public bool FoldOutEnabled { get; set; }
    Property Value
    Type Description
    Boolean

    Initialized

    Declaration
    public bool Initialized { get; set; }
    Property Value
    Type Description
    Boolean

    ReachedPerformDuration

    Declaration
    public bool ReachedPerformDuration { get; }
    Property Value
    Type Description
    Boolean

    Score

    Declaration
    public float Score { get; }
    Property Value
    Type Description
    Single

    TimeWatch

    Declaration
    public virtual TimeWatcher TimeWatch { get; }
    Property Value
    Type Description
    TimeWatcher

    Methods

    AddConsideration(Consideration)

    Declaration
    public void AddConsideration(Consideration consideration)
    Parameters
    Type Name Description
    Consideration consideration

    InitializeDynamicConsideration()

    Declaration
    public virtual void InitializeDynamicConsideration()

    IsAvailable()

    Declaration
    public virtual bool IsAvailable()
    Returns
    Type Description
    Boolean

    OnConsiderationCheck(Consideration)

    Declaration
    public virtual void OnConsiderationCheck(Consideration consideration)
    Parameters
    Type Name Description
    Consideration consideration

    OnMove(MoveSystemBase)

    Declaration
    public virtual void OnMove(MoveSystemBase moveSystem)
    Parameters
    Type Name Description
    MoveSystemBase moveSystem

    OnMoveStarted(MoveSystemBase)

    Declaration
    public virtual void OnMoveStarted(MoveSystemBase moveSystem)
    Parameters
    Type Name Description
    MoveSystemBase moveSystem

    OnPerformByDurationCompleted(Agent)

    Called when Perform By Duration is completed. Override this to execute code after it completes.

    Declaration
    protected virtual void OnPerformByDurationCompleted(Agent agent)
    Parameters
    Type Name Description
    Agent agent

    OnReachedDestination()

    Declaration
    public virtual void OnReachedDestination()

    Perform(Agent)

    Declaration
    public abstract EActionStatus Perform(Agent agent)
    Parameters
    Type Name Description
    Agent agent
    Returns
    Type Description
    EActionStatus

    PerformByDuration(Agent)

    While the running elapsed has not reached action perform duration, it'll return Running and keep the action continuing. Pass in any method group to be called on complete.

    Declaration
    protected EActionStatus PerformByDuration(Agent agent)
    Parameters
    Type Name Description
    Agent agent
    Returns
    Type Description
    EActionStatus

    RemoveConsideration(Consideration)

    Declaration
    public void RemoveConsideration(Consideration consideration)
    Parameters
    Type Name Description
    Consideration consideration

    SetScore(Single)

    Declaration
    public virtual void SetScore(float score)
    Parameters
    Type Name Description
    Single score

    SetState(EActionStatus)

    Declaration
    public void SetState(EActionStatus state)
    Parameters
    Type Name Description
    EActionStatus state

    Setup(Agent)

    Declaration
    public virtual void Setup(Agent agent)
    Parameters
    Type Name Description
    Agent agent

    Explicit Interface Implementations

    IUtilityAction.Considerations

    Declaration
    List<Consideration> IUtilityAction.Considerations { get; }
    Returns
    Type Description
    List<Consideration>

    IUtilityAction.Events

    Declaration
    UtilityAction.ActionEvents IUtilityAction.Events { get; }
    Returns
    Type Description
    UtilityAction.ActionEvents

    IUtilityAction.MoveData

    Declaration
    ActionMoveData IUtilityAction.MoveData { get; }
    Returns
    Type Description
    ActionMoveData

    IUtilityAction.Name

    Declaration
    string IUtilityAction.Name { get; }
    Returns
    Type Description
    String

    IUtilityAction.PropertySet

    Declaration
    PropertySetRuntime IUtilityAction.PropertySet { get; }
    Returns
    Type Description
    PropertySetRuntime

    IUtilityAction.State

    Declaration
    EActionStatus IUtilityAction.State { get; }
    Returns
    Type Description
    EActionStatus

    IUtilityAction.Weight

    Declaration
    float IUtilityAction.Weight { get; }
    Returns
    Type Description
    Single

    Implements

    IUtilityAction
    In This Article
    Back to top Generated by DocFX