Pixi’VNClass: CubismExpressionManager
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6138
Abstract expression manager.
Emits
Extends
ExpressionManager<CubismExpressionMotion,CubismSpec.Expression>
Constructors
Constructor
> new CubismExpressionManager(settings, options?): CubismExpressionManager
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6142
Parameters
settings
options?
Returns
CubismExpressionManager
Overrides
Properties
currentExpression
> currentExpression: CubismExpressionMotion
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3812
Current Expression. This will not be overwritten by ExpressionManager#defaultExpression.
Inherited from
ExpressionManager.currentExpression
defaultExpression
> defaultExpression: CubismExpressionMotion
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3808
An empty Expression to reset all the expression parameters.
Inherited from
ExpressionManager.defaultExpression
definitions
> readonly definitions: Expression[]
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6141
Expression definitions copied from ModelSettings.
Overrides
destroyed
> destroyed: boolean
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3820
Flags the instance has been destroyed.
Inherited from
expressionDataType
> readonly expressionDataType: "arraybuffer"
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6139
Indicates the content type used when loading expressions.
Default
"json"Overrides
ExpressionManager.expressionDataType
expressions
> expressions: (CubismExpressionMotion | 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.
Inherited from
queueManager
> readonly queueManager: CubismMotionQueueManager
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6140
reserveExpressionIndex
> reserveExpressionIndex: number
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3816
The pending Expression.
Inherited from
ExpressionManager.reserveExpressionIndex
settings
> readonly settings: ModelSettings
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3797
The ModelSettings reference.
Inherited from
tag
> tag: string
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3789
Tag for logging.
Inherited from
prefixed
> static prefixed: string | boolean
Defined in: node_modules/eventemitter3/index.d.ts:9
Inherited from
Methods
_setExpression()
> protected _setExpression(motion): number
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6147
Applies the Expression to the model.
Parameters
motion
CubismExpressionMotion
Returns
number
Overrides
ExpressionManager._setExpression
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
createDefaultExpression()
> protected createDefaultExpression(): CubismExpressionMotion
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6150
Creates the default expression instance used for resets.
Returns
CubismExpressionMotion
Overrides
ExpressionManager.createDefaultExpression
createExpression()
> createExpression(data, _definition): CubismExpressionMotion
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6146
Creates an Expression from the data.
Parameters
data
ArrayBuffer
Content of the expression file.
_definition
any
Returns
CubismExpressionMotion
The created Expression.
Overrides
ExpressionManager.createExpression
destroy()
> destroy(): void
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3872
Destroys the instance.
Returns
void
Emits
ExpressionManagerEvents.destroy
Inherited from
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
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
getExpressionFile()
> getExpressionFile(definition): string
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6145
Retrieves the expression's file path by its definition.
Parameters
definition
Expression
Returns
string
The file path extracted from given definition. Not resolved.
Overrides
ExpressionManager.getExpressionFile
getExpressionIndex()
> getExpressionIndex(name): number
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6144
Retrieves the expression's index by its name.
Parameters
name
string
Returns
number
The index. -1 if not found.
Overrides
ExpressionManager.getExpressionIndex
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
Inherited from
isFinished()
> isFinished(): boolean
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6143
Checks if the expression playback has finished.
Returns
boolean
Overrides
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
ExpressionManager.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
loadExpression()
> protected loadExpression(index): Promise<CubismExpressionMotion | 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<CubismExpressionMotion | undefined>
Promise that resolves with the Expression, or with undefined if it can't be loaded.
Emits
ExpressionManagerEvents.expressionLoaded
Emits
ExpressionManagerEvents.expressionLoadError
Inherited from
ExpressionManager.loadExpression
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
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
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
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
ExpressionManager.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
ExpressionManager.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
Inherited from
ExpressionManager.resetExpression
restoreExpression()
> restoreExpression(): void
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3856
Restores model's expression to currentExpression.
Returns
void
Inherited from
ExpressionManager.restoreExpression
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.
Inherited from
ExpressionManager.setExpression
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.
Inherited from
ExpressionManager.setRandomExpression
stopAllExpressions()
> protected stopAllExpressions(): void
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6148
Cancels expression playback.
Returns
void
Overrides
ExpressionManager.stopAllExpressions
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.
Inherited from
updateParameters()
> protected updateParameters(model, now): boolean
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:6149
Updates parameters of the core model.
Parameters
model
CubismModel
now
number
Returns
boolean
True if the parameters are actually updated.