Defined in: src/interfaces/Live2DMemory.ts:59

Extends

MemoryCore.CanvasBaseItemMemory.ListenerExtensionMemory.AdditionalPositionsExtensionProps

Properties

align?

> optional align?: number | Partial<PointData>

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w.d.ts:232

is a way to set the position of the element in the canvas. compared to position, align, it is a percentage used to determine the proximity from the edges of the canvas. For example:

if you set align to 0.5, the element will be in the center of the canvas.
if you set align to 0, the left end and a top end of the element will be in the left end and top end of the canvas.
if you set align to 1, the right end and a bottom end of the element will be in the right end and bottom end of the canvas.

Important: The PixiContainer.pivot field does not affect the alignment.

alpha?

> optional alpha?: number

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:235

The opacity of the object relative to its parent's opacity. Value ranges from 0 (fully transparent) to 1 (fully opaque).

Example

new Container({ alpha: 0.5 }); // 50% opacity
new Container({ alpha: 1 }); // Fully opaque

See

Container#visible For toggling visibility
Container#renderable For render control

anchor?

> optional anchor?: object

Defined in: src/interfaces/Live2DMemory.ts:68

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.

blendMode?

> optional blendMode?: BLEND_MODES

Defined in: node_modules/pixi.js/lib/scene/container/Container.d.ts:206

The blend mode to be applied to the sprite. Controls how pixels are blended when rendering.

Setting to 'normal' will reset to default blending. > [!NOTE] More blend modes are available after importing the pixi.js/advanced-blend-modes sub-export.

Example

// Basic blend modes
new Container({ blendMode: 'normal' }); // Default blending
new Container({ blendMode: 'add' });    // Additive blending
new Container({ blendMode: 'multiply' }); // Multiply colors
new Container({ blendMode: 'screen' }); // Screen blend

Default

'normal'

See

Container#alpha For transparency
Container#tint For color adjustments

currentExpressionId?

> optional currentExpressionId?: string | number

Defined in: src/interfaces/Live2DMemory.ts:84

The id (index or name) of the expression currently applied to the model.

currentMotion?

> optional currentMotion?: MotionMemory

Defined in: src/interfaces/Live2DMemory.ts:76

The motion currently playing on the main motion manager.

cursor?

> optional cursor?: Cursor | string & object

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:187

The cursor style to display when the mouse pointer is hovering over the object. Accepts any valid CSS cursor value or custom cursor URL.

Example

// Common cursor types
sprite.cursor = 'pointer';     // Hand cursor for clickable elements
sprite.cursor = 'grab';        // Grab cursor for draggable elements
sprite.cursor = 'crosshair';   // Precise cursor for selection
sprite.cursor = 'not-allowed'; // Indicate disabled state

// Direction cursors
sprite.cursor = 'n-resize';    // North resize
sprite.cursor = 'ew-resize';   // East-west resize
sprite.cursor = 'nesw-resize'; // Northeast-southwest resize

// Custom cursor with fallback
sprite.cursor = 'url("custom.png"), auto';
sprite.cursor = 'url("cursor.cur") 2 2, pointer'; // With hotspot offset

Default

undefined

See

EventSystem.cursorStyles For setting global cursor styles
https://developer.mozilla.org/en-US/docs/Web/CSS/cursor MDN Cursor Documentation

eventMode?

> optional eventMode?: EventMode

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:225

Enable interaction events for the Container. Touch, pointer and mouse events are supported.

Example

const sprite = new Sprite(texture);

// Enable standard interaction (like buttons)
sprite.eventMode = 'static';
sprite.on('pointerdown', () => console.log('clicked!'));

// Enable for moving objects
sprite.eventMode = 'dynamic';
sprite.on('pointermove', () => updatePosition());

// Disable all interaction
sprite.eventMode = 'none';

// Only allow child interactions
sprite.eventMode = 'passive';

Available modes:

'none': Ignores all interaction events, even on its children. Best for pure visuals.
'passive': (default) Does not emit events and ignores hit testing on itself and non-interactive children. Interactive children will still emit events.
'auto': Does not emit events but is hit tested if parent is interactive. Same as interactive = false in v7.
'static': Emit events and is hit tested. Same as interactive = true in v7. Best for buttons/UI.
'dynamic': Like static but also receives synthetic events when pointer is idle. Best for moving objects.

Performance tips:

Use 'none' for pure visual elements
Use 'passive' for containers with some interactive children
Use 'static' for standard UI elements
Use 'dynamic' only when needed for moving/animated elements

focus?

> optional focus?: object

Defined in: src/interfaces/Live2DMemory.ts:72

The focus position of the model, in world space.

index?

> optional index?: number

Defined in: node_modules/@drincs/pixi-vn/dist/ContainerMemory-D2HtgX7w.d.ts:182

The index of the container in its parent, if it has one

interactive?

> optional interactive?: boolean

Defined in: node_modules/pixi.js/lib/events/FederatedEventTarget.d.ts:238

Whether this object should fire UI events. This is an alias for eventMode set to 'static' or 'passive'. Setting this to true will enable interaction events like pointerdown, click, etc. Setting it to false will disable all interaction events on this object.

See

Container.eventMode

Example

// Enable interaction events
sprite.interactive = true;  // Sets eventMode = 'static'
sprite.interactive = false; // Sets eventMode = 'passive'

Interface: Live2DMemory