Class StartupRoom

Implemention of the startup room

Remarks

Used as the first room for new player sessions.

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

Alias

Accessors

alias

Methods

actions examine images name objects simple

Constructors

constructor

Properties

Static ReadonlyAlias

Alias: string = "startup"

Alias of this room

Accessors

alias

  • get alias(): string

  • Get the alias of this game object

    Returns string

Methods

actions

  • actions(): Action[]

  • Get the actions that can be used in this room

    Returns Action[]

    List of actions

examine

  • examine(): undefined | ActionResult

  • Execute the Examine action

    Returns undefined | ActionResult

    Result of the Examine action or undefined if unhandled

images

  • images(): string[]

  • Get the images used to graphically represent this room

    Returns string[]

    List of images

name

  • name(): string

  • Get the name of this game object

    Returns string

objects

  • objects(): SyncOrAsync<GameObject[]>

  • Get the game objects that are located inside this room

    Returns SyncOrAsync<GameObject[]>

    List of game objects

simple

  • simple(alias: string): undefined | ActionResult

  • Execute a simple action

    Parameters

    • alias: string

      Alias of the simple action to execute

    Returns undefined | ActionResult

    Result of the simple action or undefined if unhandled

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods