Class RoomAbstract

Base class used to represent a room

Remarks

Implements the Examine action by default

Hierarchy (View Summary)

Implements

Constructors

constructor

Accessors

alias

Methods

actions examine images name objects

Constructors

Protectedconstructor

  • new Room(alias: string): Room

  • Create a new instance of this room

    Parameters

    • alias: string

      Alias of this room

    Returns Room

Accessors

alias

  • get alias(): string

  • Get the alias of this game object

    Returns string

Methods

actions

  • actions(): SyncOrAsync<Action[]>

  • Get the actions that can be used in this room

    Returns SyncOrAsync<Action[]>

    List of actions

Abstractexamine

  • examine(): undefined | ActionResult

  • Execute the Examine action

    Returns undefined | ActionResult

    Result of the Examine action or undefined if unhandled

images

  • images(): SyncOrAsync<string[]>

  • Get the images used to graphically represent this room

    Returns SyncOrAsync<string[]>

    List of images

Abstractname

  • name(): SyncOrAsync<string>

  • Get the name of this game object

    Returns SyncOrAsync<string>

objects

  • objects(): SyncOrAsync<GameObject[]>

  • Get the game objects that are located inside this room

    Returns SyncOrAsync<GameObject[]>

    List of game objects

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods