APIAPI's Interaction Kit
Server-authoritative interactions for multiplayer games: detection, prompts with input-device glyphs, Instant / Hold / Toggle behaviours, Door / Lever / Pickup presets and a fair multi-user lock — C++ with a Blueprint-exposed API.
These pages are the same documents that ship inside the plugin's Docs/ folder (plugin UKInteraction, version 1.0.2). Questions? Get support.
Getting started
Install the plugin, follow the quick start, and see it working.
Quick start
Enable the plugin, add the two components, bind one event and play with two players.
Read →Installing APIAPI's Interaction Kit
Supported engines and platforms, install locations, and what ships in each module.
Read →The demo map
Six working stations in one room: what each station shows and which events drive it.
Read →Guides
One page per feature: how it behaves on every machine, its settings, and its known limits.
Basic behaviors — Instant, Hold and Toggle
Instant, Hold and Toggle: parameters, defaults and how each behaves across the network.
Read →Door, Lever and Pickup
The stateful presets: Door, Lever and Pickup.
Read →Multi-user lock — Exclusive Queue
Exclusive Queue: one player at a time, with a fair turn order for the rest.
Read →The prompt and the glyphs
The on-screen prompt, its why-not line, and input-device glyphs.
Read →Input — the Enhanced Input binding and its edge cases
The Enhanced Input binding and its edge cases.
Read →Detection — the profile, the gather sources, and line of sight
Detection profiles, gather sources and line of sight.
Read →Movement and the interactor's velocity hook
How the interactor reads your pawn's velocity, and how to plug in your own movement.
Read →Events - which one fires, where, and what it carries
Which event fires, on which machine, and what it carries.
Read →Interaction protocol — server authority, client prediction, and what a modified client gains
Server authority, client prediction, and what a modified client can and cannot gain.
Read →Runtime debug overlay
The runtime network debug overlay and its console commands.
Read →Editor validator
The editor validator: every UK-VAL rule, where it runs and how to fix it.
Read →Optional adapters
The optional GAS and CommonUI glyph adapters.
Read →Testing APIAPI's Interaction Kit
Run the kit's own automation suite in your project.
Read →Reference
API surface, schemas and engine-version details.