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

マスターデータのフォーマットと インポートする各種モデルのリファレンス

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

{
  "version": "2020-08-22",
  "rateModels": [
    {
      "name": "[string]強化レート名",
      "description": "[string?]説明文",
      "metadata": "[string?]メタデータ",
      "targetInventoryModelId": "[string]強化対象に使用できるインベントリモデルのGRN",
      "acquireExperienceSuffix": "[string]GS2-Experience で入手した経験値を格納する プロパティID に付与するサフィックス",
      "materialInventoryModelId": "[string]強化の素材に使用できるインベントリのGRN",
      "acquireExperienceHierarchy": [
        "[string]ItemModelのメタデータに格納する、入手経験値を定義するJSONデータの階層構造の定義"
      ],
      "experienceModelId": "[string]経験値モデルGRN",
      "bonusRates": [
        {
          "rate": "[float]経験値ボーナスの倍率(1.0=ボーナスなし)",
          "weight": "[int]抽選重み"
        }
      ]
    }
  ],
  "unleashRateModels": [
    {
      "name": "[string]限界突破レート名",
      "description": "[string?]説明文",
      "metadata": "[string?]メタデータ",
      "targetInventoryModelId": "[string]限界突破対象に使用できるインベントリ",
      "gradeModelId": "[string]グレードモデル",
      "gradeEntries": [
        {
          "gradeValue": "[long]対象グレード",
          "needCount": "[int]同種のアイテムを何個消費するか"
        }
      ]
    }
  ]
}
有効化条件必須デフォルト値の制限説明
versionstring
2020-08-22マスターデータのフォーマットバージョン
rateModelsList<RateModel>~ 10000 items強化レートモデル
強化レートは強化に使用する素材と強化対象を定義したデータです。

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

強化時に一定の確率で 大成功 といった形で入手できる経験値量に補正値をかけることができます。
その抽選確率もこのエンティティで定義します。
unleashRateModelsList<UnleashRateModel>~ 10000 items限界突破レート
限界突破レートは限界突破の対象と GS2-Grade 限界突破モデルを定義したデータです。
限界突破の対象データは GS2-Inventory で管理されている必要があります。

モデル

RateModel

強化レートモデル

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

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

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

有効化条件必須デフォルト値の制限説明
rateModelIdstring
✓*
~ 1024文字強化レートモデル GRN
※ サーバー側で自動的に設定
namestring
~ 128文字強化レート名
descriptionstring~ 1024文字説明文
metadatastring~ 2048文字メタデータ
targetInventoryModelIdstring
~ 1024文字強化対象に使用できるインベントリモデルの GRN
acquireExperienceSuffixstring
~ 1024文字GS2-Experience で入手した経験値を格納する プロパティID に付与するサフィックス
materialInventoryModelIdstring
~ 1024文字強化の素材に使用できるインベントリの GRN
acquireExperienceHierarchyList<string>0 ~ 10 itemsItemModelのメタデータに格納する、入手経験値を定義するJSONデータの階層構造の定義
GS2-EnhanceにはGS2-Inventoryと連携して強化を行う仕組みがあり、ItemModelのメタデータにJSON形式で、強化素材として使用した場合の経験値量を設定します。
例えば、{ “aaa”: { “bbb”: { “experienceValue”: 100 } } } というような構造のデータ定義でメタデータに設定したい場合は、[ “aaa”, “bbb”, “experienceValue” ] のように指定します。
詳細は マイクロサービス紹介 / GS2-Enhance の項で解説しています。
experienceModelIdstring
~ 1024文字経験値モデル GRN
bonusRatesList<BonusRate>0 ~ 1000 items経験値獲得量ボーナス

BonusRate

経験値獲得量ボーナス

有効化条件必須デフォルト値の制限説明
ratefloat
1.00 ~ 10000経験値ボーナスの倍率(1.0=ボーナスなし)
weightint
10 ~ 2147483645抽選重み

UnleashRateModel

限界突破レート

限界突破レートは限界突破の対象と GS2-Grade 限界突破モデルを定義したデータです。
限界突破の対象データは GS2-Inventory で管理されている必要があります。

有効化条件必須デフォルト値の制限説明
unleashRateModelIdstring
✓*
~ 1024文字限界突破レートモデル GRN
※ サーバー側で自動的に設定
namestring
~ 128文字限界突破レート名
descriptionstring~ 1024文字説明文
metadatastring~ 2048文字メタデータ
targetInventoryModelIdstring
~ 1024文字限界突破対象に使用できるインベントリ
gradeModelIdstring
~ 1024文字グレードモデル
gradeEntriesList<UnleashRateEntryModel>
1 ~ 1000 itemsグレードエントリリスト

UnleashRateEntryModel

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

有効化条件必須デフォルト値の制限説明
gradeValuelong
1 ~ 1000対象グレード
needCountint
1 ~ 1000同種のアイテムを何個消費するか