NAV
GS2-Script

GS2-Money

Reference for event triggers that call GS2-Script

GS2-Script Reference

Trigger

createWallet

createWallet

namespace = args.namespace
wallet = args.wallet

result = {
  permit=permit,
  initialAmount=initialAmount
}

Event trigger to call GS2-Script before creating a new wallet.

Request

Type Description
namespace Namespace Namespace
wallet Wallet Wallet

Result

Type Require Default Limitation Description
permit bool Allow wallet creation
initialAmount int ~ 2147483646 Initial Wallet balance - will be credited as a free grant

createWalletDone

createWalletDone

namespace = args.namespace
wallet = args.wallet

result = {
}

GS2-Script called after creating a new wallet.

Request

Type Description
namespace Namespace Namespace
wallet Wallet Wallet

Result

Type Require Default Limitation Description

deposit

deposit

namespace = args.namespace
wallet = args.wallet

result = {
  permit=permit,
  overrideCount=overrideCount
}

Event trigger to call GS2-Script before wallet balance is added.

Request

Type Description
namespace Namespace Namespace
wallet Wallet Wallet

Result

Type Require Default Limitation Description
permit bool Allow wallet balance addition
overrideCount int ~ 2147483646 Actual amount of addition to be applied

depositDone

depositDone

namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet

result = {
}

GS2-Script called after wallet balance is added.

Request

Type Description
namespace Namespace Namespace
oldWallet Wallet Wallet before deposit
newWallet Wallet Wallet after deposit

Result

Type Require Default Limitation Description

withdraw

withdraw

namespace = args.namespace
wallet = args.wallet

result = {
  permit=permit,
  overrideCount=overrideCount
}

Event trigger to call GS2-Script before wallet balance is consumed.

Request

Type Description
namespace Namespace Namespace
wallet Wallet Wallet

Result

Type Require Default Limitation Description
permit bool Allow wallet balance consumption
overrideCount int ~ 2147483646 Actual consumption to be applied

withdrawDone

withdrawDone

namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet

result = {
}

GS2-Script called after wallet balance is consumed.

Request

Type Description
namespace Namespace Namespace
oldWallet Wallet Pre-withdraw Wallet
newWallet Wallet Post-withdraw Wallet

Result

Type Require Default Limitation Description