Loader | g.frame

Type parameters

T

Hierarchy

any
- Loader

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Loader(_loaderType?: string): Loader

- Defined in packages/g.frame.common.loaders/src/Loader.ts:18
Parameters
- Optional _loaderType: string
Returns Loader

Properties

__agentConstructor

__agentConstructor: Function

Protected library

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

loaderType

loaderType: string

Protected resourcesRaw

resourcesRaw: Array<ResourceRaw> = []

Methods

addResources

addResources(newResource: Array<ResourceRaw> | ResourceRaw): boolean

- Defined in packages/g.frame.common.loaders/src/Loader.ts:30
Parameters
- newResource: Array<ResourceRaw> | 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

getResource

getResource<C>(name: string, _throwWarning?: boolean): C

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

Type parameters
- C: T
Parameters
- name: string
  
  string Resource name to get
- Default value _throwWarning: boolean = true
  
  boolean
Returns C

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

load

load(): Promise<void>

- Defined in packages/g.frame.common.loaders/src/Loader.ts:46
Returns Promise<void>

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

Protected resourceToPromise

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

- 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<T>

resource Promise with new resource

Protected setResource

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

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

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

Generated using TypeDoc