Trigger Reference of GS2-Account Script

createAccount

Event trigger to call GS2-Script before Create a new account.

Request

TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account

Result

TypeRequireDefaultLimitationDescription
permitboolAllow account creation or

Implementation Example

namespace = args.namespace
account = args.account

result = {
  permit=permit
}

createAccountDone

GS2-Script called after Create a new account.

Request

TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account

Result

TypeRequireDefaultLimitationDescription

Implementation Example

namespace = args.namespace
account = args.account

result = {
}

authentication

Event trigger to call GS2-Script before Authentication.

Request

TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account

Result

TypeRequireDefaultLimitationDescription
permitboolAllow account authorization
forceboolfalsePass authentication even if password authentication fails

Implementation Example

namespace = args.namespace
account = args.account

result = {
  permit=permit,
  force=force
}

authenticationDone

GS2-Script called after Authentication.

Request

TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account

Result

TypeRequireDefaultLimitationDescription

Implementation Example

namespace = args.namespace
account = args.account

result = {
}

createTakeOver

Event trigger to call GS2-Script before Registration of takeover setting.

Request

TypeDescription
namespaceNamespaceNamespace
takeOverTakeOverTakeover setting
accountAccountGame Player Account

Result

TypeRequireDefaultLimitationDescription
permitboolAllow registration of takeover setting

Implementation Example

namespace = args.namespace
takeOver = args.takeOver
account = args.account

result = {
  permit=permit
}

createTakeOverDone

GS2-Script called after Registration of takeover setting.

Request

TypeDescription
namespaceNamespaceNamespace
takeOverTakeOverTakeover setting
accountAccountGame Player Account

Result

TypeRequireDefaultLimitationDescription

Implementation Example

namespace = args.namespace
takeOver = args.takeOver
account = args.account

result = {
}

doTakeOver

Event trigger to call GS2-Script before Takeover.

Request

TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
takeOverTakeOverTakeover Setting

Result

TypeRequireDefaultLimitationDescription
permitboolAllow takeover execution
forceboolfalsePass authentication even if password authentication fails

Implementation Example

namespace = args.namespace
account = args.account
takeOver = args.takeOver

result = {
  permit=permit,
  force=force
}

doTakeOverDone

GS2-Script called after Takeover.

Request

TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
takeOverTakeOverTakeover Setting

Result

TypeRequireDefaultLimitationDescription

Implementation Example

namespace = args.namespace
account = args.account
takeOver = args.takeOver

result = {
}