GS2-Account Script Trigger Reference

Reference for 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
-- Request
local namespace = args.namespace
local account = args.account

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

Asynchronous Execution Script

The script is executed asynchronously after the account creation process.

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

-- Asynchronous scripts typically do not affect the API response.
-- These scripts are typically used for logging, analytics, external notifications, and similar purposes.

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 authentication
forceboolfalseWhether to allow login even if password authentication fails
Implementation Example
-- Request
local namespace = args.namespace
local account = args.account
local elapsedHours = args.elapsedHours

-- Business logic:
local permit = true
local force = false

-- Result
result = {
  permit=permit,
  force=force
}

Asynchronous Execution Script

The script is executed asynchronously after the account authentication process.

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

-- Asynchronous scripts typically do not affect the API response.
-- These scripts are typically used for logging, analytics, external notifications, and similar purposes.

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 Status to be added
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
✓
Whether to allow Account BAN registration
Implementation Example
-- Request
local namespace = args.namespace
local account = args.account
local addBanStatus = args.addBanStatus

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

Asynchronous Execution Script

The script is executed asynchronously after the account ban registration process.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
addBanStatusBanStatusAccount Ban Status to be added
Implementation Example
-- Request
local namespace = args.namespace
local account = args.account
local addBanStatus = args.addBanStatus

-- Asynchronous scripts typically do not affect the API response.
-- These scripts are typically used for logging, analytics, external notifications, and similar purposes.

result = {
}

unBan

Account Ban removal

Synchronous Execution Script

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

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
✓
Whether to allow Account Ban removal
Implementation Example
-- Request
local namespace = args.namespace
local account = args.account

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

Asynchronous Execution Script

The script is executed asynchronously after the account ban removal process.

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

-- Asynchronous scripts typically do not affect the API response.
-- These scripts are typically used for logging, analytics, external notifications, and similar purposes.

result = {
}

requestDeletion

Account deletion request

Synchronous Execution Script

The script is executed synchronously before the account deletion request process.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
scheduledAtlongScheduled deletion time
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
✓
Whether to allow the account deletion request
Implementation Example
-- Request
local namespace = args.namespace
local account = args.account
local scheduledAt = args.scheduledAt

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

Asynchronous Execution Script

The script is executed asynchronously after the account deletion request process.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
scheduledAtlongScheduled deletion time
Implementation Example
-- Request
local namespace = args.namespace
local account = args.account
local scheduledAt = args.scheduledAt

-- Asynchronous scripts typically do not affect the API response.
-- These scripts are typically used for logging, analytics, external notifications, and similar purposes.

result = {
}

cancelDeletion

Account deletion request cancellation

Synchronous Execution Script

The script is executed synchronously before the account deletion request cancellation process.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
reasonenum [
“user”,
“login”,
“admin”
]
Reason for the cancellation
“Cancelled by the game player (user)” is a cancellation by the game player.
“Cancelled by logging in during the grace period (login)” is a cancellation by authenticating while the Account is scheduled for deletion, when the behavior when logging in during the grace period is “Cancel the deletion and log in (cancel)”.
“Cancelled by the administrator (admin)” is a cancellation by specifying the user ID.
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
✓
Whether to allow the cancellation of the account deletion request
Implementation Example
-- Request
local namespace = args.namespace
local account = args.account
local reason = args.reason

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

Asynchronous Execution Script

The script is executed asynchronously after the account deletion request cancellation process.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
reasonenum [
“user”,
“login”,
“admin”
]
Reason for the cancellation
“Cancelled by the game player (user)” is a cancellation by the game player.
“Cancelled by logging in during the grace period (login)” is a cancellation by authenticating while the Account is scheduled for deletion, when the behavior when logging in during the grace period is “Cancel the deletion and log in (cancel)”.
“Cancelled by the administrator (admin)” is a cancellation by specifying the user ID.
Implementation Example
-- Request
local namespace = args.namespace
local account = args.account
local reason = args.reason

-- Asynchronous scripts typically do not affect the API response.
-- These scripts are typically used for logging, analytics, external notifications, and similar purposes.

result = {
}

executeDeletion

Account deletion

Synchronous Execution Script

The script is executed synchronously before the account deletion process.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
dataUserIdstringUser ID for data retention
The user ID that holds the user data to delete.
When the Namespace uses different user IDs for login and data retention, this is the user ID of the data owner; otherwise, it is the same as the user ID of the Account.
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
✓
Not used
The deletion of the Account cannot be stopped by the script, so this value is ignored.
When the script fails, the deletion is put off and retried later, so the script may be executed more than once for the same account. Make the script idempotent.
Once the deletion has failed 13 times, it proceeds without executing the script.
Implementation Example
-- Request
local namespace = args.namespace
local account = args.account
local dataUserId = args.dataUserId

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

Asynchronous Execution Script

The script is executed asynchronously after the account deletion process.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
dataUserIdstringUser ID for data retention
The user ID that holds the user data to delete.
When the Namespace uses different user IDs for login and data retention, this is the user ID of the data owner; otherwise, it is the same as the user ID of the Account.
Implementation Example
-- Request
local namespace = args.namespace
local account = args.account
local dataUserId = args.dataUserId

-- Asynchronous scripts typically do not affect the API response.
-- These scripts are typically used for logging, analytics, external notifications, and similar purposes.

result = {
}

createTakeOver

Takeover Information registration

Synchronous Execution Script

The script is executed synchronously before the takeover information registration process.

Request
TypeDescription
namespaceNamespaceNamespace
takeOverTakeOverTakeover Information
accountAccountGame Player Account
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
✓
Whether to allow Takeover Information registration
Implementation Example
-- Request
local namespace = args.namespace
local takeOver = args.takeOver
local account = args.account

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

Asynchronous Execution Script

The script is executed asynchronously after the takeover information registration process.

Request
TypeDescription
namespaceNamespaceNamespace
takeOverTakeOverTakeover Information
accountAccountGame Player Account
Implementation Example
-- Request
local namespace = args.namespace
local takeOver = args.takeOver
local account = args.account

-- Asynchronous scripts typically do not affect the API response.
-- These scripts are typically used for logging, analytics, external notifications, and similar purposes.

result = {
}

doTakeOver

Takeover execution

Synchronous Execution Script

The script is executed synchronously before the takeover execution process.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
takeOverTakeOverTakeover Information
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
✓
Whether to allow takeover execution
forceboolfalseWhether to allow login even if password authentication fails
Implementation Example
-- Request
local namespace = args.namespace
local account = args.account
local takeOver = args.takeOver

-- Business logic:
local permit = true
local force = false

-- Result
result = {
  permit=permit,
  force=force
}

Asynchronous Execution Script

The script is executed asynchronously after the takeover execution process.

Request
TypeDescription
namespaceNamespaceNamespace
accountAccountGame Player Account
takeOverTakeOverTakeover Information
Implementation Example
-- Request
local namespace = args.namespace
local account = args.account
local takeOver = args.takeOver

-- Asynchronous scripts typically do not affect the API response.
-- These scripts are typically used for logging, analytics, external notifications, and similar purposes.

result = {
}