Class Content

Hierarchy

Emitter
- Content

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new Content(options?: IContentOption, piximData?: IContentStaticData): Content

Overrides Emitter.constructor
- Defined in src/modules/content/Content.ts:121
Parameters
- options: IContentOption = {}
- piximData: IContentStaticData = ...
Returns Content

Properties

Private _loadedResourceHandler

_loadedResourceHandler: (data: { resource: any; target: any }) => void

Type declaration

- (data: { resource: any; target: any }): void
- Parameters
  - data: { resource: any; target: any }
    - resource: any
    - target: any
  Returns void

Protected _piximData

_piximData: IContentData

Static Protected _piximData

_piximData: IContentStaticData

Accessors

assetCount

get assetCount(): number

- Defined in src/modules/content/Content.ts:451
Returns number

classAssetCount

get classAssetCount(): number

- Defined in src/modules/content/Content.ts:429
Returns number

contentID

get contentID(): string

- Defined in src/modules/content/Content.ts:281
ID of this content.

Returns string

instanceAssetCount

get instanceAssetCount(): number

- Defined in src/modules/content/Content.ts:440
Returns number

Methods

Private _loadAssetAsync

_loadAssetAsync(manifests: IContentManifests): Promise<void>

- Defined in src/modules/content/Content.ts:458
fires

[[LoaderBase.EVENT_LOADER_ASSET_LOADED]]

Parameters
- manifests: IContentManifests
Returns Promise<void>

addImages

addImages(data: ITextureManifestTargetDictionary, options?: IManifestOption): Content

- Defined in src/modules/content/Content.ts:306
Define image assets for instance.

Parameters
- data: ITextureManifestTargetDictionary
- options: IManifestOption = {}
Returns Content

Returns itself for the method chaining.

addJsons

addJsons(targets: IJsonManifestTargetDictionary, options?: IManifestOption): Content

- Defined in src/modules/content/Content.ts:333
Define json assets for instance.

Parameters
- targets: IJsonManifestTargetDictionary
- options: IManifestOption = {}
Returns Content

Returns itself for the method chaining.

addSounds

addSounds(targets: ISoundManifestTargetDictionary, options?: IManifestOption): Content

- Defined in src/modules/content/Content.ts:324
Define sound assets for instance.

Parameters
- targets: ISoundManifestTargetDictionary
- options: IManifestOption = {}
Returns Content

Returns itself for the method chaining.

addSpritesheets

addSpritesheets(targets: ISpritesheetManifestTargetDictionary, options?: IManifestOption): Content

- Defined in src/modules/content/Content.ts:315
Define spritesheet assets for instance.

Parameters
- targets: ISpritesheetManifestTargetDictionary
- options: IManifestOption = {}
Returns Content

Returns itself for the method chaining.

addTargets

addTargets<T>(key: string, targets: IManifestTargetDictionary<T>, options?: IManifestOption): Content

- Defined in src/modules/content/Content.ts:290
Define assets for instance.

Type parameters
- T
Parameters
- key: string
- targets: IManifestTargetDictionary<T>
- options: IManifestOption = {}
Returns Content

Returns itself for the method chaining.

addVars

addVars(data: IVariableDictionary): Content

- Defined in src/modules/content/Content.ts:342
Define valriables for instance.

Parameters
- data: IVariableDictionary
Returns Content

Returns itself for the method chaining.

buildAsync

buildAsync(): Promise<Container>

- Defined in src/modules/content/Content.ts:363
Build content.

Returns Promise<Container>

cemit

cemit(type: string, context: any, ...args: any[]): Content

Inherited from Emitter.cemit
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:43
Emit event with specifying a context.

Parameters
- type: string
  
  Event type to emit.
- context: any
  
  Context to execute the callback.
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns Content

cemitAll

cemitAll(context: any, ...args: any[]): Content

Inherited from Emitter.cemitAll
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:57
Emit all events with specifying a context.

Parameters
- context: any
  
  Context to execute the callback.
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns Content

clear

clear(type?: string): Content

Inherited from Emitter.clear
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:63
Remove events grouped event type.

Parameters
- Optional type: string
  
  Event type to remove. If it is empty, removes all events.
Returns Content

destroy

destroy(): void

- Defined in src/modules/content/Content.ts:406
Returns void

emit

emit(type: string, ...args: any[]): Content

Inherited from Emitter.emit
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:35
Emit event.

Parameters
- type: string
  
  Event type to emit.
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns Content

emitAll

emitAll(...args: any[]): Content

Inherited from Emitter.emitAll
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:50
Emit all events.

Parameters
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns Content

off

off(type: string, callback: IEmitterDelegate): Content

Inherited from Emitter.off
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:27
Unregister event.

Parameters
- type: string
  
  Event type.
- callback: IEmitterDelegate
  
  Registered callback.
Returns Content

on

on(type: string, callback: IEmitterDelegate): Content

Inherited from Emitter.on
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:13
Register event.

Parameters
- type: string
  
  Event type.
- callback: IEmitterDelegate
  
  Callback when the event fires.
Returns Content

once

once(type: string, callback: IEmitterDelegate): Content

Inherited from Emitter.once
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:20
Register one-time event.

Parameters
- type: string
  
  Event type.
- callback: IEmitterDelegate
  
  Callback when the event fires.
Returns Content

preloadClassAssetAsync

preloadClassAssetAsync(): Promise<void>

- Defined in src/modules/content/Content.ts:377
Preloads class assets.

Returns Promise<void>

preloadInstanceAssetAsync

preloadInstanceAssetAsync(): Promise<void>

- Defined in src/modules/content/Content.ts:393
Preloads instance assets.

Returns Promise<void>

prepareAsync

prepareAsync(): Promise<void>

- Defined in src/modules/content/Content.ts:353
Prepare content.

Returns Promise<void>

Static create

create(key?: string): typeof Content

- Defined in src/modules/content/Content.ts:171
Create a cloned content class.

Parameters
- key: string = ''
  
  Content name.
Returns typeof Content

Cloned content class.

Static defineImages

defineImages(targets: ITextureManifestTargetDictionary, options?: IManifestOption): typeof Content

- Defined in src/modules/content/Content.ts:225
Define image assets for class.

Parameters
- targets: ITextureManifestTargetDictionary
- options: IManifestOption = {}
Returns typeof Content

Static defineJsons

defineJsons(targets: IJsonManifestTargetDictionary, options?: IManifestOption): typeof Content

- Defined in src/modules/content/Content.ts:246
Define json assets for class.

Parameters
- targets: IJsonManifestTargetDictionary
- options: IManifestOption = {}
Returns typeof Content

Static defineLibraries

defineLibraries(data: IContentLibrary): typeof Content

- Defined in src/modules/content/Content.ts:270
Define libraries that is material of the content.
In the constructor named root, Application passes a reference to ContentDeliver as an argument.
By giving this argument to the child further, you will be able to access the data freely from anywhere.

Parameters
- data: IContentLibrary
  
  Library data.
Returns typeof Content

Static defineSounds

defineSounds(targets: ISoundManifestTargetDictionary, options?: IManifestOption): typeof Content

- Defined in src/modules/content/Content.ts:239
Define sound assets for class.

Parameters
- targets: ISoundManifestTargetDictionary
- options: IManifestOption = {}
Returns typeof Content

Static defineSpritesheets

defineSpritesheets(targets: ISpritesheetManifestTargetDictionary, options?: IManifestOption): typeof Content

- Defined in src/modules/content/Content.ts:232
Define spritesheet assets for class.

Parameters
- targets: ISpritesheetManifestTargetDictionary
- options: IManifestOption = {}
Returns typeof Content

Static defineTargets

defineTargets<T>(key: string, targets: IManifestTargetDictionary<T>, options?: IManifestOption): typeof Content

- Defined in src/modules/content/Content.ts:211
Define assets for class.

Type parameters
- T
Parameters
- key: string
- targets: IManifestTargetDictionary<T>
- options: IManifestOption = {}
Returns typeof Content

Static get

get(key: string): typeof Content

- Defined in src/modules/content/Content.ts:194
Get cloned content.

Parameters
- key: string
Returns typeof Content

Static registerManifest

registerManifest(key: string, Manifest: IManifestClass): void

- Defined in src/modules/content/Content.ts:161
Register manifest class.

Parameters
- key: string
- Manifest: IManifestClass
Returns void

Static remove

remove(key: string): void

- Defined in src/modules/content/Content.ts:204
Remove cloned content.

function

Pixim.Content.removeContent

Parameters
- key: string
Returns void

Static setConfig

setConfig(data: IContentConfigData): typeof Content

- Defined in src/modules/content/Content.ts:255
Set the content settings.

Parameters
- data: IContentConfigData
  
  Config data.
Returns typeof Content

Generated using TypeDoc