DebugRegistryImpl

Defined in: DebugRegistryImpl.ts:11

Concrete implementation of the DebugRegistry interface.

Implements

DebugRegistry

Constructors

Constructor

new DebugRegistryImpl(): DebugRegistryImpl

Returns

DebugRegistryImpl

Properties

contributors

readonly contributors: Map<string, DebugContributor>

Defined in: DebugRegistryImpl.ts:12

enabled

enabled: boolean = false

Defined in: DebugRegistryImpl.ts:15

vectors

readonly vectors: VectorDrawStore

Defined in: DebugRegistryImpl.ts:14

Backs drawVector; read by the built-in vectors contributor.

Methods

drawVector()

drawVector(entity, vector, options?): () => void

Defined in: DebugRegistryImpl.ts:26

Draw an arrow on entity for a vector that is read fresh every frame — velocity, aim direction, knockback, steering output.

// tryResolve, not use(): use() throws without DebugPlugin installed.
const debug = this.context.tryResolve(DebugRegistryKey);
this.stopArrow = debug?.drawVector(this.entity, () => agent.velocity, {
  scale: 0.35,
  color: 0x4ade80,
  minLength: 1,
});

The arrow starts at the entity’s world position (plus options.origin) and points along the vector. Nothing is retained but the provider itself: it is called once per frame while the overlay is on and the vectors contributor’s arrows flag is enabled, and not at all otherwise — a drawVector call in a hot path costs nothing while debug is off.

Returns a disposer that stops the drawing. Calling it twice is harmless. The registration is also dropped when the entity’s life ends — destroyed, or a pool member whose lease ended — so a provider closure never outlives the entity it draws for, and a per-lease registration never accumulates.