The model's name, typically used for displaying or logging. By default it's inferred from the URL by taking the folder name (the second to last component). In Cubism 2 it'll be overwritten by the name field of settings JSON.

Inherited from

ModelSettings.name

physics?

> optional physics?: string

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

Relative path of the physics file.

Inherited from

ModelSettings.physics

pose?

> optional pose?: string

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

Relative path of the pose file.

Inherited from

ModelSettings.pose

textures

> textures: string[]

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

Relative paths of the texture images.

Inherited from

ModelSettings.textures

url

> url: string

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

URL of the model settings file, used to resolve paths of the resource files defined in settings. This typically ends with .model.json in Cubism 2 and .model3.json in Cubism 4.

Inherited from

ModelSettings.url

Methods

getDefinedFiles()

> getDefinedFiles(): string[]

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

Retrieves all resource files defined in the settings.

Returns

string[]

A flat array of the paths of all resource files.

modelSettings.getDefinedFiles();
// returns: ["foo.moc", "foo.png", ...]

Inherited from

ModelSettings.getDefinedFiles

getExpressionCount()

> getExpressionCount(): number

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

表情設定ファイルの数を取得する

Returns

number

表情設定ファイルの数

Inherited from

CubismModelSettingJsonMixin.getExpressionCount

getExpressionFileName()

> getExpressionFileName(index): string

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

表情設定ファイルの名前を取得する

Parameters

index

number

配列のインデックス値

Returns

string

表情設定ファイルの名前

Inherited from

CubismModelSettingJsonMixin.getExpressionFileName

getExpressionName()

> getExpressionName(index): string

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

表情設定ファイルを識別する名前（別名）を取得する

Parameters

index

number

配列のインデックス値

Returns

string

表情の名前

Inherited from

CubismModelSettingJsonMixin.getExpressionName

getEyeBlinkParameters()

> getEyeBlinkParameters(): string[]

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

Returns

string[]

getFileStem()

> protected getFileStem(path?): string | undefined

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

Returns the file name without extension from a path.

Parameters

path?

string

Returns

string | undefined

Inherited from

ModelSettings.getFileStem

getHitAreaId()

> getHitAreaId(index): CubismId

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

当たり判定に設定されたIDを取得する

Parameters

index

number

配列のindex

Returns

CubismId

当たり判定に設定されたID

Inherited from

CubismModelSettingJsonMixin.getHitAreaId

getHitAreaName()

> getHitAreaName(index): string

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

当たり判定に設定された名前を取得する

Parameters

index

number

配列のインデックス値

Returns

string

当たり判定に設定された名前

Inherited from

CubismModelSettingJsonMixin.getHitAreaName

getHitAreasCount()

> getHitAreasCount(): number

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

モデルに設定された当たり判定の数を取得する

Returns

number

モデルに設定された当たり判定の数

Inherited from

CubismModelSettingJsonMixin.getHitAreasCount

getJson()

> getJson(): CubismJson

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

CubismJsonオブジェクトを取得する

Returns

CubismJson

CubismJson

Inherited from

CubismModelSettingJsonMixin.getJson

getLayoutMap()

> getLayoutMap(outLayoutMap): boolean

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

レイアウト情報を取得する

Parameters

outLayoutMap

csmMap<string, number>

csmMapクラスのインスタンス

Returns

boolean

true レイアウト情報が存在する

Inherited from

CubismModelSettingJsonMixin.getLayoutMap

getLipSyncParameters()

> getLipSyncParameters(): string[]

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

Returns

string[]

getModelFileName()

> getModelFileName(): string

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

Mocファイルの名前を取得する

Returns

string

Mocファイルの名前

Inherited from

CubismModelSettingJsonMixin.getModelFileName

getMotionCount()

> getMotionCount(groupName): number

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

モーショングループに含まれるモーションの数を取得する

Parameters

groupName

string

モーショングループの名前

Returns

number

モーショングループの数

Inherited from

CubismModelSettingJsonMixin.getMotionCount

getMotionFadeInTimeValue()

> getMotionFadeInTimeValue(groupName, index): number

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

モーション開始時のフェードイン処理時間を取得する

Parameters

groupName

string

モーショングループの名前

index

number

配列のインデックス値

Returns

number

フェードイン処理時間[秒]

Inherited from

CubismModelSettingJsonMixin.getMotionFadeInTimeValue

getMotionFadeOutTimeValue()

> getMotionFadeOutTimeValue(groupName, index): number

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

モーション終了時のフェードアウト処理時間を取得する

Parameters

groupName

string

モーショングループの名前

index

number

配列のインデックス値

Returns

number

フェードアウト処理時間[秒]

Inherited from

CubismModelSettingJsonMixin.getMotionFadeOutTimeValue

getMotionFileName()

> getMotionFileName(groupName, index): string

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

グループ名とインデックス値からモーションファイル名を取得する

Parameters

groupName

string

モーショングループの名前

index

number

配列のインデックス値

Returns

string

モーションファイルの名前

Inherited from

CubismModelSettingJsonMixin.getMotionFileName

getMotionGroupCount()

> getMotionGroupCount(): number

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

モーショングループの数を取得する

Returns

number

モーショングループの数

Inherited from

CubismModelSettingJsonMixin.getMotionGroupCount

getMotionGroupName()

> getMotionGroupName(index): string

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

モーショングループの名前を取得する

Parameters

index

number

配列のインデックス値

Returns

string

モーショングループの名前

Inherited from

CubismModelSettingJsonMixin.getMotionGroupName

getMotionSoundFileName()

> getMotionSoundFileName(groupName, index): string

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

モーションに対応するサウンドファイルの名前を取得する

Parameters

groupName

string

モーショングループの名前

index

number

配列のインデックス値

Returns

string

サウンドファイルの名前

Inherited from

CubismModelSettingJsonMixin.getMotionSoundFileName

getPhysicsFileName()

> getPhysicsFileName(): string

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

物理演算設定ファイルの名前を取得する

Returns

string

物理演算設定ファイルの名前

Inherited from

CubismModelSettingJsonMixin.getPhysicsFileName

getPoseFileName()

> getPoseFileName(): string

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

パーツ切り替え設定ファイルの名前を取得する

Returns

string

パーツ切り替え設定ファイルの名前

Inherited from

CubismModelSettingJsonMixin.getPoseFileName

getTextureCount()

> getTextureCount(): number

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

モデルが使用するテクスチャの数を取得するテクスチャの数

Returns

number

Inherited from

CubismModelSettingJsonMixin.getTextureCount

getTextureDirectory()

> getTextureDirectory(): string

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

テクスチャが配置されたディレクトリの名前を取得する

Returns

string

テクスチャが配置されたディレクトリの名前

Inherited from

CubismModelSettingJsonMixin.getTextureDirectory

getTextureFileName()

> getTextureFileName(index): string

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

モデルが使用するテクスチャの名前を取得する

Parameters

index

number

配列のインデックス値

Returns

string

テクスチャの名前

Inherited from

CubismModelSettingJsonMixin.getTextureFileName

getUserDataFile()

> getUserDataFile(): string

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

ユーザーデータのファイル名を取得する

Returns

string

ユーザーデータのファイル名

Inherited from

CubismModelSettingJsonMixin.getUserDataFile

normalizeName()

> protected normalizeName(): void

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

Ensures the model name is meaningful; falls back to the folder name when missing or placeholder.

Returns

void

Inherited from

ModelSettings.normalizeName

release()

> release(): void

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

デストラクタ相当の処理

Returns

void

Inherited from

CubismModelSettingJsonMixin.release

replaceFiles()

> replaceFiles(replace): void

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

Replaces the resource files by running each file through the replacer.

Parameters

replace

(file, path) => string

Returns

void

Inherited from

ModelSettings.replaceFiles

resolveURL()

> resolveURL(path): string

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

Resolves a relative path using the url. This is used to resolve the resource files defined in the settings.

Parameters

path

string

Relative path.

Returns

string

Resolved path.

Inherited from

ModelSettings.resolveURL

setModelName()

> protected setModelName(...candidates): void

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

Picks the first non-empty, non-placeholder name from candidates and applies it. Falls back to normalizeName when no candidate is usable.

Parameters

candidates

...(string | undefined)[]

Returns

void

Inherited from

ModelSettings.setModelName

validateFiles()

> validateFiles(files): string[]

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

Validates that the files defined in the settings exist in given files. Each file will be resolved by resolveURL before comparison.

Class: CubismModelSettings