Class Loader

Hierarchy

EventEmitter
- Loader

Index

Constructors

constructor

Methods

Constructors

constructor

new Loader(baseUrl?: string, concurrency?: number): Loader

Overrides EventEmitter.constructor
- Defined in node_modules/@types/pixi.js/index.d.ts:2143
Parameters
- Optional baseUrl: string
- Optional concurrency: number
Returns Loader

Properties

Protected _afterMiddleware

_afterMiddleware: Function[]

Protected _beforeMiddleware

_beforeMiddleware: Function[]

Protected _boundLoadResource

_boundLoadResource: function

Type declaration

- (r: Resource, d: Function): void
- Parameters
  - r: Resource
  - d: Function
  Returns void

Protected _queue

_queue: any

Protected _resourcesParsing

_resourcesParsing: Resource[]

baseUrl

baseUrl: string

defaultQueryString

defaultQueryString: string

loading

loading: boolean

onComplete

onComplete: MiniSignal

onError

onError: MiniSignal

onLoad

onLoad: MiniSignal

onProgress

onProgress: MiniSignal

onStart

onStart: MiniSignal

progress

progress: number

resources

resources: ResourceDictionary

Static EventEmitter

EventEmitter: object

Type declaration

constructor: function
- new __type(): EventEmitter
- - Defined in node_modules/@types/pixi.js/index.d.ts:2810
  Returns EventEmitter
prefixed: string | boolean

Static Resource

Resource: any

Static async

async: any

Static base64

base64: any

Static prefixed

prefixed: string | boolean

Methods

Protected _loadResource

_loadResource(resource: Resource, dequeue: Function): void

- Defined in node_modules/@types/pixi.js/index.d.ts:2185
Parameters
- resource: Resource
- dequeue: Function
Returns void

Protected _onComplete

_onComplete(): void

- Defined in node_modules/@types/pixi.js/index.d.ts:2186
Returns void

Protected _onLoad

_onLoad(resource: Resource): void

- Defined in node_modules/@types/pixi.js/index.d.ts:2187
Parameters
- resource: Resource
Returns void

Protected _prepareUrl

_prepareUrl(url: string): string

- Defined in node_modules/@types/pixi.js/index.d.ts:2183
Parameters
- url: string
Returns string

add

add(...params: any[]): this
add(name: string, url: string, options?: LoaderOptions, cb?: Function): this
add(obj: string | any | any[], options?: LoaderOptions, cb?: Function): this

- Defined in node_modules/@types/pixi.js/index.d.ts:2169
Parameters
- Rest ...params: any[]
Returns this
- Defined in node_modules/@types/pixi.js/index.d.ts:2171
Parameters
- name: string
- url: string
- Optional options: LoaderOptions
- Optional cb: Function
Returns this
- Defined in node_modules/@types/pixi.js/index.d.ts:2173
Parameters
- obj: string | any | any[]
- Optional options: LoaderOptions
- Optional cb: Function
Returns this

addListener

addListener(event: string | symbol, fn: Function, context?: any): this

Inherited from EventEmitter.addListener
- Defined in node_modules/@types/pixi.js/index.d.ts:2900
Alias method for on

Parameters
- event: string | symbol
- fn: Function
- Optional context: any
Returns this

destroy

destroy(): void

- Defined in node_modules/@types/pixi.js/index.d.ts:2189
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit
- Defined in node_modules/@types/pixi.js/index.d.ts:2852
Calls each of the listeners registered for a given event.

Parameters
- event: string | symbol
  
  The event name.
- Rest ...args: any[]
  
  Arguments that are passed to registered listeners
Returns boolean

true if the event had listeners, else false.

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/pixi.js/index.d.ts:2827
Return an array listing the events for which the emitter has registered listeners.

Returns Array<string | symbol>

listeners

listeners(event: string | symbol): Function[]
listeners(event: string | symbol, exists: boolean): boolean

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/pixi.js/index.d.ts:2835
Return the listeners registered for a given event.

Parameters
- event: string | symbol
  
  The event name.
Returns Function[]
Inherited from EventEmitter.listeners
- Defined in node_modules/@types/pixi.js/index.d.ts:2844
Check if there listeners for a given event. If exists argument is not true lists listeners.

Parameters
- event: string | symbol
  
  The event name.
- exists: boolean
  
  Only check if there are listeners.
Returns boolean

load

load(cb?: Function): this

- Defined in node_modules/@types/pixi.js/index.d.ts:2181
Parameters
- Optional cb: Function
Returns this

off

off(event: "complete" | "error" | "load" | "progress" | "start" | string, fn?: Function, context?: any): this

Overrides EventEmitter.off
- Defined in node_modules/@types/pixi.js/index.d.ts:2203
Parameters
- event: "complete" | "error" | "load" | "progress" | "start" | string
- Optional fn: Function
- Optional context: any
Returns this

on

on(event: "complete", fn: function, context?: any): this
on(event: "error", fn: function, context?: any): this
on(event: "load" | "progress", fn: function, context?: any): this
on(event: "start", fn: function, context?: any): this

Overrides EventEmitter.on
- Defined in node_modules/@types/pixi.js/index.d.ts:2193
Parameters
- event: "complete"
- fn: function
  - - (loader: Loader, object: any): void
    - Parameters
      - loader: Loader
      - object: any
      Returns void
- Optional context: any
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/pixi.js/index.d.ts:2194
Parameters
- event: "error"
- fn: function
  - - (error: Error, loader: Loader, resource: Resource): void
    - Parameters
      - error: Error
      - loader: Loader
      - resource: Resource
      Returns void
- Optional context: any
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/pixi.js/index.d.ts:2195
Parameters
- event: "load" | "progress"
- fn: function
  - - (loader: Loader, resource: Resource): void
    - Parameters
      - loader: Loader
      - resource: Resource
      Returns void
- Optional context: any
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/pixi.js/index.d.ts:2196
Parameters
- event: "start"
- fn: function
  - - (loader: Loader): void
    - Parameters
      - loader: Loader
      Returns void
- Optional context: any
Returns this

once

once(event: "complete", fn: function, context?: any): this
once(event: "error", fn: function, context?: any): this
once(event: "load" | "progress", fn: function, context?: any): this
once(event: "start", fn: function, context?: any): this

Overrides EventEmitter.once
- Defined in node_modules/@types/pixi.js/index.d.ts:2198
Parameters
- event: "complete"
- fn: function
  - - (loader: Loader, object: any): void
    - Parameters
      - loader: Loader
      - object: any
      Returns void
- Optional context: any
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/pixi.js/index.d.ts:2199
Parameters
- event: "error"
- fn: function
  - - (error: Error, loader: Loader, resource: Resource): void
    - Parameters
      - error: Error
      - loader: Loader
      - resource: Resource
      Returns void
- Optional context: any
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/pixi.js/index.d.ts:2200
Parameters
- event: "load" | "progress"
- fn: function
  - - (loader: Loader, resource: Resource): void
    - Parameters
      - loader: Loader
      - resource: Resource
      Returns void
- Optional context: any
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/pixi.js/index.d.ts:2201
Parameters
- event: "start"
- fn: function
  - - (loader: Loader): void
    - Parameters
      - loader: Loader
      Returns void
- Optional context: any
Returns this

pre

pre(fn: Function): this

- Defined in node_modules/@types/pixi.js/index.d.ts:2176
Parameters
- fn: Function
Returns this

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/pixi.js/index.d.ts:2890
Remove all listeners, or those of the specified event.

Parameters
- Optional event: string | symbol
  
  The event name.
Returns this

this.

removeListener

removeListener(event: string | symbol, fn?: Function, context?: any, once?: boolean): this

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/pixi.js/index.d.ts:2883
Remove the listeners of a given event.

Parameters
- event: string | symbol
  
  The event name.
- Optional fn: Function
  
  Only remove the listeners that match this function.
- Optional context: any
  
  Only remove the listeners that have this context.
- Optional once: boolean
  
  Only remove one-time listeners.
Returns this

this.

reset

reset(): this

- Defined in node_modules/@types/pixi.js/index.d.ts:2179
Returns this

setMaxListeners

setMaxListeners(): this

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/pixi.js/index.d.ts:2905
This function doesn't apply anymore.

deprecated

Returns this

use

use(fn: Function): this

- Defined in node_modules/@types/pixi.js/index.d.ts:2178
Parameters
- fn: Function
Returns this

Static addPixiMiddleware

addPixiMiddleware(fn: Function): void

- Defined in node_modules/@types/pixi.js/index.d.ts:2137
Parameters
- fn: Function
Returns void

Generated using TypeDoc