SortGroupComponent

Defined in: renderer/src/SortGroupComponent.ts:170

Renders an entity’s subtree of visuals as a single depth unit.

Under a layer sort (e.g. ySort) every sprite is otherwise a flat child of the layer with its own independent depth key, so a multi-part entity — a body plus an offset held item, or a parent plus child entities — can be split when an unrelated entity’s key falls between its parts. A SortGroupComponent gives the entity its own Pixi sub-container: the members sort within the group, and the group sorts as one unit against the rest of the layer (keyed off the group-owning entity’s own sprite, falling back to its Transform position when it has no sprite of its own).

The group container is kept at identity/origin, so members hold their normal world transforms — adding a group changes paint order only, never position, rotation, or scale (those stay composed by the ECS Transform).

class Knight extends Entity {
  setup() {
    this.add(new Transform({ position: { x: 200, y: 200 } }));
    this.add(new SortGroupComponent({ layer: "world" }));
    this.add(new SpriteComponent({ texture: "knight-body", layer: "world" }));
    // Child sprites on the "world" layer join the group automatically:
    this.spawnChild("weapon", Weapon); // a sprite offset toward the camera
    this.spawnChild("plume", Plume);
  }
}

Add the component before the visuals it should capture (it also re-homes any already-present subtree visuals when added late, and after save/load). A SortGroupComponent on a descendant entity starts its own independent unit rather than nesting inside the ancestor’s.

Extends

Component

Constructors

Constructor

new SortGroupComponent(options?): SortGroupComponent

Defined in: renderer/src/SortGroupComponent.ts:181

Parameters

options?

SortGroupComponentOptions

Returns

SortGroupComponent

Overrides

Component.constructor

Properties

container

readonly container: DisplayContainer

Defined in: renderer/src/SortGroupComponent.ts:172

The group’s Pixi container. Kept at identity; holds the member visuals.

entity

entity: Entity

Defined in: core/dist/index.d.ts:2716

Back-reference to the owning entity. Set by the engine when the component is added to an entity. Do not set manually.

Inherited from

Component.entity

innerSort

innerSort: LayerSortFn | undefined

Defined in: renderer/src/SortGroupComponent.ts:176

Depth key for intra-group member order, or undefined for insertion order.

layer

readonly layer: string

Defined in: renderer/src/SortGroupComponent.ts:174

Layer this group renders into.

restorePriority?

static optional restorePriority?: number

Defined in: core/dist/index.d.ts:2874

Snapshot restore order. On load, an entity’s components are re-added in ascending priority, so a component whose onAdd() reads a sibling can rely on lower-priority siblings being present and initialized. Undeclared = 100. Engine components reserve 0-99; game and addon components declare a value only when a sibling onAdd() dependency requires it. Equal priorities restore in save-time add order. Subclasses inherit their base class’s priority unless they declare their own.

Inherited from

Component.restorePriority

updatePriority?

static optional updatePriority?: number

Defined in: core/dist/index.d.ts:2889

Class-level default for updatePriority: every instance runs at this priority unless its own updatePriority is written. Undeclared = 0. Subclasses inherit their base class’s value unless they declare their own. Declare it on a component whose behavior depends on running after (or before) a sibling, so the entity that adds it does not have to control the add order.

class BoundsClamp extends Component {
  static updatePriority = 10; // after the follow that moves the camera
}

Inherited from

Component.updatePriority

Accessors

context

Get Signature

get context(): EngineContext

Defined in: core/dist/index.d.ts:2770

Access the EngineContext from the entity’s scene. Throws if the entity is not in a scene.

Returns

EngineContext

Inherited from

Component.context

effectiveEnabled

Get Signature

get effectiveEnabled(): boolean

Defined in: core/dist/index.d.ts:2740

Whether the component is actually running: enabled, on an active entity, and past onAdd. This is the state onEnable and onDisable track — read it when a method has to behave one way live and another way dormant.

Returns

boolean

Inherited from

Component.effectiveEnabled

enabled

Get Signature

get enabled(): boolean

Defined in: core/dist/index.d.ts:2732

Whether this component runs. Disabled components are skipped by ComponentUpdateSystem.

Writing this fires onEnable / onDisable when the effective state changes — enabled && entity.isActive. A component disabled here stays disabled through a setActive(false) / setActive(true) cycle on its entity.

Returns

boolean

Set Signature

set enabled(value): void

Defined in: core/dist/index.d.ts:2733

Parameters

value

boolean

Returns

void

Inherited from

AnimationController.enabled

scene

Get Signature

get scene(): Scene

Defined in: core/dist/index.d.ts:2765

Access the entity’s scene. Throws if the entity is not in a scene. Prefer this over threading through this.entity.scene in component code.

Returns

Scene

Inherited from

Component.scene

updatePriority

Get Signature

get updatePriority(): number

Defined in: core/dist/index.d.ts:2758

Where this component runs among its siblings. ComponentUpdateSystem calls update / fixedUpdate on an entity’s components in ascending priority; equal priorities run in add order. Undeclared = 0, so a negative value runs before siblings that keep the default and a positive value runs after them. Writable at any time, before or after add(). Defaults to the class’s static updatePriority.

class Player extends Entity {
  setup() {
    this.add(new Mover());
    this.add(new Brain()).updatePriority = -1; // decides before Mover moves
  }
}

Returns

number

Set Signature

set updatePriority(value): void

Defined in: core/dist/index.d.ts:2759

Parameters

value

number

Returns

void

Inherited from

Component.updatePriority

Methods

_applyEnabled()

_applyEnabled(effective): void

Defined in: core/dist/index.d.ts:2824

Internal

Force an effective-enabled transition, firing the hook on a flip. Used by Entity for teardown, where enabled and the entity’s activeness both still read true.

Parameters

effective

boolean

Returns

void

Inherited from

Component._applyEnabled

_refreshEnabled()

_refreshEnabled(): void

Defined in: core/dist/index.d.ts:2817

Internal

Recompute effective enabled-ness from enabled and the entity’s activeness, firing the hook on a flip.

Returns

void

Inherited from

Component._refreshEnabled

_runCleanups()

_runCleanups(): void

Defined in: core/dist/index.d.ts:2811

Internal

Run and clear all registered cleanups. Called by Entity.remove() and Entity._performDestroy() before onRemove/onDestroy.

Returns

void

Inherited from

Component._runCleanups

addCleanup()

protected addCleanup(fn): void

Defined in: core/dist/index.d.ts:2805

Parameters

fn

() => void

Returns

void

Inherited from

Component.addCleanup

afterRestore()

afterRestore(): void

Defined in: renderer/src/SortGroupComponent.ts:203

Re-home the subtree once parent/child links exist (save/load restore).

Returns

void

Overrides

Component.afterRestore

fixedUpdate()?

optional fixedUpdate(dt): void

Defined in: core/dist/index.d.ts:2863

Called every fixed timestep by the built-in ComponentUpdateSystem.

Parameters

dt

number

Fixed timestep in seconds, scaled by scene and entity timeScale.

Returns

void

Inherited from

Component.fixedUpdate

listen()

protected listen<T>(entity, token, handler): void

Defined in: core/dist/index.d.ts:2797

Subscribe to events on any entity, auto-unsubscribe on removal.

Type Parameters

T

T

Parameters

entity

Entity

token

EventToken<T>

handler

(data) => void

Returns

void

Inherited from

Component.listen

listenScene()

protected listenScene<T>(token, handler): void

Defined in: core/dist/index.d.ts:2803

Subscribe to scene-level events, auto-unsubscribe on removal. Handlers fire for bubbled entity events (entity = source) and scene.emit events (entity = undefined).

Type Parameters

T

T

Parameters

token

EventToken<T>

handler

(data, entity?) => void

Returns

void

Inherited from

Component.listenScene

onAdd()

onAdd(): void

Defined in: renderer/src/SortGroupComponent.ts:192

Called when the component is added to an entity. Validate dependencies here — a service, a sibling component, a render layer — and throw when one is missing. The throw is attributed to this component, recorded in Inspector.getErrors().callbackErrors, and rethrown, so it reaches the caller of entity.add() unchanged.

Returns

void

Overrides

Component.onAdd

onDestroy()

onDestroy(): void

Defined in: renderer/src/SortGroupComponent.ts:207

Called when the component is destroyed (entity destroyed or component removed).

Returns

void

Overrides

Component.onDestroy

onDisable()?

optional onDisable(): void

Defined in: core/dist/index.d.ts:2849

Called when the component stops being effectively enabled — enabled went false, the entity (or an ancestor) was deactivated, or the component is being removed or destroyed. Put live resources to sleep here; the component is reused afterwards, so do not free anything onEnable cannot rebuild.

Returns

void

Inherited from

Component.onDisable

onEnable()?

optional onEnable(): void

Defined in: core/dist/index.d.ts:2841

Called when the component becomes effectively enabled — enabled is true and the entity is active. Fires right after onAdd() for a component added to an active entity, and again on every later flip. Bring live resources back online here (unpause a sound, show a display object, re-enable a physics body). Game-state reset does not belong here: the hook sees whatever state the component held while dormant.

Returns

void

Inherited from

Component.onEnable

onRemove()?

optional onRemove(): void

Defined in: core/dist/index.d.ts:2851

Called when the component is removed from an entity.

Returns

void

Inherited from

Component.onRemove

resolveSortKey()

resolveSortKey(sort): number

Defined in: renderer/src/SortGroupComponent.ts:231

Internal

Compute this group’s depth key under the layer sort. Samples the group-owning entity’s own visual (so ySort/ySortBy read a real sprite’s position and offset); falls back to a proxy at the entity’s Transform world position when the owner renders nothing itself.

Called by DisplaySystem each Render phase.

Parameters

sort

LayerSortFn

Returns

number

serialize()

serialize(): SortGroupData

Defined in: renderer/src/SortGroupComponent.ts:284

Return a JSON-serializable snapshot of this component’s state. Used by the save system.

Returns

SortGroupData

Overrides

Component.serialize

service()

protected service<T>(key): T

Defined in: core/dist/index.d.ts:2787

Lazy proxy-based service resolution. Can be used at field-declaration time:

readonly input = this.service(InputManagerKey);

The actual resolution is deferred until first property access.

Type Parameters

T

T extends object

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.service

sibling()

protected sibling<C>(cls): C

Defined in: core/dist/index.d.ts:2795

Lazy proxy-based sibling component resolution. Can be used at field-declaration time:

readonly anim = this.sibling(AnimatedSpriteComponent);

The actual resolution is deferred until first property access.

Type Parameters

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C

Inherited from

Component.sibling

update()?

optional update(dt): void

Defined in: core/dist/index.d.ts:2858

Called every frame by the built-in ComponentUpdateSystem.

Parameters

dt

number

Frame delta in seconds, scaled by scene and entity timeScale.

Returns

void

Inherited from

Component.update

use()

protected use<T>(key): T

Defined in: core/dist/index.d.ts:2778

Resolve a service by key, cached after first lookup. Scene-scoped values (registered via scene._registerScoped) take precedence over engine scope. A key declared with scope: "scene" that falls back to engine scope emits a one-shot dev warning — almost always signals a missed beforeEnter hook.

Type Parameters

T

T

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.use

fromSnapshot()

static fromSnapshot(data): SortGroupComponent

Defined in: renderer/src/SortGroupComponent.ts:288

Parameters

data

SortGroupData

Returns

SortGroupComponent