GS2-Showcase Script Trigger Reference

Reference of event triggers that call extended scripts

Trigger

buy

Buy

Synchronous Execution Script

The script is executed synchronously before the buy process.

Request
TypeDescription
namespaceNamespaceNamespace
showcaseShowcaseShowcase model
displayItemDisplayItemDisplayItem model
userIdstringUser ID performing the showcase
quantityintPurchase Quantity
configConfig[]Set values to be applied to transaction variables
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
Whether to allow buy
Implementation Example
-- Request
local namespace = args.namespace
local showcase = args.showcase
local displayItem = args.displayItem
local userId = args.userId
local quantity = args.quantity
local config = args.config

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

Asynchronous Execution Script

The script is executed asynchronously after the buy process.

Request
TypeDescription
namespaceNamespaceNamespace
showcaseShowcaseShowcase model
displayItemDisplayItemDisplayItem model
userIdstringUser ID performing the showcase
quantityintPurchase Quantity
configConfig[]Set values to be applied to transaction variables
Implementation Example
-- Request
local namespace = args.namespace
local showcase = args.showcase
local displayItem = args.displayItem
local userId = args.userId
local quantity = args.quantity
local config = args.config

-- Asynchronous scripts typically do not affect the API response.
-- Use for logging, analytics, external notifications, etc.

result = {
}