Class ActionAbstract

Base class used to represent an action

Hierarchy (View Summary)

Constructors

constructor

Properties

_alias _needsObject

Accessors

alias needsObject

Methods

execute name

Constructors

Protectedconstructor

  • new Action(alias: string, needsObject: boolean): Action

  • Create a new instance of the custom action

    Parameters

    • alias: string

      Alias used to identify this action

    • needsObject: boolean

      Set to true if this action requires another GameObject to work, otherwise false.

    Returns Action

Properties

Private_alias

_alias: string

Alias used to identify this action

Private_needsObject

_needsObject: boolean

Set to true if this action requires another GameObject to work, otherwise false.

Accessors

alias

  • get alias(): string

  • Get the alias used to identify this action

    Returns string

needsObject

  • get needsObject(): boolean

  • Returns true if this action requires another GameObject to work, otherwise false.

    Returns boolean

Methods

Abstractexecute

  • execute(alias: string, gameObjects: GameObject[]): undefined | ActionResult

  • Execute the action

    Parameters

    • alias: string

      Alias used to identify the kind of action

    • gameObjects: GameObject[]

      Array of game objects, where the first index is a reference to the game object on which the action should be executed.

    Returns undefined | ActionResult

    Result of the action or undefined if unhandled

Abstractname

  • name(): SyncOrAsync<string>

  • Get the name of this action

    Returns SyncOrAsync<string>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods