Trigger Reference of GS2-Guild Script

Reference of event triggers that call extended scripts

createGuild

Event trigger to call GS2-Script before Create guild.

Request

	Type	Description
namespace	Namespace	Namespace
guildModel	GuildModel	Guild Model
guild	Guild	Guild

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow creating guild

Implementation Example

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

result = {
  permit=permit
}

createGuildDone

GS2-Script called after Create guild.

Request

	Type	Description
namespace	Namespace	Namespace
guildModel	GuildModel	Guild Model
guild	Guild	Guild

Result

	Type	Require	Default	Limitation	Description

Implementation Example

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

result = {
}

updateGuild

Event trigger to call GS2-Script before Update guild.

Request

	Type	Description
namespace	Namespace	Namespace
guildModel	GuildModel	Guild Model
oldGuild	Guild	Guild before update
newGuild	Guild	Guild after update

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow update guild

Implementation Example

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

result = {
  permit=permit
}

updateGuildDone

GS2-Script called after Update guild.

Request

	Type	Description
namespace	Namespace	Namespace
guildModel	GuildModel	Guild Model
oldGuild	Guild	Guild before update
newGuild	Guild	Guild after update

Result

	Type	Require	Default	Limitation	Description

Implementation Example

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

result = {
}

joinGuild

Event trigger to call GS2-Script before Join guild.

Request

	Type	Description
namespace	Namespace	Namespace
guildModel	GuildModel	Guild Model
guild	Guild	Guild
userId	string	User ID

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow join guild

Implementation Example

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

result = {
  permit=permit
}

joinGuildDone

GS2-Script called after Join guild.

Request

	Type	Description
namespace	Namespace	Namespace
guildModel	GuildModel	Guild Model
guild	Guild	Guild
userId	string	User ID

Result

	Type	Require	Default	Limitation	Description

Implementation Example

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

result = {
}

leaveGuild

Event trigger to call GS2-Script before Leave guild.

Request

	Type	Description
namespace	Namespace	Namespace
guildModel	GuildModel	Guild Model
guild	Guild	Guild
userId	string	User ID
self	bool	Whether the user left the guild themselves or was removed by the guild master, or if the guild was disbanded

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow leave guild

Implementation Example

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

result = {
  permit=permit
}

leaveGuildDone

GS2-Script called after Leave guild.

Request

	Type	Description
namespace	Namespace	Namespace
guildModel	GuildModel	Guild Model
guild	Guild	Guild
userId	string	User ID
self	bool	Whether the user left the guild themselves or was removed by the guild master, or if the guild was disbanded

Result

	Type	Require	Default	Limitation	Description

Implementation Example

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

result = {
}

changeRole

Event trigger to call GS2-Script before Change role.

Request

	Type	Description
namespace	Namespace	Namespace
guildModel	GuildModel	Guild Model
guild	Guild	Guild
oldMembers	Member[]	Old Member Information
newMembers	Member[]	New Member Information

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow change role

Implementation Example

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

result = {
  permit=permit
}

changeRoleDone

GS2-Script called after Change role.

Request

	Type	Description
namespace	Namespace	Namespace
guildModel	GuildModel	Guild Model
guild	Guild	Guild
oldMembers	Member[]	Old Member Information
newMembers	Member[]	New Member Information

Result

	Type	Require	Default	Limitation	Description

Implementation Example

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

result = {
}

deleteGuild

Event trigger to call GS2-Script before Delete guild.

Request

	Type	Description
namespace	Namespace	Namespace
guildModel	GuildModel	Guild Model
guild	Guild	Guild

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow delete guild

Implementation Example

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

result = {
  permit=permit
}

deleteGuildDone

GS2-Script called after Delete guild.

Request

	Type	Description
namespace	Namespace	Namespace
guildModel	GuildModel	Guild Model
guild	Guild	Guild

Result

	Type	Require	Default	Limitation	Description

Implementation Example

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

result = {
}