Skip to Content
NIXWAREdocs

API index

Index of named API symbols: functions, callbacks, constants, methods and types, each linked to its reference section.

Use this page to locate a symbol by name, then open the linked section for the signature, return values and errors.

The index lists symbols that have a qualified name. It does not list:

  • fields of objects, tables and specs (for example trace_t fields or the esp element spec); they are on the object's or namespace's page;
  • value-type methods without a qualified name (length, dot, lerp, …); see Value types: Methods.

If a name is not here, search the site or read the page of the namespace or object it belongs to.

Callbacks

Registering events.<name> callbacks: render, key, createmove, frame_stage, console and chat hooks, game events, return values and per-frame order. See Callbacks.

Global functions

print and color_print: writing text to the game console. See Global functions.

timer

Per-script timers: timer.delay, timer.every, timer.cancel, timer.realtime and the frame-aligned scheduling rules. See timer.

notify

notify.show: display a menu notification. See notify.

utils

Random numbers from the engine stream, the license user name, the script file name and self-unload. See utils.

globals

Read-only live game values: realtime, curtime, frametime, framecount, tickcount, tickfraction, tickinterval and maxplayers. See globals.

clipboard

Read and write the Windows clipboard as UTF-8 text. See clipboard.

console

Queue console commands, look up console variables and commands by name, and iterate the console registry. See console.

memory

Raw native access: pattern scans, CreateInterface, exports, and binding virtual or pattern-located functions through FFI. See memory.

panorama

Run JavaScript in Panorama panels with panorama.loadstring and read Panorama globals from Lua. See panorama.

input

Keyboard and mouse state per rendered frame: key and button checks, cursor position, delta, wheel and virtual-key codes. See input.

fs

File operations relative to the script's data directory: read, write, append, exists, remove, mkdir, list and path restrictions. See fs.

render

2D and world-space drawing: text, lines, rectangles, circles, polygons, clipping, textures and screen queries, and when drawing is available. See render.

particles

Create and control game particle effects: particles.create, PATTACH_* attachments, control points, paths and effect lifetime. See particles.

esp

Register custom ESP Builder elements: element spec, slots, settings, render and value callbacks, element handles, errors and saved settings. See esp.

engine

Game state and level queries, local HUD chat output, sound playback and netvar offsets. See engine.

trace

World traces through the game's physics query: trace.line, trace.shape and trace.bullet. See trace.

entitylist

Find entities: local pawn and controller, lookups by handle or index, class lists, pawns, controllers and game rules. See entitylist.

Value types

The vector, vector2d, vector4d, angle and color FFI value types: constructors, methods, operators, pointers, containers, 64-bit integers and angle maths. See Value types.

Entities

base_entity_t: schema field access, entity methods and entity lifetime. See Entities.

gameevent

Game event object passed to events.<event name> callbacks; fields are read by key name. See gameevent.

chat_message_t

Mutable HUD chat message passed to the player_chat callback. See chat_message_t.

view_setup

Mutable view setup passed to the override_view callback. See view_setup.

user_cmd_t

Read-only snapshot of the user command passed to the createmove callback. See user_cmd_t.

console.variable

Console variable handle returned by console.<name> and console.variables(): reading and setting values. See console.variable.

console.command

Console command handle returned by console.<name> and console.commands(). See console.command.

panorama.object

Lua wrapper around a JavaScript value from Panorama. See panorama.object.

ray_t

Ray shapes for trace.shape: a line, an offset line, a sphere, a box or a capsule. See ray_t.

trace_filter_t

Trace filter: interaction mask, collision group, entity iteration and an optional should_hit predicate. See trace_filter_t.

trace_t

Result of trace.line and trace.shape. See trace_t.

hitbox_t

The game's hitbox record (CHitBox) returned by e:hitbox(index) and tr.hitbox. See hitbox_t.

rn_collision_attr_t

Collision attributes exposed by trace_t.shape_attributes. See rn_collision_attr_t.

Script UI

Build a script's settings UI: ui.panel, ui.tab, ui.find, ui.section, control builders, node methods, control values, built-in tabs, locales and menu_object_t. See Script UI.

Script UI

Build a script's settings UI: ui.panel, ui.tab, ui.find, ui.section, control builders, node methods, control values, built-in tabs, locales and menu_object_t.

Examples

Complete scripts: hit log, health and armour overlay, chat message filter and timed reminder.

On this page