Skip to main content

HelixJS API Reference

The HelixJS runtime exposes a single global, Helix. All APIs are members of Helix; use Helix.Player, Helix.Database, Helix.WebUI, and so on. No require is needed.

MemberDescription
HelixCore: client, server, on, emit, endpoint, call, playerJoined
Helix.PlayerPlayer and character: health, pawn, controller, fetchData, setCharacter
Helix.DatabaseSequelize-backed DB: connect, models, create, findOne, findAll, update, remove, raw
Helix.WebUIWeb UI widgets: new Helix.WebUI(...), SendEvent, RegisterEventHandler, SetInputMode, Destroy
Helix.InputKey bindings: Helix.Input(key, callback)
Helix.StateGlobal state: set, get