Reference (Web SDK)
The auto-generated API reference for @helix/sdk. This page is generated from the SDK's TypeScript source on every merge.
Auto-generated
This reference is generated from the @helix/sdk TypeScript source with TypeDoc and refreshed
automatically when the SDK changes on main. See the pipeline
for how it works. The page below is a representative sample of the generated output until the
SDK source is wired in.
Helix.wallet
The player's economy surface. See the LIX & Economy concept page for semantics.
getBalance()
getBalance(): Promise<Balance>Returns the current player's balances.
Prop
Type
Throws — HelixError('NOT_INITIALIZED') if called before Helix.init.
onBalanceChanged(callback)
onBalanceChanged(cb: (balance: Balance) => void): UnsubscribeSubscribes to wallet changes; returns an unsubscribe function. Fires after a purchase settles server-side.
Helix.cloudSave
Durable per-world key–value storage. Concept: Cloud Save.
get<T>(key)
get<T>(key: string): Promise<T | null>Prop
Type
set<T>(key, value)
set<T>(key: string, value: T): Promise<void>Writes durably; resolves once the write is committed.
The full reference
When the SDK source is connected, this section lists every namespace, class, method, parameter,
return type, and error — auto-generated and always in sync with the shipped @helix/sdk. The
hand-written Platform API pages link here for exact signatures, and this
reference links back to them for semantics.
Multiplayer & Networking
HELIX's own real-time networking for web worlds — events, instances, and the hybrid server-authoritative model. Web-runtime only.
Native (Unreal) SDK
The HELIX Platform API inside Unreal Engine — the same functions in C++, Blueprint, PuerTS (TypeScript), and UnLua (Lua), plus engine-native networking.