Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ScenesCallbacksNode

The information about a scene directory.

Hierarchy

Index

Properties

Methods

Properties

path

path: string

The path of the scene directory.

sceneGroups

sceneGroups: ReadonlyArray<string>

The names of all subdirectories under the scene directory.

sceneGroupsCount

sceneGroupsCount: number

The number of subdirectories under the scene directory.

scenes

scenes: ReadonlyArray<string>

The names of all scenes under the scene directory.

scenesCount

scenesCount: number

The number of scenes under the scene directory.

Methods

dispose

  • dispose(): void

  • Releases the listener object for the scene directory.

    Returns void

forwardTo

  • Forwards a registered callback to another Callbacks object.

    Type parameters

    • NAME: string

    Parameters

    • name: NAME

      The name of the registered callback.

    • toCallbacks: Callbacks<ScenesCallbacks>

      The Callbacks object to which the registered callback is forwarded.

    Returns any

off

  • off<NAME>(name?: NAME, listener?: any): void

  • Unregisters a callback.

    Type parameters

    • NAME: string

    Parameters

    • Optional name: NAME

      The callback name.

    • Optional listener: any

      The callback function.

    Returns void

on

  • on<NAME>(name: NAME, listener: any): void

  • Registers a callback.

    Type parameters

    • NAME: string

    Parameters

    • name: NAME

      The callback name.

    • listener: any

      The callback function.

    Returns void

once

  • once<NAME>(name: NAME, listener: any): void

  • Registers a callback that is used only once.

    Type parameters

    • NAME: string

    Parameters

    • name: NAME

      The callback name.

    • listener: any

      The callback function.

    Returns void