Epok Engine

EPOK RUNTIME

epok::Level

Class

Class

Class declared by the object-model module for the object model module.

Namespace
epok
Header
object_model.hpp
Include
#include "object_model.hpp"
Module
object-model
Source
runtime/object_model.hpp:688
Inherits from
Object

Basic usage

This minimal snippet shows the normal syntax for reaching the type. Open a member below for an operation-specific example.

C++ example
#include "object_model.hpp"

epok::Level& value = /* obtain a valid instance from your game */;

Nested types

ActorPrepareFn---- spawning ------------------------------------------------------------------ Preparation hook, run once per reserved actor after its defaults, root, owner and registration are in place and *before* any `begin_play` of this batch (design.md section 6, between steps 2 and 5).Type alias

Fields and constants

static_class_idExposes `static_class_id` on `epok::Level` for the object model module.Variable

Public methods

actor_active---- activation ----------------------------------------------------------------Methodactor_atPerforms `actor at` as part of the object model module.Methodactor_countPerforms `actor count` as part of the object model module.Methodadd_component---- components ----------------------------------------------------------------Function templatebindBinds the slot table and registers the Level itself.Methodclass_idPerforms `class id` as part of the object model module.Methodcreate_scene_scriptThe scene script is created by the loader; it is never part of the actor table.Methoddestroy_actor---- destruction --------------------------------------------------------------- A request made inside a callback marks the actor immediately (it receives no further events) and runs the teardown when the current batch finishes.Methodend_play_allExit order: scene script first while the actors are still alive, then every actor.Methodframe_updateOnce per rendered frame, even while paused (legacy Behaviour parity).Methodget_componentReturns component as part of the object model module.Function templateget_componentsReturns components as part of the object model module.Function templateregistryPerforms `registry` as part of the object model module.Methodremove_componentRemoves component as part of the object model module.Methodscene_scriptPerforms `scene script` as part of the object model module.Methodset_activeSets active as part of the object model module.Methodset_logical_parentSets logical parent as part of the object model module.Methodspawn_actorPerforms `spawn actor` as part of the object model module.Methodspawn_batchAll or nothing.MethodstatsPerforms `stats` as part of the object model module.Methodtick---- ticking -------------------------------------------------------------------Method