Class SpritesheetManifest

Hierarchy (View Summary)

ManifestBase<
    TSpritesheetLoaderTarget,
    TSpritesheetLoaderRawResource,
    SpritesheetLoaderResource,
>
- SpritesheetManifest

Index

Constructors

Properties

_data _resources

Accessors

Methods

_createLoader add cemit cemitAll clear destroyResources emit emitAll getAsync off on once

Constructors

constructor

new SpritesheetManifest(type: string): SpritesheetManifest
Parameters
- type: string
Returns SpritesheetManifest
Inherited from ManifestBase.constructor
- Defined in src/modules/content/ManifestBase.ts:43

Properties

`Protected`_data

_data: IResourceManagerManifest<TSpritesheetLoaderTarget> = {}

`Protected`_resources

_resources: Record<string, SpritesheetLoaderResource> = {}

Accessors

count

get count(): number
Returns number
Inherited from ManifestBase.count
- Defined in src/modules/content/ManifestBase.ts:62

Methods

`Protected`_createLoader

_createLoader(): SpritesheetLoader
Returns SpritesheetLoader
Overrides ManifestBase._createLoader
- Defined in src/modules/content/SpritesheetManifest.ts:5

add

add(
targets: Record<string, TSpritesheetLoaderTarget>,
options?: IManifestOption,
): void
Register targetss.
Parameters
- targets: Record<string, TSpritesheetLoaderTarget>
- options: IManifestOption = {}
Returns void
Inherited from ManifestBase.add
- Defined in src/modules/content/ManifestBase.ts:51

cemit

cemit(type: string, context: any, ...args: any[]): this
Emit event with specifying a context.
Parameters
- type: string
  Event type to emit.
- context: any
  Context to execute the callback.
- ...args: any[]
  Argument(s) in callback.
Returns this
Inherited from ManifestBase.cemit
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:43

cemitAll

cemitAll(context: any, ...args: any[]): this
Emit all events with specifying a context.
Parameters
- context: any
  Context to execute the callback.
- ...args: any[]
  Argument(s) in callback.
Returns this
Inherited from ManifestBase.cemitAll
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:57

clear

clear(type?: string): this
Remove events grouped event type.
Parameters
- Optionaltype: string
  Event type to remove. If it is empty, removes all events.
Returns this
Inherited from ManifestBase.clear
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:63

destroyResources

destroyResources(): void
Returns void
Inherited from ManifestBase.destroyResources
- Defined in src/modules/content/ManifestBase.ts:124

emit

emit(type: string, ...args: any[]): this
Emit event.
Parameters
- type: string
  Event type to emit.
- ...args: any[]
  Argument(s) in callback.
Returns this
Inherited from ManifestBase.emit
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:35

emitAll

emitAll(...args: any[]): this
Emit all events.
Parameters
- ...args: any[]
  Argument(s) in callback.
Returns this
Inherited from ManifestBase.emitAll
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:50

getAsync

getAsync(
options: IManifestLoaderOption,
): Promise<Record<string, ITextureDictionary>>
Get resources.
Parameters
- options: IManifestLoaderOption
Returns Promise<Record<string, ITextureDictionary>>
Inherited from ManifestBase.getAsync
- Defined in src/modules/content/ManifestBase.ts:69

off

off(type: string, callback: IEmitterDelegate): this
Unregister event.
Parameters
- type: string
  Event type.
- callback: IEmitterDelegate
  Registered callback.
Returns this
Inherited from ManifestBase.off
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:27

on

on(type: string, callback: IEmitterDelegate): this
Register event.
Parameters
- type: string
  Event type.
- callback: IEmitterDelegate
  Callback when the event fires.
Returns this
Inherited from ManifestBase.on
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:13

once

once(type: string, callback: IEmitterDelegate): this
Register one-time event.
Parameters
- type: string
  Event type.
- callback: IEmitterDelegate
  Callback when the event fires.
Returns this
Inherited from ManifestBase.once
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:20