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

TypeDescription
namespaceNamespaceNamespace
guildModelGuildModelGuild Model
guildGuildGuild

Result

TypeRequireDefaultLimitationDescription
permitboolAllow creating guild

Implementation Example

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

result = {
  permit=permit
}

createGuildDone

GS2-Script called after Create guild.

Request

TypeDescription
namespaceNamespaceNamespace
guildModelGuildModelGuild Model
guildGuildGuild

Result

TypeRequireDefaultLimitationDescription

Implementation Example

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

result = {
}

joinGuild

Event trigger to call GS2-Script before Join guild.

Request

TypeDescription
namespaceNamespaceNamespace
guildModelGuildModelGuild Model
guildGuildGuild
userIdstringUser ID

Result

TypeRequireDefaultLimitationDescription
permitboolAllow 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

TypeDescription
namespaceNamespaceNamespace
guildModelGuildModelGuild Model
guildGuildGuild
userIdstringUser ID

Result

TypeRequireDefaultLimitationDescription

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

TypeDescription
namespaceNamespaceNamespace
guildModelGuildModelGuild Model
guildGuildGuild
userIdstringUser ID

Result

TypeRequireDefaultLimitationDescription
permitboolAllow 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

TypeDescription
namespaceNamespaceNamespace
guildModelGuildModelGuild Model
guildGuildGuild
userIdstringUser ID

Result

TypeRequireDefaultLimitationDescription

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

TypeDescription
namespaceNamespaceNamespace
guildModelGuildModelGuild Model
guildGuildGuild
userIdstringUser ID
oldRoleNamestringOld Role Model Name
newRoleNamestringNew Role Model Name

Result

TypeRequireDefaultLimitationDescription
permitboolAllow 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

TypeDescription
namespaceNamespaceNamespace
guildModelGuildModelGuild Model
guildGuildGuild
userIdstringUser ID
oldRoleNamestringOld Role Model Name
newRoleNamestringNew Role Model Name

Result

TypeRequireDefaultLimitationDescription

Implementation Example

namespace = args.namespace
guildModel = args.guildModel
guild = args.guild
userId = args.userId
oldRoleName = args.oldRoleName
newRoleName = args.newRoleName

result = {
}