Trigger Reference of GS2-Formation Script

Reference for event triggers that call extended scripts, as defined in GS2-Formation

updateMold

Event trigger to call GS2-Script before capacity update.

Request

TypeDescription
namespaceNamespaceNamespace
moldMoldForm storage area before update
afterMoldMoldForm storage area after update

Result

TypeRequireDefaultLimitationDescription
permitboolAllow capacity update

Implementation Example

namespace = args.namespace
mold = args.mold
afterMold = args.afterMold

result = {
  permit=permit
}

updateMoldDone

GS2-Script called after capacity update.

Request

TypeDescription
namespaceNamespaceNamespace
moldMoldForm storage area

Result

TypeRequireDefaultLimitationDescription

Implementation Example

namespace = args.namespace
mold = args.mold

result = {
}

updateForm

Event trigger to call GS2-Script before form update.

Request

TypeDescription
namespaceNamespaceNamespace
moldMoldForm storage area
formFormForm before update
afterFormFormForm after update

Result

TypeRequireDefaultLimitationDescription
permitboolAllow form update

Implementation Example

namespace = args.namespace
mold = args.mold
form = args.form
afterForm = args.afterForm

result = {
  permit=permit
}

updateFormDone

GS2-Script called after form update.

Request

TypeDescription
namespaceNamespaceNamespace
moldMoldForm storage area
formFormForm

Result

TypeRequireDefaultLimitationDescription

Implementation Example

namespace = args.namespace
mold = args.mold
form = args.form

result = {
}

updatePropertyForm

Event trigger to call GS2-Script before property formupdate.

Request

TypeDescription
namespaceNamespaceNamespace
propertyFormPropertyFormPropertyForm before update
afterPropertyFormPropertyFormPropertyForm after update

Result

TypeRequireDefaultLimitationDescription
permitboolAllow property formupdate

Implementation Example

namespace = args.namespace
propertyForm = args.propertyForm
afterPropertyForm = args.afterPropertyForm

result = {
  permit=permit
}

updatePropertyFormDone

GS2-Script called after property formupdate.

Request

TypeDescription
namespaceNamespaceNamespace
propertyFormPropertyFormPropertyForm

Result

TypeRequireDefaultLimitationDescription

Implementation Example

namespace = args.namespace
propertyForm = args.propertyForm

result = {
}