Class ExamineAction

Class used to represent the Examine action

Hierarchy (View Summary)

Constructors

constructor

Properties

Alias

Accessors

alias needsObject

Methods

execute name

Constructors

constructor

Properties

Static ReadonlyAlias

Alias: string = "examine"

Alias used to identity the Examine action

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

execute

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

  • Execute the Examine action

    Parameters

    • _alias: string

      Ignored

    • gameObjects: GameObject[]

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

    Returns undefined | ActionResult

    Result of the Examine action or undefined if unhandled

name

  • name(): string

  • Get the name of this action

    Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods