Script Trigger Reference of GS2-Account

Reference of event triggers that call extended scripts

Trigger

createAccount

Account creation

Synchronous Execution Script

The script is executed synchronously before the account creation process.

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 executes asynchronously after the Account creation.

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

result = {
}

authentication

Account Authentication

Synchronous Execution Script

The script is executed synchronously before the account authentication process.

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 executes asynchronously after the Account Authentication.

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

result = {
}

ban

Account BAN registration

Synchronous Execution Script

The script is executed synchronously before the account ban registration process.

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 executes asynchronously after the Account BAN registration.

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

result = {
}

unBan

Account BAN cancellation

Synchronous Execution Script

The script is executed synchronously before the account ban cancellation process.

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 executes asynchronously after the Account BAN cancellation.

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

result = {
}

createTakeOver

Registration of takeover setting

Synchronous Execution Script

The script is executed synchronously before the registration of takeover setting process.

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 executes asynchronously after the Registration of takeover setting.

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

result = {
}

doTakeOver

Takeover execution

Synchronous Execution Script

The script is executed synchronously before the takeover execution process.

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 executes asynchronously after the Takeover execution.

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

result = {
}