Trigger Reference of GS2-Matchmaking Script

Reference for event triggers that call extended scripts, as defined in GS2-Matchmaking
Tags:

createGathering

Event trigger to call GS2-Script when creating a new gathering.

Request

TypeDescription
namespaceNamespaceNamespace
gatheringGatheringGathering

Result

TypeRequireDefaultLimitationDescription

Implementation Example

namespace = args.namespace
gathering = args.gathering

result = {
}

completeMatchmaking

Event trigger to call GS2-Script when matchmaking is complete.

Request

TypeDescription
namespaceNamespaceNamespace
gatheringGatheringGathering

Result

TypeRequireDefaultLimitationDescription

Implementation Example

namespace = args.namespace
gathering = args.gathering

result = {
}

changeRating

Event trigger to call GS2-Script before Rating Value Change.

Request

TypeDescription
namespaceNamespaceNamespace
oldRatingRatingOld Rating
newRatingRatingNew Rating

Result

TypeRequireDefaultLimitationDescription
permitbool✓Allow item acquisition

Implementation Example

namespace = args.namespace
oldRating = args.oldRating
newRating = args.newRating

result = {
  permit=permit
}

changeRatingDone

GS2-Script called after Rating Value Change.

Request

TypeDescription
namespaceNamespaceNamespace
oldRatingRatingOld Rating
newRatingRatingNew Rating

Result

TypeRequireDefaultLimitationDescription

Implementation Example

namespace = args.namespace
oldRating = args.oldRating
newRating = args.newRating

result = {
}