Class ImageLibraryService

ImageService provides a library of image objects that can be used at any time.

Index

Constructors

Methods

getImageAsTexture getSprite getVideo loadAssets

Constructors

constructor

new ImageLibraryService(config): ImageLibraryService
Create the service by loading all of the game's image files
Parameters
- config: JetLagGameConfig
  The game-wide configuration
Returns ImageLibraryService
- Defined in Services/ImageLibrary.ts:144

Methods

getImageAsTexture

getImageAsTexture(imgName): Texture<Resource>
Get an image that has been loaded by the renderer, returning it as a raw Pixi Texture
Parameters
- imgName: string
  The name of the image to load
Returns Texture<Resource>
A Texture built from the image
- Defined in Services/ImageLibrary.ts:175

getSprite

getSprite(imgName): Sprite
Get an image that has been loaded by the renderer
Parameters
- imgName: string
  The name of the image to load
Returns Sprite
A Sprite built from the image
- Defined in Services/ImageLibrary.ts:159

getVideo

getVideo(vidName): Sprite
Get a video that has been loaded by the renderer
Parameters
- vidName: string
  The name of the video to load
Returns Sprite
A Sprite built from the video
- Defined in Services/ImageLibrary.ts:188

loadAssets

loadAssets(callback): void
Load all of the graphics assets, then call the callback to start the game
Parameters
- callback: (() => void)
  The code to run once all assets are loaded
  - - (): void
    - Returns void
Returns void
- Defined in Services/ImageLibrary.ts:91