Interface: Live2DMemory

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

Extends

• MemoryCore.CanvasBaseItemMemory.ListenerExtensionMemory.AdditionalPositionsExtensionProps

Properties

accessible?

> optional accessible?: boolean

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:31

Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set

Default

false

Example

const container = new Container();
container.accessible = true;

Inherited from

MemoryCore.accessible

accessibleChildren?

> optional accessibleChildren?: boolean

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:126

Setting to false will prevent any children inside this container to be accessible. Defaults to true.

Default

true

Example

const container = new Container();
container.accessible = true;
container.accessibleChildren = false; // This will prevent any children from being accessible

const sprite = new Sprite(texture);
sprite.accessible = true; // This will not work since accessibleChildren is false

Inherited from

MemoryCore.accessibleChildren

accessibleHint?

> optional accessibleHint?: string | null

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:56

Sets the aria-label attribute of the shadow div

Default

null

Advanced

Example

const container = new Container();
container.accessible = true;
container.accessibleHint = 'This is a container';

Inherited from

MemoryCore.accessibleHint

accessiblePointerEvents?

> optional accessiblePointerEvents?: PointerEvents

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:100

Specify the pointer-events the accessible div will use Defaults to auto.

Default

'auto'

Advanced

Example

const container = new Container();
container.accessible = true;
container.accessiblePointerEvents = 'none'; // or 'auto', 'visiblePainted', etc.

Inherited from

MemoryCore.accessiblePointerEvents

accessibleText?

> optional accessibleText?: string | null

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:111

Sets the text content of the shadow

Default

null

Example

const container = new Container();
container.accessible = true;
container.accessibleText = 'This is a container';

Inherited from

MemoryCore.accessibleText

accessibleTitle?

> optional accessibleTitle?: string | null

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:44

Sets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to 'container [tabIndex]'

Default

null

Example

const container = new Container();
container.accessible = true;
container.accessibleTitle = 'My Container';

Inherited from

MemoryCore.accessibleTitle

accessibleType?

> optional accessibleType?: keyof HTMLElementTagNameMap

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:86

Specify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.

Default

'button'

Advanced

Example

const container = new Container();
container.accessible = true;
container.accessibleType = 'button'; // or 'link', 'checkbox', etc.

Inherited from

MemoryCore.accessibleType

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.

Inherited from

Live2DOptions.align

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

Default

1

See

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

Inherited from

MemoryCore.alpha

anchor?

> optional anchor?: object

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

x

> x: number

y

> y: number

Overrides

Live2DOptions.anchor

anchorMode?

> optional 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. 'canvas' preserves the historical model-canvas behavior, while 'drawable' resolves the anchor against the visible drawable bounds.

Default

'canvas'

Inherited from

Live2DModelOptions.anchorMode

angle?

> optional angle?: number

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

The angle of the object in degrees.

> [!NOTE] 'rotation' and 'angle' have the same effect on a display object; > rotation is in radians, angle is in degrees.

Example

new Container({ angle: 45 }); // Rotate 45 degrees
new Container({ angle: 90 }); // Rotate 90 degrees

Inherited from

MemoryCore.angle

autoFocus?

> optional 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

true

Inherited from

AutomatorOptions.autoFocus

autoHitTest?

> optional 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

true

Inherited from

AutomatorOptions.autoHitTest

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.

Inherited from

AutomatorOptions.autoInteract

autoUpdate?

> optional 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

ture

Inherited from

AutomatorOptions.autoUpdate

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

Inherited from

MemoryCore.blendMode

breathDepth?

> optional breathDepth?: number

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

Define natural movements depth (0.0-1.0).

Default

1.0

Inherited from

InternalModelOptions.breathDepth

checkMocConsistency?

> optional 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

false

Inherited from

Live2DFactoryOptions.checkMocConsistency

checkMotionConsistency?

> optional 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

false

Inherited from

Live2DFactoryOptions.checkMotionConsistency

crossOrigin?

> optional 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

undefined

Inherited from

Live2DFactoryOptions.crossOrigin

cullable?

> optional cullable?: boolean

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:69

Controls whether this object should be culled when out of view. When true, the object will not be rendered if its bounds are outside the visible area.

Example

const sprite = new Sprite(texture);

// Enable culling
sprite.cullable = true;

// Force object to always render
sprite.cullable = false;

Remarks

• Does not affect transform updates
• Applies to this object only
• Children follow their own cullable setting

Default

false

Inherited from

MemoryCore.cullable

cullableChildren?

> optional cullableChildren?: boolean

Defined in: node_modules/pixi.js/lib/culling/cullingMixin.d.ts:92

Controls whether children of this container can be culled. When false, skips recursive culling checks for better performance.

Example

const container = new Container();

// Enable container culling
container.cullable = true;

// Disable child culling for performance
container.cullableChildren = false;

// Children will always render if container is visible
container.addChild(sprite1, sprite2, sprite3);

Remarks

• Improves performance for static scenes
• Useful when children are always within container bounds
• Parent culling still applies

Default

true

Inherited from

MemoryCore.cullableChildren

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

Inherited from

Live2DModel.cursor

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

Since

7.2.0

Inherited from

Live2DModel.eventMode

eyeBlink?

> optional eyeBlink?: boolean

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

Whether to enable automatic eye blinking between motions.

Default

true

Inherited from

InternalModelOptions.eyeBlink

focus?

> optional focus?: object

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

The focus position of the model, in world space.

x

> x: number

y

> y: number

height?

> optional height?: number

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:29

The height of the display object, in pixels.

Example

new Container({ height: 100});

Default

0

Inherited from

MemoryCore.height

idleMotionGroup?

> optional idleMotionGroup?: string

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

Specifies the idle motion group.

Default

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

Inherited from

MotionManagerOptions.idleMotionGroup

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

Inherited from

CanvasBaseItemMemory.index

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'

Inherited from

Live2DModel.interactive

interactiveChildren?

> optional interactiveChildren?: boolean

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

Controls whether children of this container can receive pointer events.

Setting this to false allows PixiJS to skip hit testing on all children, improving performance for containers with many non-interactive children.

Default

true

Example

// Container with many visual-only children
const container = new Container();
container.interactiveChildren = false; // Skip hit testing children

// Menu with interactive buttons
const menu = new Container();
menu.interactiveChildren = true; // Test all children
menu.addChild(button1, button2, button3);

// Performance optimization
background.interactiveChildren = false;
foreground.interactiveChildren = true;

Inherited from

Live2DModel.interactiveChildren

isRenderGroup?

> optional isRenderGroup?: boolean

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

See

Container#isRenderGroup

Inherited from

MemoryCore.isRenderGroup

label?

> optional label?: string

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/findMixin.d.ts:8

The instance label of the object.

Default

null

Inherited from

MemoryCore.label

lipSyncGain?

> optional 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

1.5

Inherited from

InternalModelOptions.lipSyncGain

lipSyncWeight?

> optional 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

0.4

Inherited from

InternalModelOptions.lipSyncWeight

motionPreload?

> optional motionPreload?: MotionPreloadStrategy

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

How to preload the motions.

Default

MotionPreloadStrategy.NONE

Inherited from

MotionManagerOptions.motionPreload

onEvents?

> optional onEvents?: OnEventsHandlers

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

Inherited from

ListenerExtensionMemory.onEvents

origin?

> optional origin?: number | PointData

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

The origin point around which the container rotates and scales. Unlike pivot, changing origin will not move the container's position.

Example

new Container({ origin: new Point(100, 100) }); // Rotate around point (100,100)
new Container({ origin: 50 }); // Rotate around point (50, 50)
new Container({ origin: { x: 150, y: 150 } }); // Rotate around point (150, 150)

Inherited from

MemoryCore.origin

parallelMotions

> parallelMotions: (MotionMemory | null)[]

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

The motions currently playing on each parallel motion manager.

parentLabel?

> optional parentLabel?: string

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

The label of the parent container, if it has one

Inherited from

CanvasBaseItemMemory.parentLabel

percentagePosition?

> optional percentagePosition?: number | Partial<PointData>

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

is a way to set the position of the element in the canvas calculated in percentage. For example, if you set the PixiContainer.pivot to 0.5, and:

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

Important: The PixiContainer.pivot field does affect the percentagePosition.

Inherited from

Live2DOptions.percentagePosition

percentageX?

> optional percentageX?: number

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

is a way to set the position of the element in the canvas calculated in percentage. For example, if you set the PixiContainer.pivot to 0.5, and:

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

Important: The PixiContainer.pivot field does affect the percentagePosition.

Inherited from

Live2DOptions.percentageX

percentageY?

> optional percentageY?: number

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

is a way to set the position of the element in the canvas calculated in percentage. For example, if you set the PixiContainer.pivot to 0.5, and:

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

Important: The PixiContainer.pivot field does affect the percentagePosition.

Inherited from

Live2DOptions.percentageY

pivot?

> optional pivot?: number | PointData

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

The center of rotation, scaling, and skewing for this display object in its local space. The position is the projection of pivot in the parent's local space.

By default, the pivot is the origin (0, 0).

Example

new Container({ pivot: new Point(100, 200) }); // Set pivot to (100, 200)
new Container({ pivot: 50 }); // Set pivot to (50, 50)
new Container({ pivot: { x: 150, y: 150 } }); // Set pivot to (150, 150)

Inherited from

MemoryCore.pivot

pixivnId

> pixivnId: string

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

Inherited from

CanvasBaseItemMemory.pixivnId

position?

> optional position?: PointData

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

The coordinate of the object relative to the local coordinates of the parent.

Example

new Container({ position: new Point(100, 200) }); // Set position to (100, 200)
new Container({ position: { x: 150, y: 150 } }); // Set position to (150, 150)

Inherited from

MemoryCore.position

renderable?

> optional renderable?: boolean

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

Controls whether this object can be rendered. If false the object will not be drawn, but the transform will still be updated. This is different from visible, which skips transform updates.

Example

new Container({ renderable: false }); // Will not be drawn, but transforms will update

Default

true

See

• Container#visible For skipping transform updates
• Container#alpha For transparency

Inherited from

MemoryCore.renderable

rotation?

> optional rotation?: number

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

The rotation of the object in radians.

> [!NOTE] 'rotation' and 'angle' have the same effect on a display object; > rotation is in radians, angle is in degrees.

Example

new Container({ rotation: Math.PI / 4 }); // Rotate 45 degrees
new Container({ rotation: Math.PI / 2 }); // Rotate 90 degrees

Inherited from

MemoryCore.rotation

scale?

> optional scale?: number | PointData

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

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

Example

new Container({ scale: new Point(2, 2) }); // Scale by 2x
new Container({ scale: 0.5 }); // Scale by 0.5x
new Container({ scale: { x: 1.5, y: 1.5 } }); // Scale by 1.5x

Inherited from

MemoryCore.scale

setMask?

> optional setMask?: (options) => void

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/effectsMixin.d.ts:23

Parameters

options

Partial<MaskOptionsAndMask>

Returns

void

Inherited from

MemoryCore.setMask

skew?

> optional skew?: PointData

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

The skew factor for the object in radians. Skewing is a transformation that distorts the object by rotating it differently at each point, creating a non-uniform shape.

Example

new Container({ skew: new Point(0.1, 0.2) }); // Skew by 0.1 radians on x and 0.2 radians on y
new Container({ skew: { x: 0.1, y: 0.2 } }); // Skew by 0.1 radians on x and 0.2 radians on y

Default

{ x: 0, y: 0 }

Inherited from

MemoryCore.skew

sortableChildren?

> optional sortableChildren?: boolean

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:48

If set to true, the container will sort its children by zIndex value when the next render is called, or manually if sortChildren() is called.

This actually changes the order of elements in the array of children, so it will affect the rendering order.

> [!NOTE] Also be aware of that this may not work nicely with the addChildAt() function, > as the zIndex sorting may cause the child to automatically sorted to another position.

Example

container.sortableChildren = true;

Default

false

Inherited from

MemoryCore.sortableChildren

sortDirty?

> optional sortDirty?: boolean

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:32

Internal

Should children be sorted by zIndex at the next render call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

Default

false
@internal

Inherited from

MemoryCore.sortDirty

source

> source: string

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

The model source. Must be a URL/alias string so it can be reloaded when the memory is restored.

tabIndex?

> optional tabIndex?: number

Defined in: node_modules/pixi.js/lib/accessibility/accessibilityTarget.d.ts:72

Sets the tabIndex of the shadow div. You can use this to set the order of the elements when using the tab key to navigate.

Default

0

Example

const container = new Container();
container.accessible = true;
container.tabIndex = 0;

const sprite = new Sprite(texture);
sprite.accessible = true;
sprite.tabIndex = 1;

Inherited from

MemoryCore.tabIndex

textureOptions?

> optional textureOptions?: Live2DTextureSourceOptions

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

Texture loading and atlas LOD options.

See Live2DTextureLODOptions for the available lod strategies.

Default

{ lod: 'full' }

Inherited from

Live2DFactoryOptions.textureOptions

tint?

> optional tint?: ColorSource

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

The tint applied to the sprite.

This can be any valid ColorSource.

Example

new Container({ tint: 0xff0000 }); // Red tint
new Container({ tint: 'blue' }); // Blue tint
new Container({ tint: '#00ff00' }); // Green tint
new Container({ tint: 'rgb(0,0,255)' }); // Blue tint

Default

0xFFFFFF

See

• Container#alpha For transparency
• Container#visible For visibility control

Inherited from

MemoryCore.tint

useHighPrecisionMask?

> optional 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

'auto'

Inherited from

InternalModelOptions.useHighPrecisionMask

visible?

> optional visible?: boolean

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

The visibility of the object. If false the object will not be drawn, and the transform will not be updated.

Example

new Container({ visible: false }); // Will not be drawn and transforms will not update
new Container({ visible: true }); // Will be drawn and transforms will update

Default

true

See

• Container#renderable For render-only control
• Container#alpha For transparency

Inherited from

MemoryCore.visible

width?

> optional width?: number

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/measureMixin.d.ts:20

The width of the display object, in pixels.

Example

new Container({ width: 100});

Default

0

Inherited from

MemoryCore.width

x?

> optional x?: number

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

The position of the container on the x axis relative to the local coordinates of the parent.

An alias to position.x

Example

new Container({ x: 100 }); // Set x position to 100

Inherited from

MemoryCore.x

xAlign?

> optional xAlign?: number

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

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.

Inherited from

Live2DOptions.xAlign

y?

> optional y?: number

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

The position of the container on the y axis relative to the local coordinates of the parent.

An alias to position.y

Example

new Container({ y: 200 }); // Set y position to 200

Inherited from

MemoryCore.y

yAlign?

> optional yAlign?: number

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

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.

Inherited from

Live2DOptions.yAlign

zIndex?

> optional zIndex?: number

Defined in: node_modules/pixi.js/lib/scene/container/container-mixins/sortMixin.d.ts:24

The zIndex of the container.

Controls the rendering order of children within their parent container.

A higher value will mean it will be moved towards the front of the rendering order.

Example

// Add in any order
container.addChild(character, background, foreground);

// Adjust rendering order
background.zIndex = 0;
character.zIndex = 1;
foreground.zIndex = 2;

See

• Container#sortableChildren For enabling sorting
• Container#sortChildren For manual sorting

Default

0

Inherited from

MemoryCore.zIndex