Trigger Reference of GS2-Guild Script
Reference for event triggers that call extended scripts, as defined in GS2-Guild
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 |
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
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 |
Result
| Type | Require | Default | Limitation | Description |
---|
Implementation Example
namespace = args.namespace
guildModel = args.guildModel
guild = args.guild
userId = args.userId
result = {
}
changeRole
Event trigger to call GS2-Script before Change role.
Request
| Type | Description |
---|
namespace | Namespace | Namespace |
guildModel | GuildModel | Guild Model |
guild | Guild | Guild |
userId | string | User ID |
oldRoleName | string | Old Role Model Name |
newRoleName | string | New Role Model Name |
Result
| Type | Require | Default | Limitation | Description |
---|
permit | bool | ✓ | | | Allow change role |
Implementation Example
namespace = args.namespace
guildModel = args.guildModel
guild = args.guild
userId = args.userId
oldRoleName = args.oldRoleName
newRoleName = args.newRoleName
result = {
permit=permit
}
changeRoleDone
GS2-Script called after Change role.
Request
| Type | Description |
---|
namespace | Namespace | Namespace |
guildModel | GuildModel | Guild Model |
guild | Guild | Guild |
userId | string | User ID |
oldRoleName | string | Old Role Model Name |
newRoleName | string | New Role Model Name |
Result
| Type | Require | Default | Limitation | Description |
---|
Implementation Example
namespace = args.namespace
guildModel = args.guildModel
guild = args.guild
userId = args.userId
oldRoleName = args.oldRoleName
newRoleName = args.newRoleName
result = {
}