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

マスターデータのフォーマットと インポートする各種モデルのリファレンス
{
  "version": "2023-07-18",
  "balanceParameterModels": [
    {
      "name": "[string]バランスパラメーターモデル名",
      "metadata": "[string?]メタデータ",
      "totalValue": "[long]合計値",
      "initialValueStrategy": "[string]初期値の設定方針",
      "parameters": [
        {
          "name": "[string]名前",
          "metadata": "[string?]メタデータ"
        }
      ]
    }
  ],
  "rarityParameterModels": [
    {
      "name": "[string]レアリティパラメーターモデル名",
      "metadata": "[string?]メタデータ",
      "maximumParameterCount": "[int]付与するパラメーターの最大数",
      "parameterCounts": [
        {
          "count": "[int]値",
          "weight": "[int]排出重み"
        }
      ],
      "parameters": [
        {
          "name": "[string]名前",
          "metadata": "[string?]メタデータ",
          "resourceName": "[string]ゲーム内で使用するパラメーターリソースの種類を表す名前(GS2の動作のためには使用しません)",
          "resourceValue": "[long]ゲーム内で使用するパラメーターリソースの値(GS2の動作のためには使用しません)",
          "weight": "[int]排出重み"
        }
      ]
    }
  ]
}
有効化条件必須デフォルト値の制限説明
version
2023-07-18マスターデータのフォーマットバージョン
balanceParameterModelsList<BalanceParameterModel>~ 10000 itemsバランスパラメーターモデル
rarityParameterModelsList<RarityParameterModel>~ 10000 itemsレアリティパラメーターモデル

BalanceParameterModel

バランスパラメーターモデル

バランスパラメーターの抽選条件を定義します。

有効化条件必須デフォルト値の制限説明
balanceParameterModelIdstring
~ 1024文字バランスパラメーターモデルGRN
namestring
~ 128文字バランスパラメーターモデル名
metadatastring~ 2048文字メタデータ
totalValuelong
~ 9223372036854775805合計値
initialValueStrategyenum {
    “average”,
    “lottery”
}
“average”~ 128文字初期値の設定方針
parametersList<BalanceParameterValueModel>
1 ~ 10 itemsバランスパラメーター値モデルのリスト

initialValueStrategy に指定する列挙型の定義

定義説明
average平均値
lottery抽選

RarityParameterModel

レアリティパラメーターモデル

レアリティパラメーターの抽選条件を定義します。

有効化条件必須デフォルト値の制限説明
rarityParameterModelIdstring
~ 1024文字レアリティパラメーターモデルGRN
namestring
~ 128文字レアリティパラメーターモデル名
metadatastring~ 2048文字メタデータ
maximumParameterCountint
1 ~ 10付与するパラメーターの最大数
parameterCountsList<RarityParameterCountModel>
1 ~ 10 itemsレアリティパラメーターの付与数モデルのリスト
parametersList<RarityParameterValueModel>
1 ~ 1000 itemsレアリティパラメーター値モデルのリスト

BalanceParameterValueModel

バランスパラメーター値モデル

有効化条件必須デフォルト値の制限説明
namestring
~ 64文字名前
metadatastring~ 512文字メタデータ

RarityParameterCountModel

レアリティパラメーターの付与数モデル

有効化条件必須デフォルト値の制限説明
countint
~ 10
weightint
1 ~ 2147483646排出重み

RarityParameterValueModel

バランスパラメーター値モデル

有効化条件必須デフォルト値の制限説明
namestring
~ 64文字名前
metadatastring~ 512文字メタデータ
resourceNamestring
~ 64文字ゲーム内で使用するパラメーターリソースの種類を表す名前(GS2の動作のためには使用しません)
resourceValuelong
~ 9223372036854775805ゲーム内で使用するパラメーターリソースの値(GS2の動作のためには使用しません)
weightint
1 ~ 2147483646排出重み

BalanceParameterValue

バランスパラメーター値モデル

有効化条件必須デフォルト値の制限説明
namestring
~ 64文字名前
valuelong
~ 9223372036854775805

RarityParameterValue

レアリティパラメーター値モデル

有効化条件必須デフォルト値の制限説明
namestring
~ 64文字名前
resourceNamestring
~ 64文字リソースの名前
resourceValuelong
~ 9223372036854775805リソースの値

VerifyActionResult

検証アクションの実行結果

有効化条件必須デフォルト値の制限説明
actionenum {
"Gs2Dictionary:VerifyEntryByUserId",
"Gs2Distributor:IfExpressionByUserId",
"Gs2Distributor:AndExpressionByUserId",
"Gs2Distributor:OrExpressionByUserId",
"Gs2Enchant:VerifyRarityParameterStatusByUserId",
"Gs2Experience:VerifyRankByUserId",
"Gs2Experience:VerifyRankCapByUserId",
"Gs2Grade:VerifyGradeByUserId",
"Gs2Grade:VerifyGradeUpMaterialByUserId",
"Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
"Gs2Guild:VerifyIncludeMemberByUserId",
"Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId",
"Gs2Inventory:VerifyItemSetByUserId",
"Gs2Inventory:VerifyReferenceOfByUserId",
"Gs2Inventory:VerifySimpleItemByUserId",
"Gs2Inventory:VerifyBigItemByUserId",
"Gs2Limit:VerifyCounterByUserId",
"Gs2Matchmaking:VerifyIncludeParticipantByUserId",
"Gs2Mission:VerifyCompleteByUserId",
"Gs2Mission:VerifyCounterValueByUserId",
"Gs2Ranking2:VerifyGlobalRankingScoreByUserId",
"Gs2Ranking2:VerifyClusterRankingScoreByUserId",
"Gs2Ranking2:VerifySubscribeRankingScoreByUserId",
"Gs2Schedule:VerifyTriggerByUserId",
"Gs2Schedule:VerifyEventByUserId",
"Gs2SerialKey:VerifyCodeByUserId",
"Gs2Stamina:VerifyStaminaValueByUserId",
"Gs2Stamina:VerifyStaminaMaxValueByUserId",
"Gs2Stamina:VerifyStaminaRecoverIntervalMinutesByUserId",
"Gs2Stamina:VerifyStaminaRecoverValueByUserId",
"Gs2Stamina:VerifyStaminaOverflowValueByUserId",
}
~ 128文字検証アクションで実行するアクションの種類
verifyRequeststring
~ 524288文字リクエストのJSON
statusCodeint~ 999ステータスコード
verifyResultstring~ 1048576文字結果内容

ConsumeActionResult

消費アクションの実行結果

有効化条件必須デフォルト値の制限説明
actionenum {
"Gs2AdReward:ConsumePointByUserId",
"Gs2Dictionary:DeleteEntriesByUserId",
"Gs2Enhance:DeleteProgressByUserId",
"Gs2Exchange:DeleteAwaitByUserId",
"Gs2Experience:SubExperienceByUserId",
"Gs2Experience:SubRankCapByUserId",
"Gs2Formation:SubMoldCapacityByUserId",
"Gs2Grade:SubGradeByUserId",
"Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:DecreaseMaximumIdleMinutesByUserId",
"Gs2Inbox:OpenMessageByUserId",
"Gs2Inbox:DeleteMessageByUserId",
"Gs2Inventory:ConsumeItemSetByUserId",
"Gs2Inventory:ConsumeSimpleItemsByUserId",
"Gs2Inventory:ConsumeBigItemByUserId",
"Gs2JobQueue:DeleteJobByUserId",
"Gs2Limit:CountUpByUserId",
"Gs2LoginReward:MarkReceivedByUserId",
"Gs2Mission:ReceiveByUserId",
"Gs2Mission:BatchReceiveByUserId",
"Gs2Mission:DecreaseCounterByUserId",
"Gs2Mission:ResetCounterByUserId",
"Gs2Money:WithdrawByUserId",
"Gs2Money:RecordReceipt",
"Gs2Money2:WithdrawByUserId",
"Gs2Money2:VerifyReceiptByUserId",
"Gs2Quest:DeleteProgressByUserId",
"Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId",
"Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId",
"Gs2Schedule:DeleteTriggerByUserId",
"Gs2SerialKey:UseByUserId",
"Gs2Showcase:IncrementPurchaseCountByUserId",
"Gs2SkillTree:MarkRestrainByUserId",
"Gs2Stamina:DecreaseMaxValueByUserId",
"Gs2Stamina:ConsumeStaminaByUserId",
}
~ 128文字消費アクションで実行するアクションの種類
consumeRequeststring
~ 524288文字リクエストのJSON
statusCodeint~ 999ステータスコード
consumeResultstring~ 1048576文字結果内容

AcquireActionResult

入手アクションの実行結果

有効化条件必須デフォルト値の制限説明
actionenum {
"Gs2AdReward:AcquirePointByUserId",
"Gs2Dictionary:AddEntriesByUserId",
"Gs2Enchant:ReDrawBalanceParameterStatusByUserId",
"Gs2Enchant:SetBalanceParameterStatusByUserId",
"Gs2Enchant:ReDrawRarityParameterStatusByUserId",
"Gs2Enchant:AddRarityParameterStatusByUserId",
"Gs2Enchant:SetRarityParameterStatusByUserId",
"Gs2Enhance:DirectEnhanceByUserId",
"Gs2Enhance:UnleashByUserId",
"Gs2Enhance:CreateProgressByUserId",
"Gs2Exchange:ExchangeByUserId",
"Gs2Exchange:IncrementalExchangeByUserId",
"Gs2Exchange:CreateAwaitByUserId",
"Gs2Exchange:AcquireForceByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Friend:UpdateProfileByUserId",
"Gs2Grade:AddGradeByUserId",
"Gs2Grade:ApplyRankCapByUserId",
"Gs2Grade:MultiplyAcquireActionsByUserId",
"Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"Gs2Idle:ReceiveByUserId",
"Gs2Inbox:SendMessageByUserId",
"Gs2Inventory:AddCapacityByUserId",
"Gs2Inventory:SetCapacityByUserId",
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetWithGradeByUserId",
"Gs2Inventory:AddReferenceOfByUserId",
"Gs2Inventory:DeleteReferenceOfByUserId",
"Gs2Inventory:AcquireSimpleItemsByUserId",
"Gs2Inventory:SetSimpleItemsByUserId",
"Gs2Inventory:AcquireBigItemByUserId",
"Gs2Inventory:SetBigItemByUserId",
"Gs2JobQueue:PushByUserId",
"Gs2Limit:CountDownByUserId",
"Gs2Limit:DeleteCounterByUserId",
"Gs2LoginReward:DeleteReceiveStatusByUserId",
"Gs2LoginReward:UnmarkReceivedByUserId",
"Gs2Lottery:DrawByUserId",
"Gs2Lottery:ResetBoxByUserId",
"Gs2Mission:RevertReceiveByUserId",
"Gs2Mission:IncreaseCounterByUserId",
"Gs2Mission:SetCounterByUserId",
"Gs2Money:DepositByUserId",
"Gs2Money:RevertRecordReceipt",
"Gs2Money2:DepositByUserId",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2Schedule:ExtendTriggerByUserId",
"Gs2Script:InvokeScript",
"Gs2SerialKey:RevertUseByUserId",
"Gs2SerialKey:IssueOnce",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
}
~ 128文字入手アクションで実行するアクションの種類
acquireRequeststring
~ 524288文字リクエストのJSON
statusCodeint~ 999ステータスコード
acquireResultstring~ 1048576文字結果内容

TransactionResult

トランザクション実行結果

サーバーサイドでのトランザクションの自動実行機能を利用して実行されたトランザクションの実行結果

有効化条件必須デフォルト値の制限説明
transactionIdstring
36 ~ 36文字トランザクションID
verifyResultsList<VerifyActionResult>~ 10 items検証アクションの実行結果リスト
consumeResultsList<ConsumeActionResult>[]~ 10 items消費アクションの実行結果リスト
acquireResultsList<AcquireActionResult>[]~ 100 items入手アクションの実行結果リスト
hasErrorbool
falseトランザクション実行中にエラーが発生したかどうか