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

GS2-Guildで定義されている、拡張スクリプトを呼び出すイベントトリガーのリファレンス

createGuild

ギルド作成実行前にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

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

実装例

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

result = {
  permit=permit
}

createGuildDone

ギルド作成実行後にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

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

実装例

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

result = {
}

updateGuild

ギルド更新実行前にGS2-Scriptを呼び出すイベントトリガー

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
}

updateGuildDone

ギルド更新実行後にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

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

実装例

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

result = {
}

joinGuild

ギルド参加実行前にGS2-Scriptを呼び出すイベントトリガー

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
}

joinGuildDone

ギルド参加実行後にGS2-Scriptを呼び出すイベントトリガー

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

ギルド脱退実行前にGS2-Scriptを呼び出すイベントトリガー

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
}

leaveGuildDone

ギルド脱退実行後にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

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

実装例

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

result = {
}

changeRole

ロール変更実行前にGS2-Scriptを呼び出すイベントトリガー

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
}

changeRoleDone

ロール変更実行後にGS2-Scriptを呼び出すイベントトリガー

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 = {
}