Script Trigger Reference of GS2-Dictionary

Reference of event triggers that call extended scripts

Trigger

entry

entry registration

Synchronous Execution Script

The script is executed synchronously before the entry registration process.

Request
TypeDescription
namespaceNamespaceNamespace
entryModelsEntryModel[]List of Entry Models
userIdstringUser ID
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
Whether to allow entry registration
Implementation Example
namespace = args.namespace
entryModels = args.entryModels
userId = args.userId

result = {
  permit=permit
}

Asynchronous Execution Script

The script executes asynchronously after the entry registration.

Request
TypeDescription
namespaceNamespaceNamespace
entryModelsEntryModel[]List of Entry Models
userIdstringUser ID
Implementation Example
namespace = args.namespace
entryModels = args.entryModels
userId = args.userId

result = {
}

duplicateEntry

re-registration for entries already registered

Synchronous Execution Script

The script is executed synchronously before the re-registration for entries already registered process.

Request
TypeDescription
namespaceNamespaceNamespace
entryModelEntryModelEntry Model
userIdstringUser ID
Result
TypeRequiredDefaultValue LimitsDescription
Implementation Example
namespace = args.namespace
entryModel = args.entryModel
userId = args.userId

result = {
}