GS2-Mission API Reference

Mission and achievement feature

This service provides a mission function.

The mission function allows users to set conditions such as “complete n quests” or “obtain n characters” and receive rewards for achieving these conditions. To achieve this, a mechanism called “setting mission conditions,” “subscribing to a counter,” and “raising the counter” is used.

Setting a condition for a mission is to set a counter threshold at which the mission will have been accomplished.

Subscribing to a counter is the setting of the counter to which the mission is subject. One counter can be subscribed to from multiple missions, and different reset timings can be set for each mission. For example, if you want to create a mission that says “completed a total of 1000 quests” and a daily mission that says “completed 10 quests today Subscribe to one counter from both missions that counts up each time a quest is completed, no reset for the former and By setting a daily reset timing, you can handle missions with multiple conditions with a single counter operation.

Raise Counter is an operation that literally raises the counter, for example, when a quest is completed, the counter rise in the number of times the quest is completed is included in the reward.

Two durations can be set for a mission. The first is the period during which the counter can be manipulated, and is used in cases where raising the counter is limited to the event period. The second is the period during which mission rewards can be received, and can be used to set two separate periods when you want to receive only mission rewards for a while after the event is over. To specify the time period, associate the event with the GS2-Schedule event.


Use in your game

Game Engine

Specifications of models and API references for GS2-Mission SDK for Game Engine

SDK

Specification of models and API references for GS2-Mission SDK for various programming languages

Configuration and integrations

Deploy/CDK

The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK

Master Data

Reference for the master data format and the models to be imported

Script

Reference for event triggers that call extended scripts

Transaction Action

Specification of verify/consume/acquire transaction actions

Buff

Describes the fields within models/actions whose parameters can be adjusted when applying buffs with GS2-Buff, and how to configure the scope in which those buffs are applied.