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

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

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



## トリガー

### createAccount

アカウント新規作成
**関連するメソッド:**
createAccount - ゲームプレイヤーアカウントを新規作成


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

アカウント新規作成処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| account | [Account](../sdk/#account) | ゲームプレイヤーアカウント |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | アカウントの作成を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local account = args.account

-- Business logic:
local permit = true

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


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

アカウント新規作成処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| account | [Account](../sdk/#account) | ゲームプレイヤーアカウント |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local account = args.account

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

result = {
}
```


---
  
### authentication

アカウントの認証
**関連するメソッド:**
authentication - ゲームプレイヤーアカウントを認証


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

アカウントの認証処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| account | [Account](../sdk/#account) | ゲームプレイヤーアカウント |
| elapsedHours | int | 前回ログインからの経過時間 |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | アカウントの認証を許可するか |
| force | bool |  | false |  | パスワード認証に失敗しても認証を通すか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local account = args.account
local elapsedHours = args.elapsedHours

-- Business logic:
local permit = true
local force = false

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


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

アカウントの認証処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| account | [Account](../sdk/#account) | ゲームプレイヤーアカウント |
| elapsedHours | int | 前回ログインからの経過時間 |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local account = args.account
local elapsedHours = args.elapsedHours

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

result = {
}
```


---
  
### ban

アカウントBANの登録
**関連するメソッド:**
addBan - ゲームプレイヤーアカウントにアカウントBANステータスを追加


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

アカウントBANの登録処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| account | [Account](../sdk/#account) | ゲームプレイヤーアカウント |
| addBanStatus | [BanStatus](../sdk/#banstatus) | 追加するアカウントBANステータス |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | アカウントBANの登録を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local account = args.account
local addBanStatus = args.addBanStatus

-- Business logic:
local permit = true

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


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

アカウントBANの登録処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| account | [Account](../sdk/#account) | ゲームプレイヤーアカウント |
| addBanStatus | [BanStatus](../sdk/#banstatus) | 追加するアカウントBANステータス |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local account = args.account
local addBanStatus = args.addBanStatus

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

result = {
}
```


---
  
### unBan

アカウントBANの解除
**関連するメソッド:**
updateBanned - ゲームプレイヤーアカウントのアカウントBANステータスを更新
removeBan - ゲームプレイヤーアカウントのアカウントBANステータスを削除
authentication - ゲームプレイヤーアカウントを認証


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

アカウントBANの解除処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| account | [Account](../sdk/#account) | ゲームプレイヤーアカウント |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | アカウントBANの解除を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local account = args.account

-- Business logic:
local permit = true

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


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

アカウントBANの解除処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| account | [Account](../sdk/#account) | ゲームプレイヤーアカウント |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local account = args.account

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

result = {
}
```


---
  
### createTakeOver

引き継ぎ情報登録
**関連するメソッド:**
createTakeOver - 引き継ぎ情報を新規作成


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

引き継ぎ情報登録処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| takeOver | [TakeOver](../sdk/#takeover) | 引き継ぎ情報 |
| account | [Account](../sdk/#account) | ゲームプレイヤーアカウント |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | 引き継ぎ情報登録を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local takeOver = args.takeOver
local account = args.account

-- Business logic:
local permit = true

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


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

引き継ぎ情報登録処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| takeOver | [TakeOver](../sdk/#takeover) | 引き継ぎ情報 |
| account | [Account](../sdk/#account) | ゲームプレイヤーアカウント |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local takeOver = args.takeOver
local account = args.account

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

result = {
}
```


---
  
### doTakeOver

引き継ぎ実行
**関連するメソッド:**
doTakeOver - 引き継ぎを実行


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

引き継ぎ実行処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| account | [Account](../sdk/#account) | ゲームプレイヤーアカウント |
| takeOver | [TakeOver](../sdk/#takeover) | 引き継ぎ情報 |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | 引き継ぎ実行を許可するか |
| force | bool |  | false |  | パスワード認証に失敗しても認証を通すか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local account = args.account
local takeOver = args.takeOver

-- Business logic:
local permit = true
local force = false

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


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

引き継ぎ実行処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| account | [Account](../sdk/#account) | ゲームプレイヤーアカウント |
| takeOver | [TakeOver](../sdk/#takeover) | 引き継ぎ情報 |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local account = args.account
local takeOver = args.takeOver

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

result = {
}
```


---