1681-engine / index / DebugOverlayOptions

Interface: DebugOverlayOptions

Defined in: src/debug/DebugOverlay.ts:16

Properties

colliders?

optional colliders?: (draw, line) => void;

Defined in: src/debug/DebugOverlay.ts:29

Called every shown frame to draw collision boxes (and lines: turned shapes, rays).

Parameters

Parameter	Type
draw	BoxDrawer
line	LineDrawer

Returns

void

---

components?

optional components?: readonly ComponentType<unknown>[];

Defined in: src/debug/DebugOverlay.ts:25

Component types the inspector lists; none, and it lists every entity with all it holds.

---

errors?

optional errors?: number;

Defined in: src/debug/DebugOverlay.ts:31

Errors kept (default 8).

---

inspectLimit?

optional inspectLimit?: number;

Defined in: src/debug/DebugOverlay.ts:27

Entities listed at most (default 12).

---

key?

optional key?: string;

Defined in: src/debug/DebugOverlay.ts:21

KeyboardEvent.code that shows and hides it (default 'Backquote'). The key's own browser action is prevented (F3 would open the find bar, F12 the developer tools).

---

target?

optional target?: HTMLElement | Window;

Defined in: src/debug/DebugOverlay.ts:33

Where the key is listened for (default window).

---

world?

optional world?: () => World | undefined;

Defined in: src/debug/DebugOverlay.ts:23

The world to count and inspect (default the current scene's).

Returns

World | undefined