Concepts
Event Name
Each event must have an event name. We do have certain recommendations for what these names might be but you are not limited to these recommendations and our missions can use any event name that is suitable for your game.
Examples of event names:
START_MATCH
DEAL_DAMAGE
KILL_PLAYER
GAME_SCORE
Value
Each event can have one numerical value included, but it is not required. The value of one or several events, are
what enables missions to have numerical goals (i.e. max
, min
, sum
, etc.).
In the example of event name DEAL_DAMAGE
, the value attached to that event would naturally be the
amount of damage dealt by the player. A mission could then look at all of these events in a match (group) and take
the sum of those values, and evaluate a mission like "Deal 1,000 damage" or even "Deal 1,000 damage in 1 minute" if
evaluated together with the timestamps of each event.
Traits
Traits are optional parameters that can be included on any event. The usage of traits are to complement the Event Name
and can act as a filter for the events. In the example of the event KILL_PLAYER
, you can include multiple traits that
specifies what weapon was used, what gear the player was wearing, who the other player was, etc., enabling missions
like "Kill another player using a Knife".
Being strategic with the event traits, will open up a lot of possible missions, without having to make regular changes to the API implementation.
NOTE! There is a limit of at most 25 traits attached to any event. If you hit this limit, concider breaking it up into
multiple events with the same groupId
.