Class HotReloader

Reload scripts/data of an exported game and applies the changes to the running runtime game.

Index

Constructors

Methods

assignOrDelete deepEqual hotReload hotReloadRuntimeInstances hotReloadRuntimeSceneLayers hotReloadRuntimeSceneObjects indexByName indexByPersistentUuid reloadScriptFiles resolveCustomObjectConfigurations

Constructors

constructor

new HotReloader(runtimeGame): HotReloader
Parameters
- runtimeGame: RuntimeGame
  The gdjs.RuntimeGame to be hot-reloaded.
Returns HotReloader
- Defined in GDJS/Runtime/debugger-client/hot-reloader.ts:27

Methods

`Static` assignOrDelete

assignOrDelete(target, source, ignoreKeys?): void
Parameters
- target: any
- source: any
- ignoreKeys: string[] = []
Returns void
- Defined in GDJS/Runtime/debugger-client/hot-reloader.ts:1954

`Static` deepEqual

deepEqual(a, b): boolean
Deep check equality between the two objects/arrays/primitives.

Inspired from https://github.com/epoberezkin/fast-deep-equal
Parameters
- a: any
  The first object/array/primitive to compare
- b: any
  The second object/array/primitive to compare
Returns boolean
- Defined in GDJS/Runtime/debugger-client/hot-reloader.ts:1904

hotReload

hotReload(__namedParameters): Promise<HotReloaderLog[]>
Parameters
- __namedParameters: {
      projectData: ProjectData;
      runtimeGameOptions: RuntimeGameOptions;
      shouldReloadResources: boolean;
  }
  - projectData: ProjectData
  - runtimeGameOptions: RuntimeGameOptions
  - shouldReloadResources: boolean
Returns Promise<HotReloaderLog[]>
- Defined in GDJS/Runtime/debugger-client/hot-reloader.ts:147

hotReloadRuntimeInstances

hotReloadRuntimeInstances(oldInstances, newInstances, runtimeInstanceContainer): void
Parameters
- oldInstances: InstanceData[]
- newInstances: InstanceData[]
- runtimeInstanceContainer: RuntimeInstanceContainer
Returns void
- Defined in GDJS/Runtime/debugger-client/hot-reloader.ts:1557

hotReloadRuntimeSceneLayers

hotReloadRuntimeSceneLayers(newLayers, runtimeInstanceContainer): void
Parameters
- newLayers: LayerData[]
- runtimeInstanceContainer: RuntimeInstanceContainer
Returns void
- Defined in GDJS/Runtime/debugger-client/hot-reloader.ts:1324

hotReloadRuntimeSceneObjects

hotReloadRuntimeSceneObjects(updatedObjects, runtimeInstanceContainer): void
Parameters
- updatedObjects: ObjectData[]
- runtimeInstanceContainer: RuntimeInstanceContainer
Returns void
- Defined in GDJS/Runtime/debugger-client/hot-reloader.ts:995

`Static` indexByName

indexByName<E>(objectsWithName): Map<string, E>
Type Parameters
- E extends {
  name: null | string;
  }
Parameters
- objectsWithName: E[]
Returns Map<string, E>
- Defined in GDJS/Runtime/debugger-client/hot-reloader.ts:44

`Static` indexByPersistentUuid

indexByPersistentUuid<ObjectWithPersistentId>(objectsWithPersistentId): Map<string, ObjectWithPersistentId>
Type Parameters
- ObjectWithPersistentId extends {
  persistentUuid: null | string;
  }
Parameters
- objectsWithPersistentId: ObjectWithPersistentId[]
Returns Map<string, ObjectWithPersistentId>
- Defined in GDJS/Runtime/debugger-client/hot-reloader.ts:31

reloadScriptFiles

reloadScriptFiles(newProjectData, oldScriptFiles, newScriptFiles, shouldGenerateScenesEventsCode): Promise<void[]>
Parameters
- newProjectData: ProjectData
- oldScriptFiles: RuntimeGameOptionsScriptFile[]
- newScriptFiles: RuntimeGameOptionsScriptFile[]
- shouldGenerateScenesEventsCode: boolean
Returns Promise<void[]>
- Defined in GDJS/Runtime/debugger-client/hot-reloader.ts:319

`Static` resolveCustomObjectConfigurations

resolveCustomObjectConfigurations(projectData, objectDatas): ObjectData[]
Add the children object data into every custom object data.

At the runtime, this is done at the object instantiation. For hot-reloading, it's done before hands to optimize.
Parameters
- projectData: ProjectData
  The project data
- objectDatas: ObjectData[]
  The object datas to modify
Returns ObjectData[]
- Defined in GDJS/Runtime/debugger-client/hot-reloader.ts:746