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

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

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



## トリガー

### createGuild

ギルド作成
**関連するメソッド:**
createGuild - ギルドを新規作成


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

ギルド作成処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| guildModel | [GuildModel](../sdk/#guildmodel) | ギルドモデル |
| guild | [Guild](../sdk/#guild) | ギルド |

##### Result

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

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild

-- Business logic:
local permit = true

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


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

ギルド作成処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| guildModel | [GuildModel](../sdk/#guildmodel) | ギルドモデル |
| guild | [Guild](../sdk/#guild) | ギルド |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild

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

result = {
}
```


---
  
### updateGuild

ギルド更新
**関連するメソッド:**
updateGuild - ギルドを更新


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

ギルド更新処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| guildModel | [GuildModel](../sdk/#guildmodel) | ギルドモデル |
| oldGuild | [Guild](../sdk/#guild) | 更新前のギルド |
| newGuild | [Guild](../sdk/#guild) | 更新後のギルド |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | ギルド更新 を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local oldGuild = args.oldGuild
local newGuild = args.newGuild

-- Business logic:
local permit = true

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


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

ギルド更新処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| guildModel | [GuildModel](../sdk/#guildmodel) | ギルドモデル |
| oldGuild | [Guild](../sdk/#guild) | 更新前のギルド |
| newGuild | [Guild](../sdk/#guild) | 更新後のギルド |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local oldGuild = args.oldGuild
local newGuild = args.newGuild

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

result = {
}
```


---
  
### joinGuild

ギルド参加
**関連するメソッド:**
createGuild - ギルドを新規作成
createGuildByUserId - ユーザーIDを指定してギルドを新規作成
createGuildModelMaster - ギルドモデルマスターを新規作成


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

ギルド参加処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| guildModel | [GuildModel](../sdk/#guildmodel) | ギルドモデル |
| guild | [Guild](../sdk/#guild) | ギルド |
| userId | string | ユーザーID |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | ギルド参加 を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild
local userId = args.userId

-- Business logic:
local permit = true

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


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

ギルド参加処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| guildModel | [GuildModel](../sdk/#guildmodel) | ギルドモデル |
| guild | [Guild](../sdk/#guild) | ギルド |
| userId | string | ユーザーID |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild
local userId = args.userId

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

result = {
}
```


---
  
### leaveGuild

ギルド脱退
**関連するメソッド:**
deleteMember - メンバーを除名
deleteMemberByGuildName - ギルド名を指定してメンバーを除名


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

ギルド脱退処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| guildModel | [GuildModel](../sdk/#guildmodel) | ギルドモデル |
| guild | [Guild](../sdk/#guild) | ギルド |
| userId | string | ユーザーID |
| self | bool | 自分自身で脱退したか / ギルドマスターによって脱退させられたか、ギルドが解散した時に false になる |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | ギルド脱退 を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild
local userId = args.userId
local self = args.self

-- Business logic:
local permit = true

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


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

ギルド脱退処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| guildModel | [GuildModel](../sdk/#guildmodel) | ギルドモデル |
| guild | [Guild](../sdk/#guild) | ギルド |
| userId | string | ユーザーID |
| self | bool | 自分自身で脱退したか / ギルドマスターによって脱退させられたか、ギルドが解散した時に false になる |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild
local userId = args.userId
local self = args.self

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

result = {
}
```


---
  
### changeRole

ロール変更
**関連するメソッド:**
updateMemberRole - メンバーの役職を更新
updateMemberRoleByGuildName - ギルド名を指定してメンバーの役職を更新


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

ロール変更処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| guildModel | [GuildModel](../sdk/#guildmodel) | ギルドモデル |
| guild | [Guild](../sdk/#guild) | ギルド |
| oldMembers | [Member[]](../sdk/#member) | 更新前のメンバー情報 |
| newMembers | [Member[]](../sdk/#member) | 更新後のメンバー情報 |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | ロールの変更 を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild
local oldMembers = args.oldMembers
local newMembers = args.newMembers

-- Business logic:
local permit = true

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


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

ロール変更処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| guildModel | [GuildModel](../sdk/#guildmodel) | ギルドモデル |
| guild | [Guild](../sdk/#guild) | ギルド |
| oldMembers | [Member[]](../sdk/#member) | 更新前のメンバー情報 |
| newMembers | [Member[]](../sdk/#member) | 更新後のメンバー情報 |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild
local oldMembers = args.oldMembers
local newMembers = args.newMembers

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

result = {
}
```


---
  
### deleteGuild

ギルドを削除
**関連するメソッド:**
deleteGuild - ギルドを削除


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

ギルドを削除処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| guildModel | [GuildModel](../sdk/#guildmodel) | ギルドモデル |
| guild | [Guild](../sdk/#guild) | ギルド |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | ギルドの削除 を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild

-- Business logic:
local permit = true

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


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

ギルドを削除処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| guildModel | [GuildModel](../sdk/#guildmodel) | ギルドモデル |
| guild | [Guild](../sdk/#guild) | ギルド |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild

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

result = {
}
```


---
  
### receiveJoinRequest

ギルド参加リクエスト受信
**関連するメソッド:**
sendRequest - 参加リクエストを送信
sendRequestByUserId - ユーザーIDを指定して参加リクエストを送信


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

ギルド参加リクエスト受信処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| guildModel | [GuildModel](../sdk/#guildmodel) | ギルドモデル |
| guild | [Guild](../sdk/#guild) | ギルド |
| receiveMemberRequest | [ReceiveMemberRequest](../sdk/#receivememberrequest) | 参加リクエスト |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | ギルド参加リクエスト受信を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild
local receiveMemberRequest = args.receiveMemberRequest

-- Business logic:
local permit = true

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


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

ギルド参加リクエスト受信処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| guildModel | [GuildModel](../sdk/#guildmodel) | ギルドモデル |
| guild | [Guild](../sdk/#guild) | ギルド |
| receiveMemberRequest | [ReceiveMemberRequest](../sdk/#receivememberrequest) | 参加リクエスト |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild
local receiveMemberRequest = args.receiveMemberRequest

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

result = {
}
```


---