Trigger Reference of GS2-Matchmaking Script

Reference of event triggers that call extended scripts

Trigger

createGathering

creating a new gathering

Synchronous Execution Script

Script and creating a new gathering are executed synchronously in that order.

Request
TypeDescription
namespaceNamespaceNamespace
gatheringGatheringGathering
Result
TypeRequiredDefaultValue LimitsDescription
Implementation Example
namespace = args.namespace
gathering = args.gathering

result = {
}

completeMatchmaking

matchmaking is complete

Synchronous Execution Script

Script and matchmaking is complete are executed synchronously in that order.

Request
TypeDescription
namespaceNamespaceNamespace
gatheringGatheringGathering
Result
TypeRequiredDefaultValue LimitsDescription
Implementation Example
namespace = args.namespace
gathering = args.gathering

result = {
}

changeRating

Rating value changes

Synchronous Execution Script

Script and Rating value changes are executed synchronously in that order.

Request
TypeDescription
namespaceNamespaceNamespace
oldRatingRatingOld Rating
newRatingRatingNew Rating
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
Whether to allow rating value changes
Implementation Example
namespace = args.namespace
oldRating = args.oldRating
newRating = args.newRating

result = {
  permit=permit
}

Asynchronous Execution Script

The script executes asynchronously after the Rating value changes.

Request
TypeDescription
namespaceNamespaceNamespace
oldRatingRatingOld Rating
newRatingRatingNew Rating
Result
TypeRequiredDefaultValue LimitsDescription
Implementation Example
namespace = args.namespace
oldRating = args.oldRating
newRating = args.newRating

result = {
}