Class SceneStack

Hold the stack of scenes (gdjs.RuntimeScene) being played.

Index

Constructors

Methods

applyUpdateFromNetworkSyncDataIfAny dispose getAllSceneNames getCurrentScene getNetworkSyncData onGameResolutionResized pop push renderWithoutStep replace step updateFromNetworkSyncData wasFirstSceneLoaded

Constructors

constructor

new SceneStack(runtimeGame): SceneStack
Parameters
- runtimeGame: RuntimeGame
  The runtime game that is using the scene stack
Returns SceneStack
- Defined in GDJS/Runtime/scenestack.ts:19

Methods

applyUpdateFromNetworkSyncDataIfAny

applyUpdateFromNetworkSyncDataIfAny(): boolean
Returns boolean
- Defined in GDJS/Runtime/scenestack.ts:262

dispose

dispose(): void
Unload all the scenes and clear the stack.

Returns void
- Defined in GDJS/Runtime/scenestack.ts:374

getAllSceneNames

getAllSceneNames(): string[]
Returns string[]
- Defined in GDJS/Runtime/scenestack.ts:222

getCurrentScene

getCurrentScene(): null | RuntimeScene
Return the current gdjs.RuntimeScene being played, or null if none is run.

Returns null | RuntimeScene
- Defined in GDJS/Runtime/scenestack.ts:207

getNetworkSyncData

getNetworkSyncData(syncOptions): null | SceneStackNetworkSyncData
Parameters
- syncOptions: GetNetworkSyncDataOptions
Returns null | SceneStackNetworkSyncData
- Defined in GDJS/Runtime/scenestack.ts:227

onGameResolutionResized

onGameResolutionResized(): void
Called by the RuntimeGame when the game resolution is changed. Useful to notify scene and layers that resolution is changed, as they might be caching it.

Returns void
- Defined in GDJS/Runtime/scenestack.ts:31

pop

pop(popCount?): void
Parameters
- popCount: number = 1
Returns void
- Defined in GDJS/Runtime/scenestack.ts:89

push

push(newSceneName, externalLayoutName?): null | RuntimeScene
Pause the scene currently being played and start the new scene that is specified. If externalLayoutName is set, also instantiate the objects from this external layout.
Parameters
- newSceneName: string
- Optional externalLayoutName: string
Returns null | RuntimeScene
- Defined in GDJS/Runtime/scenestack.ts:120

renderWithoutStep

renderWithoutStep(): boolean
Returns boolean
- Defined in GDJS/Runtime/scenestack.ts:78

replace

replace(newSceneName, clear?): null | RuntimeScene
Start the specified scene, replacing the one currently being played. If clear is set to true, all running scenes are also removed from the stack of scenes.
Parameters
- newSceneName: string
- Optional clear: boolean
Returns null | RuntimeScene
- Defined in GDJS/Runtime/scenestack.ts:182

step

step(elapsedTime): boolean
Parameters
- elapsedTime: number
Returns boolean
- Defined in GDJS/Runtime/scenestack.ts:37

updateFromNetworkSyncData

updateFromNetworkSyncData(sceneStackSyncData): void
Parameters
- sceneStackSyncData: SceneStackNetworkSyncData
Returns void
- Defined in GDJS/Runtime/scenestack.ts:252

wasFirstSceneLoaded

wasFirstSceneLoaded(): boolean
Return true if a scene was loaded, false otherwise (i.e: game not yet started).

Returns boolean
- Defined in GDJS/Runtime/scenestack.ts:218