> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Grade API リファレンス

グレード・レアリティ機能




キャラクターや装備のグレード (レアリティ) を管理し、グレードアップによって GS2-Experience のランクキャップを引き上げる仕組みを提供します。

キャラクターや装備の育成では経験値を積み重ねてレベルアップしますが、レベルには上限があります。<br>
GS2-Grade でグレードを上げると、その上限であるランクキャップが引き上げられ、より高いレベルまで育成できるようになります。<br>
いわゆる限界突破や進化にあたる成長要素を実現するためのサービスです。

グレードは、キャラクターや装備のような対象を一意に指す `propertyId` ごとに `Status` として管理され、0 から始まる整数の `gradeValue` で現在のグレードを保持します。<br>
グレードモデルには `gradeEntries` として、グレードごとに GS2-Experience のランクキャップへ設定する値 (`rankCapValue`) を定義します。<br>
グレードが変化した際のランクキャップの同期は自動的に行われますが、グレードモデル自体を更新した場合は `ApplyRankCap` を呼び出すことで既存のステータスへ反映できます。

プロパティIDが正規表現にマッチするかによって初期グレードの値を設定できます。<br>
例えば、GS2-Inventory の ItemModel の名前が SSR から始まる場合はグレード3、SR から始まる場合はグレード2で開始するようにすることで<br>
ItemModel の種類によって初期のランクキャップを変えることが可能です。

グレードアップの方法として「同種のキャラクターや装備を合成する」ケースで、素材として使用しようとしているリソースが「同種のキャラクターや装備」であるかを判定する処理をサポートする機能が用意されています。<br>
`propertyIdRegex` でグレードのプロパティIDからユーザーIDや ItemModel 名などのパラメーターを取り出し、それを `gradeUpPropertyIdRegex` に埋め込んで正規表現を構築したうえで、素材として使用しようとしているリソースのプロパティIDがマッチするかを判定することで実現します。

グレードモデルには `acquireActionRates` を設定でき、グレードに応じて入手アクションの報酬量を調整できます。<br>
これを利用することで、「高グレードのキャラクターはクエスト報酬の獲得量が増える」「グレードごとに経験値倍率が変化する」といった成長要素を組み込めます。

トランザクションの入手アクションに `Gs2Grade:MultiplyAcquireActionsByUserId` を組み込むことで、指定したグレードの倍率を適用した入手アクションのリストへ変換できます。

[マイクロサービス紹介 / GS2-Grade](../../microservices/grade)



- [GS2-Grade Deploy/CDK リファレンス](/ja/api_reference/grade/deploy/)
  
- [GS2-Grade SDK API リファレンス](/ja/api_reference/grade/sdk/)
  
- [GS2-Grade SDK for Game Engine API リファレンス](/ja/api_reference/grade/game_engine/)
  
- [GS2-Grade スクリプト トリガー リファレンス](/ja/api_reference/grade/script/)
  
- [GS2-Grade トランザクションアクション](/ja/api_reference/grade/stamp_sheet/)
  
- [GS2-Grade マスターデータリファレンス](/ja/api_reference/grade/master_data/)