Class TalkAction

Class used to represent the Talk action

Hierarchy (View Summary)

Constructors

constructor

Properties

Alias

Accessors

alias needsObject

Methods

execute executeTalk executeTalkWithChoice name

Constructors

constructor

Properties

Static ReadonlyAlias

Alias: string = "talk"

Alias used to identity the Talk 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 Talk action

    Parameters

    • alias: string

      Alias used to identify the kind of Talk action

    • gameObjects: GameObject[]

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

    Returns undefined | ActionResult

    Result of the Talk action or undefined if unhandled

PrivateexecuteTalk

  • executeTalk(gameObject: GameObject, choiceId?: number): undefined | ActionResult

  • Execute the Talk action

    Parameters

    • gameObject: GameObject

      Reference to the game object on which the Talk action should be executed

    • OptionalchoiceId: number

      Optional ID of the specific choice to handle

    Returns undefined | ActionResult

    Result of the Talk action or undefined if unhandled

executeTalkWithChoice

  • executeTalkWithChoice(alias: string): undefined | ActionResult

  • Execute the Talk action with a choice

    Parameters

    • alias: string

      Alias containing the character alias and choice id

    Returns undefined | ActionResult

    Result of the Talk 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