Trigger Reference of GS2-Guild Script

Reference of event triggers that call extended scripts

Trigger

createGuild

Create guild

Synchronous Execution Script

Script and Create guild are executed synchronously in that order.

Request

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

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow creating guild

Implementation Example

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

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the Create guild is executed.

Request

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

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

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

result = {
}

updateGuild

Update guild

Synchronous Execution Script

Script and Update guild are executed synchronously in that order.

Request

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

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow update guild

Implementation Example

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

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the Update guild is executed.

Request

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

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

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

result = {
}

joinGuild

Join guild

Synchronous Execution Script

Script and Join guild are executed synchronously in that order.

Request

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

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow join guild

Implementation Example

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

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the Join guild is executed.

Request

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

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

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

result = {
}

leaveGuild

Leave guild

Synchronous Execution Script

Script and Leave guild are executed synchronously in that order.

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	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow leave guild

Implementation Example

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

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the Leave guild is executed.

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	Required	Default	Value Limits	Description

Implementation Example

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

result = {
}

changeRole

Change role

Synchronous Execution Script

Script and Change role are executed synchronously in that order.

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	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow change role

Implementation Example

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

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the Change role is executed.

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	Required	Default	Value Limits	Description

Implementation Example

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

result = {
}

deleteGuild

Delete guild

Synchronous Execution Script

Script and Delete guild are executed synchronously in that order.

Request

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

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow delete guild

Implementation Example

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

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the Delete guild is executed.

Request

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

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

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

result = {
}

receiveJoinRequest

Receive join request

Synchronous Execution Script

Script and Receive join request are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
guildModel	GuildModel	Guild Model
guild	Guild	Guild
receiveMemberRequest	ReceiveMemberRequest	Join Request

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow receive join request

Implementation Example

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

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the Receive join request is executed.

Request

	Type	Description
namespace	Namespace	Namespace
guildModel	GuildModel	Guild Model
guild	Guild	Guild
receiveMemberRequest	ReceiveMemberRequest	Join Request

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

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

result = {
}