LoaderAgent | g.frame

param: string is used for getting this type of Loader later on from the ResourcesManagerClass, and adding new ResourceRaw

Hierarchy

Loader<any>
- LoaderAgent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new LoaderAgent(loaders: Array<Loader<any>>): LoaderAgent

Overrides Loader.constructor
- Defined in packages/g.frame.common.loaders/src/LoaderAgent.ts:9
Parameters
- loaders: Array<Loader<any>>
Returns LoaderAgent

Properties

__agentConstructor

__agentConstructor: Function

Protected library

library: Map<string, any> = new Map<string, T>()

loaderType

loaderType: string

Protected resourcesRaw

resourcesRaw: Array<ResourceRaw> = []

Methods

addResources

addResources(newResources: Array<ResourceRaw>): boolean

Overrides Loader.addResources
- Defined in packages/g.frame.common.loaders/src/LoaderAgent.ts:19
Parameters
- newResources: Array<ResourceRaw>
  
  ResourceRaw new items that will be added to library once .load() passes through
Returns boolean

boolean based on if the resource type is supported for the Loader, name and url exist. Defines if is it added to resourcesRaw Array

getLoader

getLoader(type: string): Loader<any>

- Defined in packages/g.frame.common.loaders/src/LoaderAgent.ts:74
Parameters
- type: string
  
  string - key for the loaders Map
Returns Loader<any>

loader according to provided type

getResource

getResource<T>(name: string): T

Overrides Loader.getResource
- Defined in packages/g.frame.common.loaders/src/LoaderAgent.ts:59
USE THIS FUNCTION TO GET READY RESOURCES

Type parameters
- T
  
  is the class that Loader will return on .getResource
Parameters
- name: string
  
  string Resource name to get
Returns T

resource with the provided name, or undefined if none was found

load

load(): Promise<void>

Overrides Loader.load
- Defined in packages/g.frame.common.loaders/src/LoaderAgent.ts:38
Returns Promise<void>

Promise that executes after all raw resources was loaded according to resourceToPromise

Protected resourceToPromise

resourceToPromise(url: string, name: string): Promise<any>

Inherited from Loader.resourceToPromise
- Defined in packages/g.frame.common.loaders/src/Loader.ts:96
MODIFY THIS IN EXTENDED CLASS TO LOAD RESOURCES PROPERLY You can look for ModelsLoader|AudiosLoader|FontsLoader and find an example there

Parameters
- url: string
  
  string path that leads to the file
- name: string
  
  string resource name to set
Returns Promise<any>

resource Promise with new resource

Protected setResource

setResource(name: string, resource: any): void

Inherited from Loader.setResource
- Defined in packages/g.frame.common.loaders/src/Loader.ts:85
Parameters
- name: string
  
  string Resource name to set
- resource: any
  
  to set to library of loaded resources
Returns void

resource with the provided name, or undefined if none was found

Generated using TypeDoc