GS2-Grade マスターデータリファレンス
マスターデータのフォーマットと インポートする各種モデルのリファレンス
{
  "version": "2023-12-25",
  "gradeModels": [
    {
      "name": "[string]グレードモデル名",
      "metadata": "[string?]メタデータ",
      "defaultGrades": [
        {
          "propertyIdRegex": "[string]デフォルト値を適用するプロパティIDの正規表現",
          "defaultGradeValue": "[long]デフォルトのグレード値"
        }
      ],
      "experienceModelId": "[string]グレードとランクキャップを連動させる経験値モデルGRN",
      "gradeEntries": [
        {
          "metadata": "[string?]メタデータ",
          "rankCapValue": "[long]GS2-Experience に設定するランクキャップ値",
          "propertyIdRegex": "[string]プロパティIDからグレードアップに使用可能なリソースを特定するための変数を取り出すための正規表現",
          "gradeUpPropertyIdRegex": "[string]グレードアップに利用可能なリソースのプロパティIDの正規表現"
        }
      ],
      "acquireActionRates": [
        {
          "name": "[string]報酬加算テーブル名",
          "mode": "[string]報酬加算テーブルの種類",
          "rates": [
            "[double]加算量(倍率)"
          ],
          "bigRates": [
            "[string]加算量(倍率)"
          ]
        }
      ]
    }
  ]
}
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| version | ✓ | 2023-12-25 | マスターデータのフォーマットバージョン | |||
| gradeModels | List<GradeModel> | ~ 100 items | グレードモデル | 
GradeModel
グレードモデル
グレードとは、キャラクターや装備のランクを示すエンティティで、グレードによって GS2-Experience のランクキャップを設定することができます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| gradeModelId | string | ✓ | ~ 1024文字 | グレードモデルGRN | ||
| name | string | ✓ | ~ 128文字 | グレードモデル名 | ||
| metadata | string | ~ 2048文字 | メタデータ | |||
| defaultGrades | List<DefaultGradeModel> | 0 ~ 100 items | デフォルトグレードモデルリスト | |||
| experienceModelId | string | ✓ | ~ 1024文字 | グレードとランクキャップを連動させる経験値モデルGRN | ||
| gradeEntries | List<GradeEntryModel> | ✓ | 1 ~ 100 items | グレードエントリリスト | ||
| acquireActionRates | List<AcquireActionRate> | 0 ~ 100 items | 報酬加算テーブルリスト | 
DefaultGradeModel
デフォルトグレードモデル
グレードを新規作成する際にプロパティIDの正規表現へのマッチに応じてデフォルトのグレード値を設定することができます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| propertyIdRegex | string | ✓ | ~ 1024文字 | デフォルト値を適用するプロパティIDの正規表現 | ||
| defaultGradeValue | long | ✓ | 0 ~ 9223372036854775805 | デフォルトのグレード値 | 
GradeEntryModel
グレードエントリ
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| metadata | string | ~ 2048文字 | メタデータ | |||
| rankCapValue | long | ✓ | 0 ~ 9223372036854775805 | GS2-Experience に設定するランクキャップ値 | ||
| propertyIdRegex | string | ✓ | ~ 1024文字 | プロパティIDからグレードアップに使用可能なリソースを特定するための変数を取り出すための正規表現 | ||
| gradeUpPropertyIdRegex | string | ✓ | ~ 1024文字 | グレードアップに利用可能なリソースのプロパティIDの正規表現 | 
AcquireActionRate
報酬加算テーブルマスター
グレードに応じて報酬の量を調整することができます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | 報酬加算テーブル名 | ||||||||
| mode | 文字列列挙型 enum { “double”, “big” } | ✓ | “double” | ~ 128文字 | 報酬加算テーブルの種類 
 | |||||||
| rates | List<double> | {mode} == “double” | ✓ | 1 ~ 1000 items | グレードごとの加算量(倍率) | |||||||
| bigRates | List<string> | {mode} == “big” | ✓ | 1 ~ 1000 items | グレードごとの加算量(倍率) | 
AcquireAction
入手アクション
VerifyActionResult
検証アクションの実行結果
ConsumeActionResult
消費アクションの実行結果
AcquireActionResult
入手アクションの実行結果
TransactionResult
トランザクション実行結果
サーバーサイドでのトランザクションの自動実行機能を利用して実行されたトランザクションの実行結果
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| transactionId | string | ✓ | 36 ~ 36文字 | トランザクションID | ||
| verifyResults | List<VerifyActionResult> | 0 ~ 10 items | 検証アクションの実行結果リスト | |||
| consumeResults | List<ConsumeActionResult> | [] | 0 ~ 10 items | 消費アクションの実行結果リスト | ||
| acquireResults | List<AcquireActionResult> | [] | 0 ~ 100 items | 入手アクションの実行結果リスト | ||
| hasError | bool | ✓ | false | トランザクション実行中にエラーが発生したかどうか |