Skip to content

CustomOption

Jump to bottom
riku1227 edited this page Mar 13, 2021 · 5 revisions

説明

カスタムオプションを定義するクラスです
オプションの名前やタイプなどを書きます

構造

キー 値 必須/任意 説明
name 文字列 必須 オプションの名前を設定します
名前を複数言語に対応する場合はここにキーを書いてください
description 文字列 必須 オプションの説明を書く場所です '\n'で改行することができます
説明複数言語に対応する場合はここにキーを書いてください
visible_option 真偽値 任意 オプションをUIに表示するかどうかを設定します
表示されないだけで通常通り処理はされます
ボーン関係の処理などの必須処理に使用されます
デフォルトはtrue(UIに表示)です
option_type 文字列 必須 オプションのタイプを設定します
toggle: オン/オフの設定ができるタイプのオプションです
grid: 複数選択肢の中から一つを選択するタイプのオプションです
is_check 真偽値 任意 オプションがデフォルトでチェックされているかどうかを設定します
オプションタイプがtoggleの時に使用されます
select 数値 任意 オプションのどのグリッドがデフォルトで選択されているかを設定します
0が一番最初になります
オプションタイプがgridの時に使用されます
デフォルトは0です
grid_list 配列(CustomGridOption) 任意 グリッドの中身を設定します
オプションタイプがgridの時に使用されます
display_apply_button 真偽値 任意 オプションに適用ボタンを表示するかどうかを設定します
※詳しくは下に書いています
デフォルトはfalseです
apply_filter_is_avatar_object 真偽値 任意 適用フィルターのオブジェクトがアバターに
デフォルトであるオブジェクトかどうかを設定します
falseの場合は自動的にIDが付与されます
デフォルトはfalse(服側のオブジェクト)です
apply_filter 配列(文字列) 任意 適用ボタンを表示する条件を設定します
※詳しくは下に書いています
display_apply_buttonをtrueにしたときに使用されます
operation_list 配列(CustomOperation) 必須 オプションで実行される処理を設定します

display_apply_button / apply_filterについて

display_apply_buttonとapply_filterはセットで使用されます
display_apply_buttonをtrueにした場合apply_filterを使用して適用ボタンを表示するかどうかを判定します

適用ボタンを表示するようにすることで、服を導入した後からでも一部オプションを変更することができるようになります
主にマテリアルの設定で使用します

画像

setuper_option_type

関連リンク

  • ExpandOption
    • 服の独自オプションを定義するクラス
    • CustomOptionが使用される
  • CustomGridOption
    • グリッドオプションのを定義するクラス
    • CustomOptionで使用する
  • CustomOperation
    • オプションの処理を定義するクラス
    • CustomOptionで使用する

例

説明用にコメントを書いています、本来はJSONファイルにコメントは書けません
RiClothes Setuperの場合読み込み時に正常に読み込めず、エラーが出ます

  • トグルオプション (デフォルトでチェックが付いている)
{
  "name": "トグルオプション",
  "description": "オプションの説明",
  "option_type": "toggle",
  "is_check": true,
  "operation_list": [
    { /* CustomOperation */ },
    { /* CustomOperation */ }
  ]
}
  • トグルオプション (非表示/デフォルトでチェックされている)
    • 非表示オプションの場合デフォルトでチェックを入れないとそのオプションは実行されない
{
  "name": "トグルオプション",
  "description": "オプションの説明",
  "option_type": "toggle",
  "is_check": true,
  "operation_list": [
    { /* CustomOperation */ },
    { /* CustomOperation */ }
  ]
}
  • グリッドプション
{
  "name": "グリッドオプション",
  "option_type": "grid",
  "select": 0,
  "grid_list": [
    { /* CustomGridOption */ },
    { /* CustomGridOption */ },
    { /* CustomGridOption */ }
  ]
  "operation_list": [
    { /* CustomOperation */ },
    { /* CustomOperation */ }
  ]
}
  • グリッドプション(適用ボタンを表示)
    • example_clothというオブジェクトかexample_cloth_hatというオブジェクトが入力されたアバターにあれば適用ボタンを表示する
{
  "name": "グリッドオプション",
  "option_type": "grid",
  "select": 0,
  "display_apply_button": true,
  "apply_filter": [
    "example_cloth",
    "example_cloth_hat"
  ],
  "grid_list": [
    { /* CustomGridOption */ },
    { /* CustomGridOption */ },
    { /* CustomGridOption */ }
  ]
  "operation_list": [
    { /* CustomOperation */ },
    { /* CustomOperation */ }
  ]
}
Clone this wiki locally