Unreal Engine Integration

Installation

1. Download the plugin .zip above.
2. Extract into your project's Plugins/ folder — create it if it doesn't exist.
3. Open Unreal Editor. Go to Edit → Plugins → Project → PikStats and confirm it's enabled.
4. Restart the editor if requested.

Configure SDK Key

The SDK key authenticates your game. You can set it in two ways:

Option A — Project Settings (recommended)

1. Open Edit → Project Settings → PikStats.
2. Paste your SDK key into the SDK Key field.
3. Save. The plugin picks it up automatically at runtime.

Option B — Blueprint at runtime

Call PikStats → Set SDK Key before any other PikStats node. Useful if you load the key from a config file or remote endpoint.

Nodes Overview

All PikStats nodes are async — they fire an output exec pin when the server responds. Search PikStats in the Blueprint context menu to find them all.

Identify Player

Registers a player on first call. Safe to call every session — if the player already exists it's a no-op. Free.

Set Variable

Writes a value for one variable for one player. Costs 1 PIKE. If the player doesn't exist, they are created automatically.

Get Player

Fetches all live variable values for a player. Free. Use this on session start to restore saved stats.

Use Find on the output map to retrieve individual values by variable name.

Leaderboard

Fetches the top N players for a variable. Optionally appends the calling player's rank if they fall outside the top N. Costs 1 PIKE.

Fetch Variables

Returns all live variables and their tokens. Useful for resolving tokens by name at runtime instead of hardcoding them. Free.

Cache the result at startup and look up tokens by name to avoid hardcoding them throughout your Blueprint graph.

Set Game Variable

Writes a value to a Game System Variable — a single game-wide value not tied to any player (e.g. launch counter, active event, difficulty multiplier). Costs 1 PIKE.

Get Game Variables

Fetches all live Game System Variables and their current values. If a variable has never been set, its default value is returned. Free.

Use Find on the output map to retrieve individual values by name. Call this at game startup to load remote config, active events, or other game-wide state.

World Rank

Returns a player's global rank for a variable as a single integer — e.g. rank 423 out of all players. Free. No SDK key required — safe to call from any context.

Higher values rank better (rank 1 = highest value). Only works on Player Variables. Game System Variables cannot be ranked.

Pin Reference

Struct fields

Leaderboard Entry — each item in the Entries array:

Variable Info — each item in the Fetch Variables array:

Tips

• Call Identify Player once per session — on Begin Play or after login, not on every variable write.
• Fetch Variables at startup — cache the token map in a Game Instance variable so you never hardcode tokens in individual nodes.
• Debounce rapid writes — if score updates every frame, use a timer (e.g. every 5 s) to batch-send the last value instead of calling Set Variable 60× per second.
• Check PIKE Remaining — if it drops to zero, Set Variable and Leaderboard calls are still accepted but logged as alerts. Top up from Buy PIKE.
• On Failure is a network error — not an API error. The API never signals errors to the client. Check dashboard alerts for API-level issues.
• Variable tokens are per-variable — if you have score, level, and skin, each needs its own token. Find them on the Variables page.
• Use Fetch Variables to route scope automatically — check the Scope field on startup and call Set Game Variable or Set Variable accordingly, rather than hardcoding which is which.
• Call Get Game Variables once at startup — cache the result in a Game Instance variable for remote config like difficulty, active events, or feature flags.
• World Rank needs no SDK key — you can call it from a web overlay, a friend's client, or any context outside your game without exposing your SDK key.