NAV
GS2-Script

GS2-Account

Reference for event triggers that call GS2-Script

GS2-Script Reference

Trigger

createAccount

createAccount

namespace = args.namespace
account = args.account

result = {
  permit=permit
}

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

createAccountDone

createAccountDone

namespace = args.namespace
account = args.account

result = {
}

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

authentication

authentication

namespace = args.namespace
account = args.account

result = {
  permit=permit,
  force=force
}

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

authenticationDone

authenticationDone

namespace = args.namespace
account = args.account

result = {
}

GS2-Script called after Authentication.

Request

Type Description
namespace Namespace Namespace
account Account Game Player Account

Result

Type Require Default Limitation Description

createTakeOver

createTakeOver

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

result = {
  permit=permit
}

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

createTakeOverDone

createTakeOverDone

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

result = {
}

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

doTakeOver

doTakeOver

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

result = {
  permit=permit,
  force=force
}

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

doTakeOverDone

doTakeOverDone

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

result = {
}

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