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

# GS2-Idle API リファレンス

放置報酬機能




放置報酬を実現するためのサービスです。<br>
ゲームをプレイしていない時間に応じて報酬を獲得できる仕組みを実現します。

放置報酬は複数用意することができます。<br>
プレイヤーはカテゴリー毎に1つの待機時間を持つことができます。

カテゴリーは「キャラクターのスタミナ自然回復」「採掘場の自動採掘」「素材の自動生成」など、それぞれ独立した放置報酬の単位として活用できます。

カテゴリーには、放置時間が何分経過するごとに報酬を得られるかと、放置時間の最大値の初期値を設定できます。<br>
放置時間の最大値はプレイヤーごとに引き上げることが可能です。報酬受取後に未消化の待機時間をリセットするか次回に持ち越すかは `rewardResetMode` で選択できます。

放置報酬には放置時間が一定時間経過すると得られるアイテムの一覧を定義します。<br>
付与する報酬は、「経験値＋アイテム」のように複数(最大10個)設定することができます。

報酬の内容にもっとランダム性を持たせたいことがあります。<br>
そのような場合には、報酬に GS2-Lottery の抽選処理を設定してください。

イベントと連動した放置報酬を実装できるように、カテゴリー毎に GS2-Schedule のイベントと関連づけることができます。

GS2-Buff を利用すると、カテゴリーモデルの `acquireActions` やプレイヤーごとの `maximumIdleMinutes` をバフで補正し、イベントやキャンペーンに応じて待機中報酬の内容や上限時間を動的に調整できます。

たとえば「週末は放置報酬 1.5 倍」「特定の称号を持っているプレイヤーは最大放置時間 +60 分」といった運用が可能です。

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



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