API reference

ScaleSystem Class

Extends SystemBase
DeprecatedHierarchy scale, the default, applies Scale through the transform hierarchy. This system only acts in the deprecated pose-only mode (TickTransformSystem.applyScale = false) and will be removed with it.
This System scales an entity based on the Scale component, for the pose-only scale mode.
It applies scaling to SceneObjects when the Scale, Mesh, or Panel components change, but only while TickTransformSystem.applyScale is false. With it true, the default, the engine bakes Scale (including hierarchy scale) into the composed world transform delivered to features and graphics, and this system would double-apply it, so ScaleSystem.execute is a no-op.

Signature

class ScaleSystem : SystemBase

Constructors

ScaleSystem ()
Signature
constructor()
Returns
ScaleSystem

Properties

executeCount : Long
[Get]
The number of times this system's SystemBase.execute method has been called by the system manager. Incremented automatically before each execution cycle. Useful for performance monitoring.
@Volatile guarantees atomic 64-bit reads + happens-before semantics so the introspection reader (which runs on the dump caller's thread) observes a consistent value. Only SystemBase.incrementExecuteCount writes this field, so the non-atomic read-modify-write is safe.
Signature
var executeCount: Long
systemManager : SystemManager
[Get][Set]
The SystemManager that this system is registered with. Provides access to other systems and the scene. Initialized during system registration.
Signature
lateinit var systemManager: SystemManager

Methods

associateSystemManager ( systemManager )
Associates this system with a SystemManager. Called during registration. Throws RuntimeException if the system is already associated — each system instance can only belong to one manager.
Signature
fun associateSystemManager(systemManager: SystemManager)
Parameters
systemManager: SystemManager  The system manager that will own and execute this system.
delete ( entity )
Called when an entity is removed from the scene. Override to clean up any per-entity state this system maintains, such as cached components, tracking maps, or native resource handles.
Signature
open fun delete(entity: Entity)
Parameters
entity: Entity
destroy ()
Called during system shutdown to release all resources held by this system. Override to dispose of native handles, close streams, and clear any global state accumulated during the session. Subclasses must call super.destroy() so the framework can clean up auto-registered introspection nodes.
Signature
open fun destroy()
execute ()
Called each frame by the SystemManager to perform this system's per-tick logic. Override to query entities with relevant components and apply updates.
Signature
open override fun execute()
getDependencies ()
This system must run after the MeshCreationSystem.
Signature
open override fun getDependencies(): SystemDependencies?
Returns
SystemDependencies?
getScene ()
Returns the Scene that this system operates within. Delegates to the associated SystemManager to retrieve the active scene instance.
Signature
fun getScene(): Scene
Returns
Scene  The scene containing the entities and rendering state for this system.