Trigger Reference of GS2-Account Script
createAccount
Event trigger to call GS2-Script before Create a new account.
Request
| Type | Description |  | 
|---|
| namespace | Namespace | Namespace | 
| account | Account | Game Player Account | 
Result
| Type | Require | Default | Limitation | Description |  | 
|---|
| permit | bool | ✓ |  |  | Allow account creation or | 
Implementation Example
namespace = args.namespace
account = args.account
result = {
  permit=permit
}
createAccountDone
GS2-Script called after Create a new account.
Request
| Type | Description |  | 
|---|
| namespace | Namespace | Namespace | 
| account | Account | Game Player Account | 
Result
| Type | Require | Default | Limitation | Description |  | 
|---|
Implementation Example
namespace = args.namespace
account = args.account
result = {
}
authentication
Event trigger to call GS2-Script before Authentication.
Request
| Type | Description |  | 
|---|
| namespace | Namespace | Namespace | 
| account | Account | Game Player Account | 
Result
| Type | Require | Default | Limitation | Description |  | 
|---|
| permit | bool | ✓ |  |  | Allow account authorization | 
| force | bool |  | false |  | Pass 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
| Type | Description |  | 
|---|
| namespace | Namespace | Namespace | 
| account | Account | Game Player Account | 
Result
| Type | Require | Default | Limitation | Description |  | 
|---|
Implementation Example
namespace = args.namespace
account = args.account
result = {
}
createTakeOver
Event trigger to call GS2-Script before Registration of takeover setting.
Request
| Type | Description |  | 
|---|
| namespace | Namespace | Namespace | 
| takeOver | TakeOver | Takeover setting | 
| account | Account | Game Player Account | 
Result
| Type | Require | Default | Limitation | Description |  | 
|---|
| permit | bool | ✓ |  |  | Allow 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
| Type | Description |  | 
|---|
| namespace | Namespace | Namespace | 
| takeOver | TakeOver | Takeover setting | 
| account | Account | Game Player Account | 
Result
| Type | Require | Default | Limitation | Description |  | 
|---|
Implementation Example
namespace = args.namespace
takeOver = args.takeOver
account = args.account
result = {
}
doTakeOver
Event trigger to call GS2-Script before Takeover.
Request
| Type | Description |  | 
|---|
| namespace | Namespace | Namespace | 
| account | Account | Game Player Account | 
| takeOver | TakeOver | Takeover Setting | 
Result
| Type | Require | Default | Limitation | Description |  | 
|---|
| permit | bool | ✓ |  |  | Allow takeover execution | 
| force | bool |  | false |  | Pass 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
| Type | Description |  | 
|---|
| namespace | Namespace | Namespace | 
| account | Account | Game Player Account | 
| takeOver | TakeOver | Takeover Setting | 
Result
| Type | Require | Default | Limitation | Description |  | 
|---|
Implementation Example
namespace = args.namespace
account = args.account
takeOver = args.takeOver
result = {
}