Trigger Reference of GS2-Dictionary Script

Reference of event triggers that call extended scripts

Trigger

entry

entry registration

Synchronous Execution Script

Script and entry registration are executed synchronously in that order.

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 will run after the entry registration is executed.

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

result = {
}

duplicateEntry

re-registration for entries already registered

Synchronous Execution Script

Script and re-registration for entries already registered are executed synchronously in that order.

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

result = {
}