3. Events API

Points in Time vs. Persistent State

While Attributes track the continuous, ongoing state of a game session, Events represent specific, instantaneous occurrences.

An event triggers the exact millisecond something noteworthy happens - like a player firing a gun, purchasing an item, dying, or winning a match. Every event is automatically timestamped down to the millisecond by the SDK, ensuring accurate sequential processing.

The API Surface

The SDK provides a straightforward method to dispatch events, allowing optional contextual data dictionaries to be attached to the payload.

1. Sending Simple Events

For basic occurrences that do not require extra metadata, you can call SendEvent with just an event name.

using NX10;
using UnityEngine;

public class MenuController : MonoBehaviour
{
    public void OnSettingsOpened()
    {
        // Dispatches a simple event without additional metadata
        NX10Manager.Instance.SendEvent("settings_opened");
    }
}

2. Sending Events with Metadata

To provide deep insights into an event, pass a flat dictionary as the second argument. This is crucial for tracking transaction amounts, enemy types, or specific match outcomes.

using NX10;
using System.Collections.Generic;
using UnityEngine;

public class GameManager : MonoBehaviour
{
    public void ResolveMatch(int amountWonOrLost)
    {
        // Instantiating custom event context
        var eventData = new Dictionary<string, object>();
        
        // Append transactional details
        eventData.Add("amount", amountWonOrLost);

        // Dispatches the event with payload and automatic timestamping
        NX10Manager.Instance.SendEvent("player_won", eventData);
    }
}