Interface Live2DRuntime

Represents a Cubism version.

Hierarchy

Live2DRuntime

Index

Properties

Methods

createCoreModel createInternalModel createModelSettings createPhysics createPose isValidMoc ready test

Properties

version

version: number

The version number. Higher version takes priority when matching the runtime.

Methods

createCoreModel

createCoreModel(data: ArrayBuffer): any
Creates a core model.

Returns
Created core model.
Parameters
- data: ArrayBuffer
  
  Content of the moc file.
Returns any
- Defined in src/factory/Live2DFactory.ts:85

createInternalModel

createInternalModel(coreModel: any, settings: ModelSettings, options?: Live2DFactoryOptions): InternalModel
Creates an InternalModel.

Returns
Created InternalModel.
Parameters
- coreModel: any
  
  Core model that must belong to this runtime.
- settings: ModelSettings
  
  ModelSettings of this model.
- Optional options: Live2DFactoryOptions
  
  Options that will be passed to the InternalModel's constructor.
Returns InternalModel
- Defined in src/factory/Live2DFactory.ts:94

createModelSettings

createModelSettings(json: object): ModelSettings
Creates a ModelSettings.

Returns
Created ModelSettings.
Parameters
- json: object
  
  The settings JSON object.
Returns ModelSettings
- Defined in src/factory/Live2DFactory.ts:78

createPhysics

createPhysics(coreModel: any, data: any): any
Creates a physics.

Returns
Created physics.
Parameters
- coreModel: any
  
  Core model that must belong to this runtime.
- data: any
  
  Content of the physics file.
Returns any
- Defined in src/factory/Live2DFactory.ts:110

createPose

createPose(coreModel: any, data: any): any
Creates a pose.

Returns
Created pose.
Parameters
- coreModel: any
  
  Core model that must belong to this runtime.
- data: any
  
  Content of the pose file.
Returns any
- Defined in src/factory/Live2DFactory.ts:102

isValidMoc

isValidMoc(modelData: ArrayBuffer): boolean
Checks if the data is a valid moc to create the core model.

Returns
True if the data is valid.
Parameters
- modelData: ArrayBuffer
  
  The moc content.
Returns boolean
- Defined in src/factory/Live2DFactory.ts:71

ready

ready(): Promise<void>
Returns Promise<void>
- Defined in src/factory/Live2DFactory.ts:64

test

test(source: any): boolean
Checks if the source belongs to this runtime.

Returns
True if the source belongs to this runtime.
Parameters
- source: any
  
  Either a settings JSON object or a ModelSettings instance.
Returns boolean
- Defined in src/factory/Live2DFactory.ts:61

Generated using TypeDoc