Trigger Reference of GS2-Account Script

Reference of event triggers that call extended scripts

Trigger

createAccount

Create a new account

Synchronous Execution Script

Script and Create a new account are executed synchronously in that order.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
Whether to allow account creation
Implementation Example
namespace = args.namespace
account = args.account

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the Create a new account is executed.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
Result
TypeRequiredDefaultValue LimitsDescription
Implementation Example
namespace = args.namespace
account = args.account

result = {
}

authentication

Authentication

Synchronous Execution Script

Script and Authentication are executed synchronously in that order.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
elapsedHoursintElapsed time since last login
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
Whether to allow account authorization
forceboolfalsePass authentication even if password authentication fails
Implementation Example
namespace = args.namespace
account = args.account
elapsedHours = args.elapsedHours

result = {
  permit=permit,
  force=force
}

Asynchronous Execution Script

The script will run after the Authentication is executed.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
elapsedHoursintElapsed time since last login
Result
TypeRequiredDefaultValue LimitsDescription
Implementation Example
namespace = args.namespace
account = args.account
elapsedHours = args.elapsedHours

result = {
}

ban

Account BAN

Synchronous Execution Script

Script and Account BAN are executed synchronously in that order.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
addBanStatusBanStatusAccount BAN information to add
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
Whether to allow account BAN registration
Implementation Example
namespace = args.namespace
account = args.account
addBanStatus = args.addBanStatus

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the Account BAN is executed.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
addBanStatusBanStatusAccount BAN information to add
Result
TypeRequiredDefaultValue LimitsDescription
Implementation Example
namespace = args.namespace
account = args.account
addBanStatus = args.addBanStatus

result = {
}

unBan

Account BAN cancellation

Synchronous Execution Script

Script and Account BAN cancellation are executed synchronously in that order.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
Whether to allow account BAN cancellation
Implementation Example
namespace = args.namespace
account = args.account

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the Account BAN cancellation is executed.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
Result
TypeRequiredDefaultValue LimitsDescription
Implementation Example
namespace = args.namespace
account = args.account

result = {
}

createTakeOver

Registration of takeover setting

Synchronous Execution Script

Script and Registration of takeover setting are executed synchronously in that order.

Request
TypeDescription
namespaceNamespaceNamespace
takeOverTakeOverTakeover setting
accountAccountGame Player Account
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
Whether to allow registration of takeover setting
Implementation Example
namespace = args.namespace
takeOver = args.takeOver
account = args.account

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the Registration of takeover setting is executed.

Request
TypeDescription
namespaceNamespaceNamespace
takeOverTakeOverTakeover setting
accountAccountGame Player Account
Result
TypeRequiredDefaultValue LimitsDescription
Implementation Example
namespace = args.namespace
takeOver = args.takeOver
account = args.account

result = {
}

doTakeOver

Takeover

Synchronous Execution Script

Script and Takeover are executed synchronously in that order.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
takeOverTakeOverTakeover Setting
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
Whether to allow 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
}

Asynchronous Execution Script

The script will run after the Takeover is executed.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
takeOverTakeOverTakeover Setting
Result
TypeRequiredDefaultValue LimitsDescription
Implementation Example
namespace = args.namespace
account = args.account
takeOver = args.takeOver

result = {
}