GS2-Guild Script トリガー リファレンス
拡張スクリプトを呼び出す イベントトリガー のリファレンス
トリガー
createGuild
ギルド作成
同期実行スクリプト
ギルド作成処理の前に、スクリプトが同期実行されます。
Request
| 型 | 説明 | |
|---|---|---|
| namespace | Namespace | ネームスペース |
| guildModel | GuildModel | ギルドモデル |
| guild | Guild | ギルド |
Result
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| permit | bool | ✓ | ギルド作成 を許可するか |
実装例
-- 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 | ネームスペース |
| guildModel | GuildModel | ギルドモデル |
| guild | Guild | ギルド |
実装例
-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild
-- Asynchronous scripts typically do not affect the API response.
-- Use for logging, analytics, external notifications, etc.
result = {
}updateGuild
ギルド更新
同期実行スクリプト
ギルド更新処理の前に、スクリプトが同期実行されます。
Request
| 型 | 説明 | |
|---|---|---|
| namespace | Namespace | ネームスペース |
| guildModel | GuildModel | ギルドモデル |
| oldGuild | Guild | 更新前のギルド |
| newGuild | Guild | 更新後のギルド |
Result
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| permit | bool | ✓ | ギルド更新 を許可するか |
実装例
-- 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 | ネームスペース |
| guildModel | GuildModel | ギルドモデル |
| oldGuild | Guild | 更新前のギルド |
| newGuild | Guild | 更新後のギルド |
実装例
-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local oldGuild = args.oldGuild
local newGuild = args.newGuild
-- Asynchronous scripts typically do not affect the API response.
-- Use for logging, analytics, external notifications, etc.
result = {
}joinGuild
ギルド参加
同期実行スクリプト
ギルド参加処理の前に、スクリプトが同期実行されます。
Request
| 型 | 説明 | |
|---|---|---|
| namespace | Namespace | ネームスペース |
| guildModel | GuildModel | ギルドモデル |
| guild | Guild | ギルド |
| userId | string | ユーザーID |
Result
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| permit | bool | ✓ | ギルド参加 を許可するか |
実装例
-- 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 | ネームスペース |
| guildModel | GuildModel | ギルドモデル |
| guild | Guild | ギルド |
| userId | string | ユーザーID |
実装例
-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild
local userId = args.userId
-- Asynchronous scripts typically do not affect the API response.
-- Use for logging, analytics, external notifications, etc.
result = {
}leaveGuild
ギルド脱退
同期実行スクリプト
ギルド脱退処理の前に、スクリプトが同期実行されます。
Request
| 型 | 説明 | |
|---|---|---|
| namespace | Namespace | ネームスペース |
| guildModel | GuildModel | ギルドモデル |
| guild | Guild | ギルド |
| userId | string | ユーザーID |
| self | bool | 自分自身で脱退したか / ギルドマスターによって脱退させられたか、ギルドが解散した時に false になる |
Result
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| permit | bool | ✓ | ギルド脱退 を許可するか |
実装例
-- 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 | ネームスペース |
| guildModel | GuildModel | ギルドモデル |
| guild | Guild | ギルド |
| userId | string | ユーザーID |
| self | bool | 自分自身で脱退したか / ギルドマスターによって脱退させられたか、ギルドが解散した時に false になる |
実装例
-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild
local userId = args.userId
local self = args.self
-- Asynchronous scripts typically do not affect the API response.
-- Use for logging, analytics, external notifications, etc.
result = {
}changeRole
ロール変更
同期実行スクリプト
ロール変更処理の前に、スクリプトが同期実行されます。
Request
| 型 | 説明 | |
|---|---|---|
| namespace | Namespace | ネームスペース |
| guildModel | GuildModel | ギルドモデル |
| guild | Guild | ギルド |
| oldMembers | Member[] | 更新前のメンバー情報 |
| newMembers | Member[] | 更新後のメンバー情報 |
Result
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| permit | bool | ✓ | ロールの変更 を許可するか |
実装例
-- 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 | ネームスペース |
| guildModel | GuildModel | ギルドモデル |
| guild | Guild | ギルド |
| oldMembers | Member[] | 更新前のメンバー情報 |
| newMembers | Member[] | 更新後のメンバー情報 |
実装例
-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild
local oldMembers = args.oldMembers
local newMembers = args.newMembers
-- Asynchronous scripts typically do not affect the API response.
-- Use for logging, analytics, external notifications, etc.
result = {
}deleteGuild
ギルドを削除
同期実行スクリプト
ギルドを削除処理の前に、スクリプトが同期実行されます。
Request
| 型 | 説明 | |
|---|---|---|
| namespace | Namespace | ネームスペース |
| guildModel | GuildModel | ギルドモデル |
| guild | Guild | ギルド |
Result
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| permit | bool | ✓ | ギルドの削除 を許可するか |
実装例
-- 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 | ネームスペース |
| guildModel | GuildModel | ギルドモデル |
| guild | Guild | ギルド |
実装例
-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild
-- Asynchronous scripts typically do not affect the API response.
-- Use for logging, analytics, external notifications, etc.
result = {
}receiveJoinRequest
ギルド参加リクエスト受信
同期実行スクリプト
ギルド参加リクエスト受信処理の前に、スクリプトが同期実行されます。
Request
| 型 | 説明 | |
|---|---|---|
| namespace | Namespace | ネームスペース |
| guildModel | GuildModel | ギルドモデル |
| guild | Guild | ギルド |
| receiveMemberRequest | ReceiveMemberRequest | 参加リクエスト |
Result
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| permit | bool | ✓ | ギルド参加リクエスト受信を許可するか |
実装例
-- 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 | ネームスペース |
| guildModel | GuildModel | ギルドモデル |
| guild | Guild | ギルド |
| receiveMemberRequest | ReceiveMemberRequest | 参加リクエスト |
実装例
-- Request
local namespace = args.namespace
local guildModel = args.guildModel
local guild = args.guild
local receiveMemberRequest = args.receiveMemberRequest
-- Asynchronous scripts typically do not affect the API response.
-- Use for logging, analytics, external notifications, etc.
result = {
}