API reference · v1
Complete API reference
Inspect every published HTTP documentation endpoint and every callable function in the five public native SDK interfaces.
The HTTP routes below serve static documentation files from GitHub Pages. They do not call into a running game. Native add-ons use the in-process C ABI documented under Native SDK calls.
HTTP documentation API
Quick start
Begin with discovery, follow the current version into its resource catalog, then cache or consume only the fields your tooling needs.
curl --fail https://lorexvalkin.github.io/UNBSE/api/index.jsonconst response = await fetch(
"https://lorexvalkin.github.io/UNBSE/api/index.json"
);
if (!response.ok) throw new Error(response.status);
const discovery = await response.json();All routes
HTTP endpoints
Every route is read-only and versioned. Examples and response previews are loaded from the checked-in OpenAPI contract and current JSON resources.
In-process C ABI
Native SDK calls
Query each versioned export, initialize every structure size, inspect capabilities, and handle numeric results. Canonical headers remain authoritative when prose and declarations differ.
Canonical declarations
SDK headers
These five versioned headers form the public add-on SDK. Download from the published path or include the same files from the repository.
UNBSEAddonHostV1.hDownload
UNBSEMessagingV1.hDownload
UNBSEScriptServiceV1.hDownload
UNBSERuntimeInfoV1.hDownload
UNBSERelocationV1.hDownload
Only the five headers listed above are published as the SDK v1 contract. Other repository headers are not part of this documentation API.
Runtime boundary
Compatibility
Runtime information reports what is loaded. Each add-on remains responsible for checking the exact game build and behavior it supports; relocation performs ownership and bounds checks, not semantic validation.