GS2-Enhance マスターデータリファレンス

マスターデータのフォーマット

• JSON

{
  "version": "2020-08-22",
  "rateModels": [
    {
      "name": "[string]強化レートモデル名",
      "description": "[string?]説明文",
      "metadata": "[string?]メタデータ",
      "targetInventoryModelId": "[string]強化対象に使用できる GS2-Inventory インベントリモデルの GRN",
      "acquireExperienceSuffix": "[string]GS2-Experience で入手した経験値を格納するプロパティID に付与するサフィックス",
      "materialInventoryModelId": "[string]強化の素材に使用できる GS2-Inventory インベントリモデル GRN",
      "acquireExperienceHierarchy": [
        "[string]ItemModelのメタデータに格納する、入手経験値を定義するJSONデータの階層構造の定義"
      ],
      "experienceModelId": "[string]強化の結果得られる GS2-Experience 経験値モデル GRN",
      "bonusRates": [
        {
          "rate": "[float]経験値ボーナスの倍率 (1.0 = ボーナスなし)",
          "weight": "[int]抽選重み"
        }
      ]
    }
  ],
  "unleashRateModels": [
    {
      "name": "[string]限界突破レートモデル名",
      "description": "[string?]説明文",
      "metadata": "[string?]メタデータ",
      "targetInventoryModelId": "[string]限界突破対象に使用できる GS2-Inventory インベントリモデル GRN",
      "gradeModelId": "[string]グレードモデル GRN",
      "groupKeyHierarchy": [
        "[string]ItemModel のメタデータに格納する、グループキーを定義する JSON データの階層構造"
      ],
      "gradeEntries": [
        {
          "gradeValue": "[long]対象グレード",
          "type": "[string]素材条件の種類",
          "needCount": "[int]同種のアイテムを何個消費するか",
          "recipes": [
            {
              "name": "[string]レシピ名",
              "metadata": "[string?]メタデータ",
              "targetGroupKeys": [
                "[string]グループキー"
              ],
              "materials": [
                {
                  "name": "[string]素材名",
                  "materialType": "[string]素材の種類",
                  "individualSetting": {
                    "matchType": "[string]素材と限界突破対象の一致条件",
                    "gradeCondition": "[string]素材のグレード条件",
                    "gradeValue": "[long]素材に求めるグレード",
                    "count": "[int]消費するアイテムセットの数"
                  },
                  "quantitySetting": {
                    "matchType": "[string]消費するアイテムモデルの決め方",
                    "materialInventoryModelId": "[string]素材を探す GS2-Inventory インベントリモデル GRN",
                    "itemModelId": "[string]消費する GS2-Inventory アイテムモデル GRN",
                    "count": "[int]消費する数量"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

モデル

RateModel

強化レートモデル

強化レートは強化に使用する素材と強化対象を定義したデータです。

素材データ、強化対象データは共に GS2-Inventory で管理されている必要があります。
強化で得られる経験値は GS2-Inventory のメタデータにJSON形式で記録します。
ここではメタデータのどの階層に経験値の値が格納されているかを記載する必要があります。

強化時に一定の確率で 大成功 といった形で入手できる経験値量に補正値をかけることができます。
その抽選確率もこのエンティティで定義します。

targetInventoryModelId には強化対象となるアイテムを保持するインベントリモデルを、materialInventoryModelId には素材として使用できるアイテムを保持するインベントリモデルを指定します。
両者は別のインベントリモデルにできるため、キャラクターを強化対象とし、強化専用アイテムを素材とするような構成が可能です。

各素材が提供する経験値は素材アイテムのアイテムモデルのメタデータに記述し、その JSON のどこに値が入っているかを acquireExperienceHierarchy で指定します。
{ "aaa": { "bbb": { "experienceValue": 100 } } } のような構造であれば [ "aaa", "bbb", "experienceValue" ] と指定します。階層は最大10段まで指定できます。

得られた経験値は experienceModelId で指定した GS2-Experience の経験値モデルに加算されます。
加算先のプロパティIDは、強化対象アイテムのプロパティIDに acquireExperienceSuffix を付与したものになります。これにより、1つのアイテムにキャラクターレベルの level と好感度の like のような複数種類の経験値を持たせられます。

bonusRates には、獲得経験値にかける倍率の重み付き抽選を定義します。
各エントリーは倍率（1.5 なら150%）と排出重みを持ち、強化を実行するたびに重み付き抽選で1つが選ばれます。エントリーは最大1,000件まで登録できます。

BonusRate

経験値獲得量ボーナス

強化時の経験値ボーナス倍率を決定する重み付き抽選の単一エントリを定義します。異なる倍率と重みを持つ複数のエントリを設定することで、制御された確率による「大成功」や「超成功」の仕組みを実装できます。

UnleashRateModel

限界突破レートモデル

アイテムの限界突破（解放）条件を定義します。

ここでいう限界突破とは、同種のアイテムを素材として消費することで GS2-Grade で管理するグレードを引き上げる強化処理です。
グレードが上がると GS2-Experience 側のランクキャップが引き上げられ、対象をより高いレベルまで育成できるようになります。

targetInventoryModelId には、限界突破の対象となるアイテムを保持する GS2-Inventory のインベントリモデルを指定します。
限界突破するアイテムと、素材として消費する同種アイテムの両方がこのインベントリモデルに属している必要があります。
gradeModelId には、対象アイテムのグレードを追跡する GS2-Grade のグレードモデルを指定します。限界突破に成功すると、そのグレードが1引き上げられます。

gradeEntries には、各グレードに到達するために消費する同種アイテムの数をグレードごとに定義します。エントリーは1件以上1,000件まで登録できます。
たとえばグレード1は1個、グレード2は3個のように設定することで、限界突破の段階ごとにコストを個別に制御できます。

素材として消費したリソースは、そのリソースが保持していた内容ごと失われます。
素材が経験値などのリソースを持っていたとしても対象へは引き継がれないため、引き継ぎが必要な場合は事前に引き継ぎ用のリソースへ変換しておく必要があります。

UnleashRateEntryModel

限界突破レートエントリモデル

限界突破の進行における単一グレードレベルの素材コストを定義します。各エントリは対象となるグレード値と、そのグレードを達成するために消費する必要がある同種アイテムの数を指定します。

UnleashRecipe

限界突破レシピ

グレードを1段引き上げる方法の1つです。グレードエントリに複数のレシピがある場合、プレイヤーはそのうち1つを選び、選んだレシピの素材はすべて必要になります。

UnleashMaterial

限界突破素材

レシピが必要とする素材の1種類を定義します。
「個体(individual)」は、装備の複製のように、プレイヤーが選んだアイテムセットを消費します。
「数量(quantity)」は、汎用強化素材のように、設定で決まるアイテムを数量で消費します。

UnleashIndividualMaterialSetting

個体素材設定

装備の複製のように、アイテムセットを個体として消費する素材を定義します。
どのアイテムセットを消費するかはプレイヤーが選び、選ばれたアイテムセットは限界突破対象のアイテムと同じインベントリモデルに属している必要があります。
個体ごとに GS2-Grade のグレードを持てるため、素材のグレードを条件にすることもできます。

UnleashQuantityMaterialSetting

数量素材設定

汎用強化素材のように、数量で消費する素材を定義します。
プレイヤーはアイテムを選ばず、消費するアイテムモデルはこの設定で決まり、指定した数量が消費されます。
GS2-Inventory の通常のインベントリとシンプルインベントリの両方を使用できます。