Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace runtimeScene

Index

Classes

Functions

Functions

Const createObjectsFromExternalLayout

  • createObjectsFromExternalLayout(scene: RuntimeInstanceContainer, externalLayout: string, xPos: number, yPos: number): void

Const doesSceneExist

  • doesSceneExist(runtimeScene: RuntimeScene, sceneName: string): boolean

  • Check if a scene exists.

    Parameters

    Returns boolean

Const getElapsedTimeInSeconds

Const getSceneName

Const getTime

  • Parameters

    Returns number

Const getTimeFromStartInSeconds

  • getTimeFromStartInSeconds(runtimeScene: RuntimeScene): number

Const getTimeScale

Const getTimerElapsedTimeInSeconds

  • 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.

Const getTimerElapsedTimeInSecondsOrNaN

  • 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.

Const hasGameJustResumed

  • Check if the game has just resumed from being hidden

    Parameters

    Returns boolean

Const pauseTimer

  • pauseTimer(runtimeScene: RuntimeScene, timerName: string): void

  • Parameters

    Returns void

Const popScene

Const pushScene

  • pushScene(runtimeScene: RuntimeScene, newSceneName: string): void

  • Parameters

    Returns void

Const removeTimer

  • removeTimer(runtimeScene: RuntimeScene, timerName: string): void

  • Parameters

    Returns void

Const replaceScene

  • replaceScene(runtimeScene: RuntimeScene, newSceneName: string, clearOthers: boolean): void

  • Parameters

    • runtimeScene: RuntimeScene
    • newSceneName: string
    • clearOthers: boolean

    Returns void

Const resetTimer

  • resetTimer(runtimeScene: RuntimeScene, timerName: string): void

  • Parameters

    Returns void

Const sceneJustBegins

Const sceneJustResumed

Const setBackgroundColor

  • setBackgroundColor(runtimeScene: RuntimeScene, rgbColor: string): void

  • Parameters

    Returns void

Const setTimeScale

  • setTimeScale(runtimeScene: RuntimeScene, timeScale: number): void

  • Parameters

    Returns void

Const stopGame

Const timerElapsedTime

  • 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

Const timerPaused

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

  • Parameters

    Returns boolean

Const unpauseTimer

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

  • Parameters

    Returns void

Const wait

  • Parameters

    • durationInSeconds: number

    Returns AsyncTask

Generated using TypeDoc