Stranded III - Lua API Reference
Welcome to the official Lua API reference for Stranded III. Lua scripts can manipulate world objects, interact with game entities, manage inventory, execute timers, display dialogues, control scene nodes, and respond to engine hooks. Select a class or module below to view its properties, methods, parameter signatures, return types, and code examples.
Debug (1)
3D spatial debug drawing (lines, rays, arrows, shapes, volumes, text, gizmos) and 2D screen text overlay.
Definitions & Systems (6)
Attribute definition descriptor (health, stamina, hunger, thirst, etc.).
Construction and building site system hooks and definitions.
Material definition descriptor for physical and visual material properties.
Random world event definition system and lifecycle hooks.
Active status effect instance attached to an entity.
Status effect definition descriptor and event callbacks.
Dialogue (3)
Dialogue container managing narrative conversations, branching, and UI playback.
Individual dialogue graph step (narrative, NPC speech, choices, branch, delay).
Enumeration constants for dialogue step types.
Effects & Audio (1)
Global module for screen transitions, 3D particle visual effects, sound effects, and music playback.
Localization (1)
Localization key lookups and string parameter formatting.
Math (7)
3D Axis-Aligned Bounding Box for spatial queries, bounds calculation, and collision.
RGBA color representation with channels between 0.0 and 1.0.
Color gradient ramp with configurable keyframe points.
Quaternion representation for 3D orientations and rotations without gimbal lock.
2D vector representing points, offsets, UV coordinates, or directions.
3D vector representing world positions, velocities, scales, or Euler angles.
4D vector representing 4-component coordinates or parameters.
Scene & Nodes (1)
Godot Node scene hierarchy wrapper for transforms, meshes, materials, and children.
World & Entities (4)
Core entity object and global entity management (spawning, hierarchy, attributes, states, events).
Entity definition descriptor and registry lookups.
Local player queries and character access.
Terrain height, slope, normal, control map, and texture layer queries.