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

# GS2-Experience API リファレンス

経験値・ランク機能




キャラクターやスキルのレベル、親愛度など、経験値を積み重ねてランクアップしていく仕組みの実現に使用します。<br>
ランクキャップ機能も有しており、キャラクターやスキルなど個別の要素ごとに上限管理を行うことができます。

GS2-Experience は経験値の値から自動的にランクの値を計算します。<br>
そのためには、マスターデータを利用してランクアップの閾値となる経験値テーブルを定義する必要があります。<br>
ExperienceModel でランクアップ閾値を管理し、その下に任意の値を持つプロパティIDをぶら下げることができます。<br>
プロパティIDごとに経験値の値は管理され、経験値の値に基づいてランクが決定します。

たとえば「キャラクターの種類ごとに必要経験値テーブルを変えたい」「キャラクター個別にランクキャップを変えたい」といったケースで、ExperienceModel をキャラクター種別ごとに用意し、プロパティID にキャラクターの個別 ID を割り当てることで実現できます。

ランクには上限を設定可能です。<br>
ランクの上限に達した状態で経験値を入手した場合、経験値は破棄されます。

ランクの上限は ExperienceModel で初期値を設定しますが、プロパティIDごとに個別に引き上げることが可能です。<br>
これにより限界突破の強化をおこなうと、ランクキャップを引き上げるような仕様を実現することが可能です。

`nextRankUpExperienceValue` をクライアントで参照することで、ランクアップまでに必要な経験値の表示や進捗バーの描画を簡単に行えます。

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



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