Class ResourceLoader

Pre-load resources of any kind needed for a game or a scene.

Constructors

constructor

Properties

currentLoadingSceneName currentSceneLoadingProgress

Methods

areSceneAssetsLoaded areSceneAssetsReady checkIfCredentialsRequired dispose getBitmapFontManager getFontManager getFullUrl getImageManager getJsonManager getModel3DManager getResource getRuntimeGame getSceneLoadingProgress getSoundManager getSpineAtlasManager getSpineManager injectMockResourceManagerForTesting loadAllResources loadAllSceneInBackground loadAndProcessSceneResources loadGlobalAndFirstSceneResources loadSceneResources setResources unloadSceneResources

Constructors

constructor

  • new ResourceLoader(runtimeGame, resourceDataArray, globalResources, layoutDataArray): ResourceLoader

  • Parameters

    • runtimeGame: RuntimeGame

      The game.

    • resourceDataArray: ResourceData[]

      The resources data of the game.

    • globalResources: string[]

      The resources needed for any scene.

    • layoutDataArray: LayoutData[]

      The resources used by each scene.

    Returns ResourceLoader

Properties

Private currentLoadingSceneName

currentLoadingSceneName: string = ''

The name of the scene for which resources are currently being loaded.

Private currentSceneLoadingProgress

currentSceneLoadingProgress: number = 0

The progress, between 0 and 1, of the loading of the resource, for the scene that is being loaded (see currentLoadingSceneName).

Methods

areSceneAssetsLoaded

  • areSceneAssetsLoaded(sceneName): boolean

  • Parameters

    • sceneName: string

    Returns boolean

    true when all the resources of the given scene are loaded (but maybe not parsed).

areSceneAssetsReady

  • areSceneAssetsReady(sceneName): boolean

  • Parameters

    • sceneName: string

    Returns boolean

    true when all the resources of the given scene are loaded and parsed.

checkIfCredentialsRequired

  • checkIfCredentialsRequired(url): boolean

  • Return true if the specified URL must be loaded with cookies ("credentials") sent to grant access to them.

    Parameters

    • url: string

    Returns boolean

dispose

getBitmapFontManager

getFontManager

getFullUrl

  • getFullUrl(url): string

  • Complete the given URL with any specific parameter required to access the resource (this can be for example a token needed to access the resource).

    Parameters

    • url: string

    Returns string

getImageManager

getJsonManager

getModel3DManager

getResource

getRuntimeGame

getSceneLoadingProgress

getSoundManager

getSpineAtlasManager

getSpineManager

injectMockResourceManagerForTesting

loadAllResources

  • loadAllResources(onProgress): Promise<void>

  • Parameters

    • onProgress: ((loadingCount, totalCount) => void)
        • (loadingCount, totalCount): void

        • Parameters

          • loadingCount: number
          • totalCount: number

          Returns void

    Returns Promise<void>

loadAllSceneInBackground

  • loadAllSceneInBackground(): Promise<void>

  • Load each scene in order.

    This is done in background to try to avoid loading screens when changing scenes.

    Returns Promise<void>

loadAndProcessSceneResources

  • loadAndProcessSceneResources(sceneName, onProgress?): Promise<void>

  • Load and process a scene that is needed right away.

    The renderer will show a loading screen while its done.

    Parameters

    • sceneName: string
    • Optional onProgress: ((count, total) => Promise<void>)
        • (count, total): Promise<void>

        • Parameters

          • count: number
          • total: number

          Returns Promise<void>

    Returns Promise<void>

loadGlobalAndFirstSceneResources

  • loadGlobalAndFirstSceneResources(firstSceneName, onProgress): Promise<void>

  • Load the resources that are needed to launch the first scene.

    Parameters

    • firstSceneName: string
    • onProgress: ((count, total) => void)
        • (count, total): void

        • Parameters

          • count: number
          • total: number

          Returns void

    Returns Promise<void>

loadSceneResources

  • loadSceneResources(sceneName, onProgress?): Promise<void>

  • Load a scene resources without parsing them.

    When another scene resources are loading in background, it waits for all its resources to be loaded before loading resources of the given scene.

    Parameters

    • sceneName: string
    • Optional onProgress: ((count, total) => void)
        • (count, total): void

        • Parameters

          • count: number
          • total: number

          Returns void

    Returns Promise<void>

setResources

  • setResources(resourceDataArray, globalResources, layoutDataArray): void

  • Update the resources data of the game. Useful for hot-reloading, should not be used otherwise.

    Parameters

    • resourceDataArray: ResourceData[]
    • globalResources: string[]
    • layoutDataArray: LayoutData[]

    Returns void

unloadSceneResources

  • unloadSceneResources(__namedParameters): void

  • To be called when a scene is unloaded.

    Parameters

    • __namedParameters: {
          newSceneName: null | string;
          unloadedSceneName: string;
      }
      • newSceneName: null | string
      • unloadedSceneName: string

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcurrentLoadingSceneNamecurrentSceneLoadingProgressareSceneAssetsLoadedareSceneAssetsReadycheckIfCredentialsRequireddisposegetBitmapFontManagergetFontManagergetFullUrlgetImageManagergetJsonManagergetModel3DManagergetResourcegetRuntimeGamegetSceneLoadingProgressgetSoundManagergetSpineAtlasManagergetSpineManagerinjectMockResourceManagerForTestingloadAllResourcesloadAllSceneInBackgroundloadAndProcessSceneResourcesloadGlobalAndFirstSceneResourcesloadSceneResourcessetResourcesunloadSceneResources