API Docs for:
Show:

gs.Live2DModel Class

This class is used to load a Live2D model from .live2d archive. See Resource Standards in Help File for more information.

Constructor

gs.Live2DModel

(
  • filePath
  • [languageCode=null]
)

Parameters:

  • filePath String
    • The path to the Live2D resource.
  • [languageCode=null] String optional
    • The language code to load the Live2D resource depending on language.

Methods

dispose

()

Disposes the Live2D model and frees allocated resources/memory.

initialize

()

Initializes the Live2D model for use.

update

()

Updates the Live2D model. Should be called once per frame.

Properties

disposed

Boolean

Indicates if the Live2D model is disposed.

expressions

gs.Live2DExpression

Live2D expressions.

initialized

Boolean

Indicates if the Live2D model is initialized.

loaded

Boolean

Indicates if the Live2D model is loaded.

motions

Object

Live2D motions by name/key.

motionsByGroup

Object

Live2D motions by group.

pose

gs.Live2DPose

Live2D pose data.