API Reference

Auto-generated reference for the Lucky Engine C# scripting API (namespace Hazel). Browse by area:

Scene & Entities

The scene graph: entities, their lifecycle, and scene-level queries. This is where scripting begins — most scripts derive from Entity.

12 types

Components

Data and behavior you attach to entities (transforms, meshes, lights, cameras, rigid bodies, audio, and more). Retrieved with GetComponent<T>().

27 types

Math

Vectors, quaternions, matrices, and math helpers for transforms, interpolation, and randomness.

11 types

Physics

3D and 2D physics queries, ray casts, colliders, materials, and force application.

19 types

Rendering

Meshes, materials, textures, colors, and the debug/immediate-mode renderer.

13 types

Audio

Play, control, and position sounds in the scene.

3 types

Animation

Animation sequences and playback.

7 types

Core & Input

Engine fundamentals scripts use every frame: input, logging, timing, application state, and assets.

18 types

Editor Attributes

Attributes that control how your script's public fields appear and behave in the editor Inspector (sliders, ranges, tooltips, grouping, conditional visibility).

25 types

Robots & Learning (MDP)

APIs for authoring robot agents and reinforcement-learning tasks: the MDP component model (observations, rewards, terminations, randomization), robot controllers, and agent management.

45 types