Skip to content

API Reference

The X-Ray 16 engine API is the primary reference for game globals, luabind classes, UI and GOAP classes, and script objects. The rest of this generated reference covers the remaining published xray16 package surfaces.

PackageDescription
xray16Engine declarations — globals, luabind classes, UI and GOAP classes, and script objects.
xray16/aliasReadable aliases for engine declaration names and virtual engine enums.
xray16/macrosCompile-time helpers with a Node/Jest runtime fallback.
xray16/libShared aliases, constants, and small runtime helpers.
xray16/testingJest configuration factory, setup helpers, and matchers.
xray16/mocksLua-like runtime helpers and engine class mocks for Node-based tests.

Declarations describe the TypeScript-visible API shape. C++ engine bindings define runtime behavior, so check the engine source when declaration syntax is ambiguous.