# Class: MotionState (/pixi-vn-live2d/core/classes/MotionState)



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

Handles the state of a MotionManager.

## Constructors [#constructors]

### Constructor [#constructor]

\> **new MotionState**(): `MotionState`

#### Returns [#returns]

`MotionState`

## Properties [#properties]

### currentGroup? [#currentgroup]

\> `optional` **currentGroup?**: `string`

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

Group of current motion.

***

### currentIndex? [#currentindex]

\> `optional` **currentIndex?**: `number`

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

Index of current motion in its group.

***

### currentPriority [#currentpriority]

\> **currentPriority**: [`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

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

Priority of the current motion. Will be `MotionPriority.NONE` if there's no playing motion.

***

### debug [#debug]

\> **debug**: `boolean`

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

When enabled, the states will be dumped to the logger when an exception occurs.

***

### reservedGroup? [#reservedgroup]

\> `optional` **reservedGroup?**: `string`

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

Group of the reserved motion.

***

### reservedIdleGroup? [#reservedidlegroup]

\> `optional` **reservedIdleGroup?**: `string`

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

Group of the reserved idle motion.

***

### reservedIdleIndex? [#reservedidleindex]

\> `optional` **reservedIdleIndex?**: `number`

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

Index of the reserved idle motion in its group.

***

### reservedIndex? [#reservedindex]

\> `optional` **reservedIndex?**: `number`

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

Index of the reserved motion in its group.

***

### reservePriority [#reservepriority]

\> **reservePriority**: [`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

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

Priority of the reserved motion, which is still in loading and will be played once loaded.
Will be `MotionPriority.NONE` if there's no reserved motion.

***

### tag [#tag]

\> **tag**: `string`

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

Tag for logging.

## Methods [#methods]

### complete() [#complete]

\> **complete**(): `void`

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

Notifies the motion playback has finished.

#### Returns [#returns-1]

`void`

***

### dump() [#dump]

\> **dump**(`requestedGroup?`, `requestedIndex?`): `string`

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

Dumps the state for debugging.

#### Parameters [#parameters]

##### requestedGroup? [#requestedgroup]

`string`

##### requestedIndex? [#requestedindex]

`number`

#### Returns [#returns-2]

`string`

***

### isActive() [#isactive]

\> **isActive**(`group`, `index`): `boolean`

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

Checks if a Motion is currently playing or has reserved.

#### Parameters [#parameters-1]

##### group [#group]

`string`

##### index [#index]

`number`

#### Returns [#returns-3]

`boolean`

True if active.

***

### reserve() [#reserve]

\> **reserve**(`group`, `index`, `priority`): `boolean`

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

Reserves the playback for a motion.

#### Parameters [#parameters-2]

##### group [#group-1]

`string`

The motion group.

##### index [#index-1]

`number`

Index in the motion group.

##### priority [#priority]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied.

#### Returns [#returns-4]

`boolean`

True if the reserving has succeeded.

***

### reset() [#reset]

\> **reset**(): `void`

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

Resets the state.

#### Returns [#returns-5]

`void`

***

### setCurrent() [#setcurrent]

\> **setCurrent**(`group`, `index`, `priority`): `void`

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

Sets the current motion.

#### Parameters [#parameters-3]

##### group [#group-2]

`string` | `undefined`

##### index [#index-2]

`number` | `undefined`

##### priority [#priority-1]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

#### Returns [#returns-6]

`void`

***

### setReserved() [#setreserved]

\> **setReserved**(`group`, `index`, `priority`): `void`

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

Sets the reserved motion.

#### Parameters [#parameters-4]

##### group [#group-3]

`string` | `undefined`

##### index [#index-3]

`number` | `undefined`

##### priority [#priority-2]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

#### Returns [#returns-7]

`void`

***

### setReservedIdle() [#setreservedidle]

\> **setReservedIdle**(`group`, `index`): `void`

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

Sets the reserved idle motion.

#### Parameters [#parameters-5]

##### group [#group-4]

`string` | `undefined`

##### index [#index-4]

`number` | `undefined`

#### Returns [#returns-8]

`void`

***

### shouldOverrideExpression() [#shouldoverrideexpression]

\> **shouldOverrideExpression**(): `boolean`

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

Checks if the model's expression should be overridden by the motion.

#### Returns [#returns-9]

`boolean`

***

### shouldRequestIdleMotion() [#shouldrequestidlemotion]

\> **shouldRequestIdleMotion**(): `boolean`

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

Checks if an idle motion should be requests to play.

#### Returns [#returns-10]

`boolean`

***

### start() [#start]

\> **start**(`motion`, `group`, `index`, `priority`): `boolean`

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

Requests the playback for a motion.

#### Parameters [#parameters-6]

##### motion [#motion]

`unknown`

The Motion, can be undefined.

##### group [#group-5]

`string`

The motion group.

##### index [#index-5]

`number`

Index in the motion group.

##### priority [#priority-3]

[`MotionPriority`](/pixi-vn-live2d/core/enumerations/MotionPriority)

The priority to be applied.

#### Returns [#returns-11]

`boolean`

True if the request has been approved, i.e. the motion is allowed to play.