Scripting

Overview

SafiEngine uses native C++ behaviors for all gameplay logic. Behaviors are classes that extend the Behavior base class and have full access to every engine subsystem: input, physics, audio, ECS, rendering, and more.

Unlike external scripting languages, behaviors compile directly into the engine binary. This means zero overhead, full type safety, and complete access to the C++ standard library.

Behavior Lifecycle

Every behavior has two virtual methods:

class Behavior {
public:
  virtual void OnStart(flecs::entity e, Engine &engine) {}
  virtual void OnUpdate(flecs::entity e, Engine &engine, float dt) {}
};

Method	When Called	Use For
`OnStart`	Once, when play mode begins	Initialization, reading properties, caching references
`OnUpdate`	Every frame while playing	Input handling, movement, game logic

Both methods receive the entity the behavior is attached to and a reference to the engine.

Engine Subsystems

Inside any behavior method you have access to every subsystem:

Subsystem	Access	Description
Input	`engine.GetInput()`	Keyboard, mouse, action mapping
Physics	`engine.GetPhysicsWorld()`	Velocity, gravity, collision bodies
Audio	`engine.GetAudioEngine()`	Sound playback, 3D spatialization
ECS World	`engine.GetWorld()`	Create/query/modify entities
Asset Manager	`engine.GetAssetManager()`	Load and cache assets
Debug Draw	`engine.GetDebugDraw()`	Wireframe lines, boxes, spheres
Event Bus	`engine.GetEventBus()`	Publish and subscribe to events
Renderer	`engine.GetRenderer()`	View/projection matrices
Camera	`engine.GetMainCamera()`	Get the active camera entity
Delta Time	`dt` or `engine.GetDeltaTime()`	Frame time in seconds

Workflow

Create a .cpp file in Core/src/behaviors/
Define a class extending Behavior
Export a registration function
Add the forward declaration and call in Behavior.cpp
Add the file to Core/CMakeLists.txt
Rebuild the engine

See Getting Started for a step-by-step walkthrough.

Section Contents

Getting Started - Your first script
Input & Controls - Keyboard, mouse, action mapping
Transform - Position, rotation, scale
Physics - Velocity, forces, rigid bodies
Camera - Camera control and switching
Animation - Skeletal animation control
Audio - Sound playback and 3D audio
Entities - Working with other entities
Events - Communication between behaviors
Script Properties - Inspector-configurable parameters
Complete Examples - Full working behaviors

#Scripting

#Overview

#Behavior Lifecycle

#Engine Subsystems