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

# GS2-Idle スクリプト トリガー リファレンス

拡張スクリプトを呼び出すイベントトリガーのリファレンス



## トリガー

### receive

報酬受け取り
**関連するメソッド:**
receive - 報酬を受け取る


#### 同期実行スクリプト

報酬受け取り処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| category | [CategoryModel](../sdk/#categorymodel) | カテゴリーモデル |
| userId | string | 報酬受け取りを実行しているユーザーID |
| status | [Status](../sdk/#status) | ステータス |
| acquireActions | [AcquireAction[]](../sdk/#acquireaction) | 報酬 |
| config | [Config[]](../sdk/#config) | トランザクションの変数に適用する設定値 |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | 報酬受け取りを許可するか |
| rate | float |  | 1.0 | 0 ~ 1000 | 入手量の倍率 |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local category = args.category
local userId = args.userId
local status = args.status
local acquireActions = args.acquireActions
local config = args.config

-- Business logic:
local permit = true
local rate = 1.0

-- Result
result = {
  permit=permit,
  rate=rate
}
```


#### 非同期実行スクリプト

報酬受け取り処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| category | [CategoryModel](../sdk/#categorymodel) | カテゴリーモデル |
| userId | string | 報酬受け取りを実行しているユーザーID |
| oldStatus | [Status](../sdk/#status) | 報酬受け取り前のステータス |
| newStatus | [Status](../sdk/#status) | 報酬受け取り後のステータス |
| acquireActions | [AcquireAction[]](../sdk/#acquireaction) | 報酬 |
| config | [Config[]](../sdk/#config) | トランザクションの変数に適用する設定値 |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local category = args.category
local userId = args.userId
local oldStatus = args.oldStatus
local newStatus = args.newStatus
local acquireActions = args.acquireActions
local config = args.config

-- 非同期スクリプトは通常、API のレスポンスには影響を与えません。
-- ログ出力や分析、外部通知などに使用します。

result = {
}
```


---
  
### overrideAcquireActions

放置報酬の入手アクションを動的に決定するスクリプト
**関連するメソッド:**
receive - 報酬を受け取る
receiveByUserId - ユーザーIDを指定して報酬を受け取る


#### 同期実行スクリプト

放置報酬の入手アクションを動的に決定するスクリプトを同期実行したのち、入手アクションが実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| categoryModel | [CategoryModel](../sdk/#categorymodel) | カテゴリーモデル |
| userId | string | ユーザーID |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| acquireActions | AcquireActionList[] | ✓ |  | 1 ~ 100 items | 待機時間ごとに得られる入手アクションリスト<br>待機時間を「X分」だと仮定すると<br>「X / rewardIntervalMinutes」が報酬を受け取れる数になりますが、ここで指定した配列の要素をループすることで、待機時間ごとに異なる報酬を付与できます。 |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local categoryModel = args.categoryModel
local userId = args.userId

-- Business logic:
local acquireActions = {}

-- Result
result = {
  acquireActions=acquireActions
}
```


---