manifest reference

このページでは、サブキャラの基本設定を行う manifest.json に定義可能な値の一覧を記載します。

JSON全体の例については サブキャラの基本設定を定義する 等を参照して下さい。

基本データ

基本データはいずれも定義が必須の項目です。

フィールド名	型	説明
id	string	一意な識別子。パッケージやアセットの識別に使用します。
displayName	object	表示名。GUI上で表示されます。
creator	string	作成者名です。
version	string	バージョン番号です。
creatorUrl	string	作成者のWebページやSNSなどへのリンクです。
property	array	プロパティ一覧です。 (後述)

id は com.team.buddyName のような形式で定義することを推奨していますが、必須ではありません。

displayName では jaとenをキーとしたローカライズ文字列です。

"displayName": {
  "ja": "日本語のラベル",
  "en": "English Label"
}

プロパティ定義

フィールド名	型	説明
name	string	プロパティ名です。スクリプトからプロパティ値を取得するときのキーとして使用します。
displayName	object	GUI上に表示される名称です。
description	object	有効なデータを指定した場合、ヘルプアイコンを通じて追加説明を提示します。
type	string	プロパティの種類です。(後述)
boolData	object	type が bool の場合のプロパティの詳細を指定します。
intData	object	type が int の場合のプロパティの詳細を指定します。
floatData	object	type が float の場合のプロパティの詳細を指定します。
stringData	object	type が string の場合のプロパティの詳細を指定します。
vector2Data	object	type が vector2 の場合のプロパティの詳細を指定します。
vector3Data	object	type が vector3 の場合のプロパティの詳細を指定します。
quaternionData	object	type が quaternion の場合のプロパティの詳細を指定します。
transform2DData	object	type が transform2D の場合のプロパティの詳細を指定します。
transform3DData	object	type が transform3D の場合のプロパティの詳細を指定します。

name, type は必須であり、それ以外の値は省略可能です。

displayName, description はいずれも ja, enをキーとするローカライズ文字列です。

"displayName": {
  "ja": "日本語のラベル",
  "en": "English Label"
}

type では以下のいずれかの値を指定します。

• bool
• int
• float
• string
• vector2
• vector3
• quaternion
• transform2D
• transform3D
• action

以降のセクションでは type に応じたデータ定義の例を個別に示します。いずれのデータも省略可能です。

boolData

フィールド名	型	説明
defaultValue	bool	ユーザーが値を編集していないときのデフォルト値です。

boolData を省略するか、または defaultValue を省略した場合、デフォルト値が false であるものとして扱われます。

intData

フィールド名	型	説明
defaultValue	int	ユーザーが値を編集していないときのデフォルト値です。
min	int	ユーザーに最小値/最大値つきのUIを提示するときの最小値です。
max	int	ユーザーに最小値/最大値つきのUIを提示するときの最大です。
options	[string]	ユーザーにドロップダウンとしてオプションを提示する場合の、各オプションの名称です。

intData を省略するか、または defaultValue を省略した場合、デフォルト値が 0 であるものとして扱われます。

その他のオプションは以下の性質を持ちます。

• min / max を双方とも定義した場合、GUI上にはスライダーUIが表示されます。
• options を定義した場合、GUI上には複数の選択肢から選べるようなドロップダウンUIが表示されます。
  • このとき、実際の int の値としては、ドロップダウンの最初の項目から順に 0, 1, 2, ... の値が適用されます。

floatData

フィールド名	型	説明
defaultValue	float	ユーザーが値を編集していないときのデフォルト値です。
min	float	ユーザーに最小値/最大値つきのUIを提示するときの最小値です。
max	float	ユーザーに最小値/最大値つきのUIを提示するときの最大です。

floatData を省略するか、または defaultValue を省略した場合、デフォルト値が 0 であるものとして扱われます。

その他のオプションは以下の性質を持ちます。

• min / max を双方とも定義した場合、GUI上にはスライダーUIが表示されます。

stringData

フィールド名	型	説明
defaultValue	float	ユーザーが値を編集していないときのデフォルト値です。
isFilePath	bool	このプロパティをファイルパス扱いしたい場合、true を指定します。

stringData を省略するか、または defaultValue を省略した場合、デフォルト値が空文字列 "" であるものとして扱われます。

その他のオプションは以下の性質を持ちます。

• isFilePath に true を指定した場合、UI上ではテキスト編集に加えて、ファイル選択ダイアログを表示するボタンを追加で表示します。

vector2Data

フィールド名	型	説明
defaultValue	object	ユーザーが値を編集していないときのデフォルト値です。

vector2Data を省略するか、または defaultValue を省略した場合、デフォルト値がゼロベクトルとして扱われます。

defaultValueは x, yをキーとした値で指定します。

{
  "x": 1.0,
  "y": 2.0
}

vector3Data

フィールド名	型	説明
defaultValue	object	ユーザーが値を編集していないときのデフォルト値です。

vector3Data を省略するか、または defaultValue を省略した場合、デフォルト値がゼロベクトルとして扱われます。

defaultValueは x, y, zをキーとした値で指定します。

{
  "x": 1.0,
  "y": 2.0,
  "y": 2.0
}

quaternionData

フィールド名	型	説明
defaultValue	object	ユーザーが値を編集していないときのデフォルト値です。

quaternionData を省略するか、または defaultValue を省略した場合、デフォルト値は回転を行わないようなクォータニオンとして扱われます。

defaultValueは x, y, zをキーとした値で指定します。この値は、YXZの順で回転を行うオイラー角の角度(deg)として指定します。

{
  "x": 10.0,
  "y": 20.0,
  "z": 30.0
}

transform2DData

フィールド名	型	説明
defaultValue	object	ユーザーが値を編集していないときのデフォルト値です。

transform2DData を省略するか、または defaultValue を省略した場合、デフォルト値として画面にある程度収まるような適当な数値が指定されているように扱われます。

defaultValueは以下のような構造のobjectです。

• position: デフォルトの位置を x と y を指定します。座標は、アバターウィンドウ全体のサイズがおおよそ 1280x720 であり、左下を (0, 0) であるとしたときの座標で指定します。
• rotation: 回転をオイラー角表現として x, y, z で指定します。通常、2Dの画像では全ての値を0のままにするか、またはzを指定することで画像を回転させた状態をデフォルトにできます。
• scale: スケールです。省略すると 1 として扱われます。

{
  "position": {
    "x": 300,
    "y": 100
  },
  "rotationn": {
    "x": 0.0,
    "y": 0.0,
    "z": 20.0
  },
  "scale": 1
}

transform3DData

フィールド名	型	説明
defaultValue	object	ユーザーが値を編集していないときのデフォルト値です。

transform3DData を省略するか、または defaultValue を省略した場合、デフォルト値として画面にある程度収まるような適当な数値が指定されているように扱われます。

defaultValueは以下のような構造のobjectです。

• parentBone: HumanBodyBonesの名称を指定することで、このTransformがアタッチされるメインアバターのボーンを指定します。
• position: デフォルトの位置を x, y, z で指定します。この座標は、空間上のワールド座標の位置、またはとして扱われます。
• rotation: 回転をオイラー角表現として x, y, z で指定します。
• scale: スケールです。省略すると 1 として扱われます。

{
  "parentBone": "Head",
  "position": {
    "x": 0.0,
    "y": 0.3,
    "z": 0.0
  },
  "rotationn": {
    "x": 0.0,
    "y": 10.0,
    "z": 0.0
  },
  "scale": 1
}