Class RuntimeScene

constructor

• new RuntimeScene(runtimeGame): RuntimeScene

• Parameters

  • runtimeGame: RuntimeGame

    The game associated to this scene.

  Returns RuntimeScene

networkId

physics2SharedData

physics3DSharedData

addLayer

• addLayer(layerData): void

• Add a layer.

  Parameters

  • layerData: LayerData

    The data to construct the layer

  Returns void

convertCoords

• convertCoords(x, y, result): FloatPoint

• Convert a point from the canvas coordinates (for example, the mouse position) to the container coordinates.

  Parameters

  • x: number

    The x position, in container coordinates.
  • y: number

    The y position, in container coordinates.
  • result: FloatPoint

    The point instance that is used to return the result.

  Returns FloatPoint

convertInverseCoords

• convertInverseCoords(sceneX, sceneY, result): FloatPoint

• Convert a point from the container coordinates (for example, an object position) to the canvas coordinates.

  Parameters

  • sceneX: number

    The x position, in container coordinates.
  • sceneY: number

    The y position, in container coordinates.
  • result: FloatPoint

    The point instance that is used to return the result.

  Returns FloatPoint

createNewUniqueId

• createNewUniqueId(): number

• Create an identifier for a new object of the scene.

  Returns number

getAsyncTasksManager

• getAsyncTasksManager(): AsyncTasksManager

• Returns AsyncTasksManager

  The scene's async tasks manager.

getBackgroundColor

• getBackgroundColor(): number

• Get the background color, as an hexadecimal number.

  Returns number

  The current background color.

getClearCanvas

• getClearCanvas(): boolean

• Get whether the canvas should be cleared before this scene rendering.

  Returns boolean

getDebuggerRenderer

• getDebuggerRenderer(): DebuggerPixiRenderer

• Get the renderer for visual debugging associated to the container.

  Returns DebuggerPixiRenderer

getElapsedTime

• getElapsedTime(): number

• Return the time elapsed since the last frame, in milliseconds, for objects on the layer.

  Returns number

getGame

• getGame(): RuntimeGame

• Get the gdjs.RuntimeGame associated to this.

  Returns RuntimeGame

getInitialSharedDataForBehavior

• getInitialSharedDataForBehavior(name): null | BehaviorSharedData

• Get the data representing the initial shared data of the scene for the specified behavior.

  Parameters

  • name: string

    The name of the behavior

  Returns null | BehaviorSharedData

  The shared data for the behavior, if any.

getInitialUnrotatedViewportMaxX

• getInitialUnrotatedViewportMaxX(): number

• Returns number

  the right bound of:

  • the initial game resolution for a gdjs.RuntimeScene
  • the initial default dimensions (inner area) set in the editor for a gdjs.CustomRuntimeObject.

getInitialUnrotatedViewportMaxY

• getInitialUnrotatedViewportMaxY(): number

• Returns number

  the bottom bound of:

  • the initial game resolution for a gdjs.RuntimeScene
  • the initial default dimensions (inner area) set in the editor for a gdjs.CustomRuntimeObject.

getInitialUnrotatedViewportMinX

• getInitialUnrotatedViewportMinX(): number

• Returns number

  the left bound of:

  • the initial game resolution for a gdjs.RuntimeScene
  • the initial default dimensions (inner area) set in the editor for a gdjs.CustomRuntimeObject.

getInitialUnrotatedViewportMinY

• getInitialUnrotatedViewportMinY(): number

• Returns number

  the top bound of:

  • the initial game resolution for a gdjs.RuntimeScene
  • the initial default dimensions (inner area) set in the editor for a gdjs.CustomRuntimeObject.

getName

• getName(): string

• Get the name of the scene.

  Returns string

getNetworkSyncData

• getNetworkSyncData(syncOptions): null | LayoutNetworkSyncData

• Parameters

  • syncOptions: GetNetworkSyncDataOptions

  Returns null | LayoutNetworkSyncData

getOnceTriggers

• getOnceTriggers(): OnceTriggers

• Get the structure containing the triggers for "Trigger once" conditions.

  Returns OnceTriggers

getOrCreateNetworkId

• getOrCreateNetworkId(): string

• Returns string

getProfiler

• getProfiler(): null | Profiler

• Get the profiler associated with the scene, or null if none.

  Returns null | Profiler

getRenderer

• getRenderer(): RuntimeScenePixiRenderer

• Get the renderer associated to the container.

  Returns RuntimeScenePixiRenderer

getRequestedChange

• getRequestedChange(): SceneChangeRequest

• Return the value of the scene change that is requested.

  Returns SceneChangeRequest

getRequestedScene

• getRequestedScene(): string

• Return the name of the new scene to be launched.

  See requestChange.

  Returns string

getResourcesUnloading

• getResourcesUnloading(): "never" | "inherit" | "at-scene-exit"

• Get the strategy to unload resources of this scene.

  Returns "never" | "inherit" | "at-scene-exit"

getScene

• getScene(): RuntimeScene

• Get the gdjs.RuntimeScene associated to this.

  Returns RuntimeScene

getSoundManager

• getSoundManager(): HowlerSoundManager

• Shortcut to get the SoundManager of the game.

  Returns HowlerSoundManager

  The gdjs.SoundManager of the game.

getTimeManager

• getTimeManager(): TimeManager

• Get the TimeManager of the scene.

  Returns TimeManager

  The gdjs.TimeManager of the scene.

getUnrotatedViewportMaxX

• getUnrotatedViewportMaxX(): number

• Returns number

  the right bound of:

  • the game resolution for a gdjs.RuntimeScene
  • the default dimensions (the AABB of all its children) for a gdjs.CustomRuntimeObject.

getUnrotatedViewportMaxY

• getUnrotatedViewportMaxY(): number

• Returns number

  the bottom bound of:

  • the game resolution for a gdjs.RuntimeScene
  • the default dimensions (the AABB of all its children) for a gdjs.CustomRuntimeObject.

getUnrotatedViewportMinX

• getUnrotatedViewportMinX(): number

• Returns number

  the left bound of:

  • the game resolution for a gdjs.RuntimeScene
  • the default dimensions (the AABB of all its children) for a gdjs.CustomRuntimeObject.

getUnrotatedViewportMinY

• getUnrotatedViewportMinY(): number

• Returns number

  the top bound of:

  • the game resolution for a gdjs.RuntimeScene
  • the default dimensions (the AABB of all its children) for a gdjs.CustomRuntimeObject.

getVariables

• getVariables(): VariablesContainer

• Get the variables of the runtimeScene.

  Returns VariablesContainer

  The container holding the variables of the scene.

getVariablesForExtension

• getVariablesForExtension(extensionName): null | VariablesContainer

• Get the extension's variables for this scene.

  Parameters

  • extensionName: string

    The extension name.

  Returns null | VariablesContainer

  The extension's variables for this scene.

getViewportHeight

• getViewportHeight(): number

• Returns number

  the height of:

  • the game resolution for a gdjs.RuntimeScene
  • the default dimensions (the AABB of all its children) for a gdjs.CustomRuntimeObject.

getViewportOriginX

• getViewportOriginX(): number

• Returns number

  the center X of:

  • the game resolution for a gdjs.RuntimeScene
  • the default dimensions (the AABB of all its children) for a gdjs.CustomRuntimeObject.

getViewportOriginY

• getViewportOriginY(): number

• Returns number

  the center Y of:

  • the game resolution for a gdjs.RuntimeScene
  • the default dimensions (the AABB of all its children) for a gdjs.CustomRuntimeObject.

getViewportWidth

• getViewportWidth(): number

• Returns number

  the width of:

  • the game resolution for a gdjs.RuntimeScene
  • the default dimensions (the AABB of all its children) for a gdjs.CustomRuntimeObject.

loadFromScene

• loadFromScene(sceneAndExtensionsData): void

• Load the runtime scene from the given scene.

  Parameters

  • sceneAndExtensionsData: null | SceneAndExtensionsData

    An object containing the scene data.

  Returns void

  See

  gdjs.RuntimeGame#getSceneAndExtensionsData

onChildrenLocationChanged

• onChildrenLocationChanged(): void

• Triggered when the AABB of a child of the container could have changed.

  Returns void

onGameResolutionResized

• onGameResolutionResized(): void

• Should be called when the canvas where the scene is rendered has been resized. See gdjs.RuntimeGame.startGameLoop in particular.

  Returns void

onPause

• onPause(): void

• Called when a scene is "paused", i.e it will be not be rendered again for some time, until it's resumed or unloaded.

  Returns void

onResume

• onResume(): void

• Called when a scene is "resumed", i.e it will be rendered again on screen after having being paused.

  Returns void

render

• render(): void

• Render the PIXI container associated to the runtimeScene.

  Returns void

renderAndStep

• renderAndStep(elapsedTime): boolean

• Step and render the scene.

  Parameters

  • elapsedTime: number

    In milliseconds

  Returns boolean

  true if the game loop should continue, false if a scene change/push/pop or a game stop was requested.

requestChange

• requestChange(change, sceneName?): void

• Request a scene change to be made. The change is handled externally (see gdjs.SceneStack) thanks to getRequestedChange and getRequestedScene methods.

  Parameters

  • change: SceneChangeRequest

    One of RuntimeScene.CONTINUE|PUSH_SCENE|POP_SCENE|REPLACE_SCENE|CLEAR_SCENES|STOP_GAME.
  • Optional sceneName: string

    The name of the new scene to launch, if applicable.

  Returns void

sceneJustResumed

• sceneJustResumed(): boolean

• Check if the scene was just resumed. This is true during the first frame after the scene has been unpaused.

  Returns boolean

  true if the scene was just resumed

setBackgroundColor

• setBackgroundColor(r, g, b): void

• Change the background color, by setting the RGB components. Internally, the color is stored as an hexadecimal number.

  Parameters

  • r: number

    The color red component (0-255).
  • g: number

    The color green component (0-255).
  • b: number

    The color blue component (0-255).

  Returns void

setClearCanvas

• setClearCanvas(shouldClearCanvas): void

• Set whether the canvas should be cleared before this scene rendering. This is experimental: if possible, try to avoid relying on this and use custom objects to build complex scenes.

  Parameters

  • shouldClearCanvas: boolean

  Returns void

setEventsFunction

• setEventsFunction(func): void

• Set the function called each time the scene is stepped. The function will be passed the runtimeScene as argument.

  Note that this is already set up by the gdjs.RuntimeScene constructor and that you should not need to use this method.

  Parameters

  • func: (() => void)

    The function to be called.

    • • (): void

      • Returns void

  Returns void

setEventsGeneratedCodeFunction

• setEventsGeneratedCodeFunction(sceneData): void

• Set the function called each time the scene is stepped to be the events generated code, which is by convention assumed to be a function in gdjs with a name based on the scene mangled name.

  Parameters

  • sceneData: LayoutData

    The scene data, used to find where the code was generated.

  Returns void

startProfiler

• startProfiler(onProfilerStopped): void

• Start a new profiler to measures the time passed in sections of the engine in the scene.

  Parameters

  • onProfilerStopped: ((oldProfiler) => void)

    Function to be called when the profiler is stopped. Will be passed the profiler as argument.

    • • (oldProfiler): void

      • Parameters

        • oldProfiler: Profiler

        Returns void

  Returns void

stopProfiler

• stopProfiler(): void

• Stop the profiler being run on the scene.

  Returns void

unloadScene

• unloadScene(): void

• Called before a scene is removed from the stack of scenes rendered on the screen.

  Returns void

updateFromNetworkSyncData

• updateFromNetworkSyncData(syncData): void

• Parameters

  • syncData: LayoutNetworkSyncData

  Returns void