LogoPixi’VN
coreClasses

Abstract Class: ExpressionManager<Expression, ExpressionSpec>

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

Abstract expression manager.

Emits

ExpressionManagerEvents

Extends

Extended by

Type Parameters

Expression

Expression = unknown

ExpressionSpec

ExpressionSpec = unknown

Constructors

Constructor

> protected new ExpressionManager<Expression, ExpressionSpec>(settings, _options?): ExpressionManager<Expression, ExpressionSpec>

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

Parameters

settings

ModelSettings

_options?

MotionManagerOptions

Returns

ExpressionManager<Expression, ExpressionSpec>

Overrides

EventEmitter<keyof ExpressionManagerEvents>.constructor

Properties

currentExpression

> currentExpression: Expression

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

Current Expression. This will not be overwritten by ExpressionManager#defaultExpression.


defaultExpression

> defaultExpression: Expression

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

An empty Expression to reset all the expression parameters.


definitions

> abstract readonly definitions: ExpressionSpec[]

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

Expression definitions copied from ModelSettings.


destroyed

> destroyed: boolean

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

Flags the instance has been destroyed.


expressionDataType

> readonly expressionDataType: XMLHttpRequestResponseType

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

Indicates the content type used when loading expressions.

Default

"json"

expressions

> expressions: (Expression | null | undefined)[]

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

The Expressions. The structure is the same as definitions, initially there's only an empty array, which means all expressions will be undefined. When an Expression has been loaded, it'll fill the place in which it should be; when it fails to load, the place will be filled with null.


reserveExpressionIndex

> reserveExpressionIndex: number

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

The pending Expression.


settings

> readonly settings: ModelSettings

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

The ModelSettings reference.


tag

> tag: string

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

Tag for logging.


prefixed

> static prefixed: string | boolean

Defined in: node_modules/eventemitter3/index.d.ts:9

Inherited from

EventEmitter.prefixed

Methods

_setExpression()

> abstract protected _setExpression(motion): number

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

Applies the Expression to the model.

Parameters

motion

Expression

Returns

number


addListener()

> addListener<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:45

Type Parameters

T

T extends keyof ExpressionManagerEvents<never>

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

EventEmitter.addListener


createDefaultExpression()

> protected createDefaultExpression(): Expression

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

Creates the default expression instance used for resets.

Returns

Expression


createExpression()

> abstract createExpression(data, definition): Expression

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

Creates an Expression from the data.

Parameters

data

object

Content of the expression file.

definition

ExpressionSpec | undefined

The expression definition. Can be undefined in order to create ExpressionManager#defaultExpression.

Returns

Expression

The created Expression.


destroy()

> destroy(): void

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

Destroys the instance.

Returns

void

Emits

ExpressionManagerEvents.destroy


emit()

> emit<T>(event, ...args): boolean

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

Type Parameters

T

T extends keyof ExpressionManagerEvents<never>

Parameters

event

T

args

...any[]

Returns

boolean

Inherited from

EventEmitter.emit


eventNames()

> eventNames(): keyof ExpressionManagerEvents<never>[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered listeners.

Returns

keyof ExpressionManagerEvents<never>[]

Inherited from

EventEmitter.eventNames


getExpressionFile()

> abstract getExpressionFile(definition): string

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

Retrieves the expression's file path by its definition.

Parameters

definition

ExpressionSpec

Returns

string

The file path extracted from given definition. Not resolved.


getExpressionIndex()

> abstract getExpressionIndex(name): number

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

Retrieves the expression's index by its name.

Parameters

name

string

Returns

number

The index. -1 if not found.


init()

> protected init(): void

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

Should be called in the constructor of derived class.

Returns

void


isFinished()

> abstract isFinished(): boolean

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

Checks if the expression playback has finished.

Returns

boolean


listenerCount()

> listenerCount(event): number

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

Parameters

event

keyof ExpressionManagerEvents<never>

Returns

number

Inherited from

EventEmitter.listenerCount


listeners()

> listeners<T>(event): (...args) => void[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

Type Parameters

T

T extends keyof ExpressionManagerEvents<never>

Parameters

event

T

Returns

(...args) => void[]

Inherited from

EventEmitter.listeners


loadExpression()

> protected loadExpression(index): Promise<Expression | undefined>

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

Loads an Expression. Errors in this method will not be thrown, but be emitted with an "expressionLoadError" event.

Parameters

index

number

Index of the expression in definitions.

Returns

Promise<Expression | undefined>

Promise that resolves with the Expression, or with undefined if it can't be loaded.

Emits

ExpressionManagerEvents.expressionLoaded

Emits

ExpressionManagerEvents.expressionLoadError


off()

> off<T>(event, fn?, context?, once?): this

Defined in: node_modules/eventemitter3/index.d.ts:69

Type Parameters

T

T extends keyof ExpressionManagerEvents<never>

Parameters

event

T

fn?

(...args) => void

context?

any

once?

boolean

Returns

this

Inherited from

EventEmitter.off


on()

> on<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

Type Parameters

T

T extends keyof ExpressionManagerEvents<never>

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

EventEmitter.on


once()

> once<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

Type Parameters

T

T extends keyof ExpressionManagerEvents<never>

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

EventEmitter.once


removeAllListeners()

> removeAllListeners(event?): this

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

Parameters

event?

keyof ExpressionManagerEvents<never>

Returns

this

Inherited from

EventEmitter.removeAllListeners


removeListener()

> removeListener<T>(event, fn?, context?, once?): this

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

Type Parameters

T

T extends keyof ExpressionManagerEvents<never>

Parameters

event

T

fn?

(...args) => void

context?

any

once?

boolean

Returns

this

Inherited from

EventEmitter.removeListener


resetExpression()

> resetExpression(): void

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

Resets model's expression using ExpressionManager#defaultExpression.

Returns

void


restoreExpression()

> restoreExpression(): void

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

Restores model's expression to currentExpression.

Returns

void


setExpression()

> setExpression(index): Promise<boolean>

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

Sets an Expression.

Parameters

index

string | number

Either the index, or the name of the expression.

Returns

Promise<boolean>

Promise that resolves with true if succeeded, with false otherwise.


setRandomExpression()

> setRandomExpression(): Promise<boolean>

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

Sets a random Expression that differs from current one.

Returns

Promise<boolean>

Promise that resolves with true if succeeded, with false otherwise.


stopAllExpressions()

> abstract protected stopAllExpressions(): void

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

Cancels expression playback.

Returns

void


update()

> update(model, now): boolean

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

Updates parameters of the core model.

Parameters

model

object

now

number

Returns

boolean

True if the parameters are actually updated.


updateParameters()

> abstract protected updateParameters(model, now): boolean

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

Updates parameters of the core model.

Parameters

model

object

now

number

Returns

boolean

True if the parameters are actually updated.

On this page