Unity Client API Reference

This is the complete reference for the TurnKit Unity client runtime API. Relay is the main entry point for matchmaking, gameplay actions, lists, stats, and voting. For package installation and project setup, start with the Unity Quickstart.

Getting Started

Before using Relay operations, authenticate the player and connect to a match. Identity setup differs by auth mode, so check Player Authentication Modes before wiring your login flow.

Connection Flow

// Authenticate and enter the match
// Option A: Development / Open (No verification)
await Relay.MatchWithAnyone(playerId, ExampleConfig.Slug);

// Option B: Standard Session (After OTP/Social Auth)
var session = new TurnKitPlayerSession(playerId, playerToken, email);
await Relay.MatchWithAnyone(session, ExampleConfig.Slug);

// Option C: Secure/Signed (External backend verification)
var signed = new TurnKitSignedPlayer(playerId, timestamp, nonce, signature);
await Relay.MatchWithAnyone(signed, ExampleConfig.Slug);

Core Relay Actions

These methods control move submission and match flow once the client is connected.

Lists & Items

Lists are the primary way to represent runtime state such as hands, decks, discard piles, and board zones.

Accessing Lists

var results = Relay.List(ExampleConfig.List.results_public);      // throws if not found
var publicList = Relay.GetList(ExampleConfig.List.results_public); // returns null if missing

var myHands = Relay.GetMyLists(ExampleConfig.Tag.hand);
var opponentHands = Relay.GetOpponentsLists(ExampleConfig.Tag.hand);

List Operations

// Spawn
list.Spawn("card_slug");
list.Spawn(customItemId, "card_slug");

// Move items
list.Move(SelectorType.TOP).To(targetList);
list.Move(SelectorType.BY_SLUGS, new[] { "king", "queen" })
    .Repeat(2)
    .IgnoreOwnership()
    .To(targetList);

// Remove and shuffle
list.Remove(SelectorType.ALL);
list.Remove(SelectorType.BY_ITEM_IDS, itemIds).Repeat(3);
list.Shuffle();

Querying Items

Useful Properties

Reach for list.Count, list.Items, list.Top, list.Bottom, list.IsOwnedByMe, and list.IsVisibleToMe when rendering gameplay UI.

Stats & Leaderboards

Stats can be tracked per match or per player, and can feed directly into configured leaderboards. For the dedicated leaderboard module, continue to the Leaderboards docs. For webhook destinations and post-match routing, see Relay Stats & Leaderboards.

// Per-player stat
Relay.Stat(ExampleConfig.Stats.Score)
    .ForPlayer(Relay.MySlot)
    .Add(150);

// Simple stat updates
Relay.Stat(ExampleConfig.Stats.Status).Set("won");
Relay.Stat(ExampleConfig.Stats.Tags).Add("first_blood", "aggressive");

Direct Leaderboard Methods

Player & Session

Authentication

await TurnKitAuth.RequestOtp(email);
var session = await TurnKitAuth.VerifyOtp(email, otp);

new TurnKitPlayerSession(playerId, token, email);
new TurnKitSignedPlayer(playerId, timestamp, nonce, signature);
signedPlayer.BuildSignaturePayload(); // returns the string to sign

Match State Properties

Helper & Utility Methods

Error Handling & Best Practices

• Relay.MatchWithAnyone() returns false instead of throwing on config or queue failures.
• Action methods such as Commit, EndMyTurn, and Vote become no-ops when the WebSocket is disconnected.
• Prefer generated config enums like ExampleConfig.List.xxx and ExampleConfig.Stats.xxx over raw strings.
• Complex list operations are safest and clearest when you use the fluent builder pattern.
• Combine Relay with post-match webhooks for backend workflows, rewards, or verified leaderboard submission after each match.

Main Source Files