GS2-Guild Script トリガーリファレンス

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

トリガー

createGuild

ギルド作成

同期実行スクリプト

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

Request

	型	説明
namespace	Namespace	ネームスペース
guildModel	GuildModel	ギルドモデル
guild	Guild	ギルド

Result

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

実装例

namespace = args.namespace
guildModel = args.guildModel
guild = args.guild

result = {
  permit=permit
}

非同期実行スクリプト

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

Request

	型	説明
namespace	Namespace	ネームスペース
guildModel	GuildModel	ギルドモデル
guild	Guild	ギルド

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
guildModel = args.guildModel
guild = args.guild

result = {
}

updateGuild

ギルド更新

同期実行スクリプト

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

Request

	型	説明
namespace	Namespace	ネームスペース
guildModel	GuildModel	ギルドモデル
oldGuild	Guild	更新前のギルド
newGuild	Guild	更新後のギルド

Result

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

実装例

namespace = args.namespace
guildModel = args.guildModel
oldGuild = args.oldGuild
newGuild = args.newGuild

result = {
  permit=permit
}

非同期実行スクリプト

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

Request

	型	説明
namespace	Namespace	ネームスペース
guildModel	GuildModel	ギルドモデル
oldGuild	Guild	更新前のギルド
newGuild	Guild	更新後のギルド

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
guildModel = args.guildModel
oldGuild = args.oldGuild
newGuild = args.newGuild

result = {
}

joinGuild

ギルド参加

同期実行スクリプト

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

Request

	型	説明
namespace	Namespace	ネームスペース
guildModel	GuildModel	ギルドモデル
guild	Guild	ギルド
userId	string	ユーザーID

Result

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

実装例

namespace = args.namespace
guildModel = args.guildModel
guild = args.guild
userId = args.userId

result = {
  permit=permit
}

非同期実行スクリプト

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

Request

	型	説明
namespace	Namespace	ネームスペース
guildModel	GuildModel	ギルドモデル
guild	Guild	ギルド
userId	string	ユーザーID

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
guildModel = args.guildModel
guild = args.guild
userId = args.userId

result = {
}

leaveGuild

ギルド脱退

同期実行スクリプト

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

Request

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

Result

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

実装例

namespace = args.namespace
guildModel = args.guildModel
guild = args.guild
userId = args.userId
self = args.self

result = {
  permit=permit
}

非同期実行スクリプト

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

Request

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

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
guildModel = args.guildModel
guild = args.guild
userId = args.userId
self = args.self

result = {
}

changeRole

ロール変更

同期実行スクリプト

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

Request

	型	説明
namespace	Namespace	ネームスペース
guildModel	GuildModel	ギルドモデル
guild	Guild	ギルド
oldMembers	Member[]	更新前のメンバー情報
newMembers	Member[]	更新後のメンバー情報

Result

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

実装例

namespace = args.namespace
guildModel = args.guildModel
guild = args.guild
oldMembers = args.oldMembers
newMembers = args.newMembers

result = {
  permit=permit
}

非同期実行スクリプト

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

Request

	型	説明
namespace	Namespace	ネームスペース
guildModel	GuildModel	ギルドモデル
guild	Guild	ギルド
oldMembers	Member[]	更新前のメンバー情報
newMembers	Member[]	更新後のメンバー情報

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
guildModel = args.guildModel
guild = args.guild
oldMembers = args.oldMembers
newMembers = args.newMembers

result = {
}

deleteGuild

ギルドの削除

同期実行スクリプト

スクリプト、ギルドの削除の順に同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
guildModel	GuildModel	ギルドモデル
guild	Guild	ギルド

Result

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

実装例

namespace = args.namespace
guildModel = args.guildModel
guild = args.guild

result = {
  permit=permit
}

非同期実行スクリプト

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

Request

	型	説明
namespace	Namespace	ネームスペース
guildModel	GuildModel	ギルドモデル
guild	Guild	ギルド

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
guildModel = args.guildModel
guild = args.guild

result = {
}

receiveJoinRequest

ギルド参加リクエスト受信

同期実行スクリプト

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

Request

	型	説明
namespace	Namespace	ネームスペース
guildModel	GuildModel	ギルドモデル
guild	Guild	ギルド
receiveMemberRequest	ReceiveMemberRequest	参加リクエスト

Result

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

実装例

namespace = args.namespace
guildModel = args.guildModel
guild = args.guild
receiveMemberRequest = args.receiveMemberRequest

result = {
  permit=permit
}

非同期実行スクリプト

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

Request

	型	説明
namespace	Namespace	ネームスペース
guildModel	GuildModel	ギルドモデル
guild	Guild	ギルド
receiveMemberRequest	ReceiveMemberRequest	参加リクエスト

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
guildModel = args.guildModel
guild = args.guild
receiveMemberRequest = args.receiveMemberRequest

result = {
}