Interface: Live2DFactoryOptions

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4045

Extends

• Live2DModelOptions

Extended by

• Live2DOptions

Properties

anchorMode?

> optional anchorMode?: "canvas" | "drawable"

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4293

Defines which bounds are used to resolve the normalized Live2DModel.anchor. 'canvas' preserves the historical model-canvas behavior, while 'drawable' resolves the anchor against the visible drawable bounds.

Default

'canvas'

Inherited from

Live2DModelOptions.anchorMode

autoFocus?

> optional autoFocus?: boolean

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4238

Automatically update the focus position when globalpointermove event is triggered.

Default

true

Inherited from

Live2DModelOptions.autoFocus

autoHitTest?

> optional autoHitTest?: boolean

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4233

Automatically hit-test the model when pointertap event is triggered.

Default

true

Inherited from

Live2DModelOptions.autoHitTest

autoInteract?

> optional autoInteract?: boolean

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4228

Should the internal model automatically reacts to interactions by listening for pointer events.

Default

true

Deprecated

since v0.5.0, reading/writing this property is equivalent to reading/writing autoHitTest && autoFocus.

Inherited from

Live2DModelOptions.autoInteract

autoUpdate?

> optional autoUpdate?: boolean

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4222

Should the internal model be automatically updated by PIXI.Ticker.shared.

Default

ture

Inherited from

Live2DModelOptions.autoUpdate

breathDepth?

> optional breathDepth?: number

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3118

Define natural movements depth (0.0-1.0).

Default

1.0

Inherited from

Live2DModelOptions.breathDepth

checkMocConsistency?

> optional checkMocConsistency?: boolean

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4051

Whether to check the consistency of the moc file. It's an internal function of Cubism core and only available since Cubism 4 R7.

Default

false

checkMotionConsistency?

> optional checkMotionConsistency?: boolean

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4071

Whether to validate motion3.json consistency when loading motions.

Default

false

Overrides

Live2DModelOptions.checkMotionConsistency

crossOrigin?

> optional crossOrigin?: string

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4056

String to use for crossOrigin properties on <img> elements when loading textures.

Default

undefined

eyeBlink?

> optional eyeBlink?: boolean

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3133

Whether to enable automatic eye blinking between motions.

Default

true

Inherited from

Live2DModelOptions.eyeBlink

idleMotionGroup?

> optional idleMotionGroup?: string

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3336

Specifies the idle motion group.

Default

"idle" in Cubism 2 and "Idle" in Cubism 4.

Inherited from

Live2DModelOptions.idleMotionGroup

lipSyncGain?

> optional lipSyncGain?: number

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3123

Gain multiplier applied to the analyzed mouth-sync input value.

Default

1.5

Inherited from

Live2DModelOptions.lipSyncGain

lipSyncWeight?

> optional lipSyncWeight?: number

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3128

Blend weight used when adding lip-sync values to mouth parameters.

Default

0.4

Inherited from

Live2DModelOptions.lipSyncWeight

motionPreload?

> optional motionPreload?: MotionPreloadStrategy

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3331

How to preload the motions.

Default

MotionPreloadStrategy.NONE

Inherited from

Live2DModelOptions.motionPreload

textureOptions?

> optional textureOptions?: Live2DTextureSourceOptions

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4079

Texture loading and atlas LOD options.

See Live2DTextureLODOptions for the available lod strategies.

Default

{ lod: 'full' }

Overrides

Live2DModelOptions.textureOptions

ticker?

> optional ticker?: Ticker

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4243

The ticker to be used for automatic updates.

Default

PIXI.Ticker.shared from the global PIXI namespace.

Inherited from

Live2DModelOptions.ticker

useHighPrecisionMask?

> optional useHighPrecisionMask?: boolean | "auto"

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3139

Whether to use Cubism's high precision clipping mask rendering. Only supported by Cubism 3/4/5 models.

Default

'auto'

Inherited from

Live2DModelOptions.useHighPrecisionMask

Methods

onError()?

> optional onError(e): void

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4066

Callback invoked when error occurs while loading the model.

Parameters

e

Error

Returns

void

Default

undefined

onLoad()?

> optional onLoad(): void

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:4061

Callback invoked when the model has been loaded.

Returns

void

Default

undefined