Skip to content
HELIX is in Closed Alpha. Some features and documentation may be non-functional or out of date.

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.

Member Description
Helix Core: client, server, on, emit, endpoint, call, playerJoined
Helix.Player Player and character: health, pawn, controller, fetchData, setCharacter
Helix.Database Sequelize-backed DB: connect, models, create, findOne, findAll, update, remove, raw
Helix.WebUI Web UI widgets: new Helix.WebUI(...), SendEvent, RegisterEventHandler, SetInputMode, Destroy
Helix.Input Key bindings: Helix.Input(key, callback)
Helix.State Global state: set, get