Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

  • areSceneAssetsLoaded(runtimeScene: RuntimeScene, sceneName: string): boolean
  • createObjectsFromExternalLayout(scene: RuntimeInstanceContainer, externalLayout: string, xPos: number, yPos: number, zPos: number): void
  • doesSceneExist(runtimeScene: RuntimeScene, sceneName: string): boolean
  • getSceneLoadingProgress(runtimeScene: RuntimeScene, sceneName: string): number
  • getTimeFromStartInSeconds(runtimeScene: RuntimeScene): number
  • getTimerElapsedTimeInSeconds(runtimeScene: RuntimeScene, timerName: string): number
  • This is used by expressions to return 0 when a timer doesn't exist, because numeric expressions must always return a number.

    Parameters

    • runtimeScene: RuntimeScene

      The scene owning the timer.

    • timerName: string

      The timer name.

    Returns number

    The timer elapsed time in seconds or 0 if the timer doesn't exist.

  • getTimerElapsedTimeInSecondsOrNaN(runtimeScene: RuntimeScene, timerName: string): number
  • This is used by conditions to return false when a timer doesn't exist, no matter the relational operator.

    Parameters

    • runtimeScene: RuntimeScene

      The scene owning the timer.

    • timerName: string

      The timer name.

    Returns number

    The timer elapsed time in seconds or NaN if the timer doesn't exist.

  • pauseTimer(runtimeScene: RuntimeScene, timerName: string): void
  • prioritizeLoadingOfScene(runtimeScene: RuntimeScene, sceneName: string): void
  • pushScene(runtimeScene: RuntimeScene, newSceneName: string): void
  • removeTimer(runtimeScene: RuntimeScene, timerName: string): void
  • replaceScene(runtimeScene: RuntimeScene, newSceneName: string, clearOthers: boolean): void
  • resetTimer(runtimeScene: RuntimeScene, timerName: string): void
  • setBackgroundColor(runtimeScene: RuntimeScene, rgbColor: string): void
  • setTimeScale(runtimeScene: RuntimeScene, timeScale: number): void
  • timerElapsedTime(runtimeScene: RuntimeScene, timeInSeconds: number, timerName: string): boolean
  • Test a timer elapsed time, if the timer doesn't exist it is created.

    deprecated

    prefer using getTimerElapsedTimeInSecondsOrNaN

    Parameters

    • runtimeScene: RuntimeScene

      The scene owning the timer

    • timeInSeconds: number

      The time value to check in seconds

    • timerName: string

      The timer name

    Returns boolean

    True if the timer exists and its value is greater than or equal than the given time, false otherwise

  • timerPaused(runtimeScene: RuntimeScene, timerName: string): boolean
  • unpauseTimer(runtimeScene: RuntimeScene, timerName: string): void

Generated using TypeDoc