# Interface: Live2DFactoryOptions (/jsdoc/pixi-vn-live2d/core/interfaces/Live2DFactoryOptions)



Defined in: node\_modules/untitled-pixi-live2d-engine/types/index.d.ts:4045

## Extends [#extends]

* [`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions)

## Extended by [#extended-by]

* [`Live2DOptions`](/jsdoc/pixi-vn-live2d/index/interfaces/Live2DOptions)

## Properties [#properties]

### anchorMode? [#anchormode]

\> `optional` &#x2A;*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](/jsdoc/pixi-vn-live2d/core/classes/Live2DModel#anchor).
`'canvas'` preserves the historical model-canvas behavior, while `'drawable'`
resolves the anchor against the visible drawable bounds.

#### Default [#default]

```ts
'canvas'
```

#### Inherited from [#inherited-from]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`anchorMode`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#anchormode)

***

### autoFocus? [#autofocus]

\> `optional` &#x2A;*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 [#default-1]

```ts
true
```

#### Inherited from [#inherited-from-1]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`autoFocus`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#autofocus)

***

### autoHitTest? [#autohittest]

\> `optional` &#x2A;*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 [#default-2]

```ts
true
```

#### Inherited from [#inherited-from-2]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`autoHitTest`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#autohittest)

***

### ~~autoInteract?~~ [#autointeract]

\> `optional` &#x2A;*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 [#default-3]

```ts
true
```

#### Deprecated [#deprecated]

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

#### Inherited from [#inherited-from-3]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`autoInteract`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#autointeract)

***

### autoUpdate? [#autoupdate]

\> `optional` &#x2A;*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 [#default-4]

```ts
ture
```

#### Inherited from [#inherited-from-4]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`autoUpdate`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#autoupdate)

***

### breathDepth? [#breathdepth]

\> `optional` &#x2A;*breathDepth?**: `number`

Defined in: node\_modules/untitled-pixi-live2d-engine/types/index.d.ts:3118

Define natural movements depth (0.0-1.0).

#### Default [#default-5]

```ts
1.0
```

#### Inherited from [#inherited-from-5]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`breathDepth`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#breathdepth)

***

### checkMocConsistency? [#checkmocconsistency]

\> `optional` &#x2A;*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 [#default-6]

```ts
false
```

***

### checkMotionConsistency? [#checkmotionconsistency]

\> `optional` &#x2A;*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 [#default-7]

```ts
false
```

#### Overrides [#overrides]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`checkMotionConsistency`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#checkmotionconsistency)

***

### crossOrigin? [#crossorigin]

\> `optional` &#x2A;*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 [#default-8]

```ts
undefined
```

***

### eyeBlink? [#eyeblink]

\> `optional` &#x2A;*eyeBlink?**: `boolean`

Defined in: node\_modules/untitled-pixi-live2d-engine/types/index.d.ts:3133

Whether to enable automatic eye blinking between motions.

#### Default [#default-9]

```ts
true
```

#### Inherited from [#inherited-from-6]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`eyeBlink`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#eyeblink)

***

### idleMotionGroup? [#idlemotiongroup]

\> `optional` &#x2A;*idleMotionGroup?**: `string`

Defined in: node\_modules/untitled-pixi-live2d-engine/types/index.d.ts:3336

Specifies the idle motion group.

#### Default [#default-10]

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

#### Inherited from [#inherited-from-7]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`idleMotionGroup`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#idlemotiongroup)

***

### lipSyncGain? [#lipsyncgain]

\> `optional` &#x2A;*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 [#default-11]

```ts
1.5
```

#### Inherited from [#inherited-from-8]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`lipSyncGain`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#lipsyncgain)

***

### lipSyncWeight? [#lipsyncweight]

\> `optional` &#x2A;*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 [#default-12]

```ts
0.4
```

#### Inherited from [#inherited-from-9]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`lipSyncWeight`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#lipsyncweight)

***

### motionPreload? [#motionpreload]

\> `optional` &#x2A;*motionPreload?**: [`MotionPreloadStrategy`](/jsdoc/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy)

Defined in: node\_modules/untitled-pixi-live2d-engine/types/index.d.ts:3331

How to preload the motions.

#### Default [#default-13]

[MotionPreloadStrategy.NONE](/jsdoc/pixi-vn-live2d/core/enumerations/MotionPreloadStrategy#none)

#### Inherited from [#inherited-from-10]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`motionPreload`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#motionpreload)

***

### textureOptions? [#textureoptions]

\> `optional` &#x2A;*textureOptions?**: [`Live2DTextureSourceOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DTextureSourceOptions)

Defined in: node\_modules/untitled-pixi-live2d-engine/types/index.d.ts:4079

Texture loading and atlas LOD options.

See [Live2DTextureLODOptions](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DTextureLODOptions) for the available `lod` strategies.

#### Default [#default-14]

```ts
{ lod: 'full' }
```

#### Overrides [#overrides-1]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`textureOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#textureoptions)

***

### ticker? [#ticker]

\> `optional` &#x2A;*ticker?**: `Ticker`

Defined in: node\_modules/untitled-pixi-live2d-engine/types/index.d.ts:4243

The ticker to be used for automatic updates.

#### Default [#default-15]

`PIXI.Ticker.shared` from the global PIXI namespace.

#### Inherited from [#inherited-from-11]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`ticker`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#ticker)

***

### useHighPrecisionMask? [#usehighprecisionmask]

\> `optional` &#x2A;*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 [#default-16]

```ts
'auto'
```

#### Inherited from [#inherited-from-12]

[`Live2DModelOptions`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions).[`useHighPrecisionMask`](/jsdoc/pixi-vn-live2d/core/interfaces/Live2DModelOptions#usehighprecisionmask)

## Methods [#methods]

### onError()? [#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 [#parameters]

##### e [#e]

`Error`

#### Returns [#returns]

`void`

#### Default [#default-17]

```ts
undefined
```

***

### onLoad()? [#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 [#returns-1]

`void`

#### Default [#default-18]

```ts
undefined
```
