In-game tools

Interfaces

Command

Every change to the world, as an object that can be undone.

ConsoleView

ConsoleWorld

EntityWorldLike

The five methods the adapter forwards to. World has all of them.

FrameHistory

A fixed window of frame times, oldest first.

InspectableComponentType

The shape of a component type, as this package needs it.

InspectableWorld

What the inspector needs of a world.

InspectorRow

InspectorView

InspectorWorld

LogEntry

LogFilter

LogRing

A fixed window of entries. Pooled, because a log is appended to forever.

NetworkReadout

What the panel needs of a session.

NetworkView

NetworkWorld

OverlayPainter

What a host draws with. Colours are CSS, #rrggbb or #rrggbbaa.

OverlaySite

Where one panel came out. Read rather than recomputed, so a hit test cannot disagree with a draw.

Panel

PanelBinding

A panel with its world and its view already attached.

ProfilerRow

ProfilerView

ProfilerWorld

RollbackHistory

A fixed window of how deep each recent frame rewound.

Selection

What is selected, which of it is primary, and in what order.

SessionRecorder

What a recorder keeps: the disagreements it has seen, oldest first.

SourceCursor

Where a caller is looking. The console asks to move it; the caller owns it.

ToolsOverlay

ToolsOverlayOptions

UndoStack

Functions

addComponentCommand

addToSelection

appendLog

Append, collapsing an exact repeat of the newest entry into its count.

bindPanel

clearSelection

componentDivergence

Which components two peers hash differently, in the order they are first seen.

createConsoleView

createFrameHistory

createGpuPassTimings

A PassTimings labelled with the engine's own GPU brackets.

createInspectorView

createLogFilter

createLogRing

createNetworkView

createPanelRoot

The node a panel builds into.

createProfilerView

createRollbackHistory

createSelection

createSessionRecorder

createToolsOverlay

createUndoStack

displayText

divergenceIsUnaccounted

Whether the difference is in something nobody hashed.

divergentComponents

Which components two sides hash differently, into out. Returns how many.

emptyPanel

Replace a panel's contents with one line saying why there is nothing.

entitiesInspectable

An entity world, as something the inspector can read and edit.

fieldEditable

filteredEntries

formatMs

— for unmeasured. Two decimals, because a pass under a hundredth is not the one to look at.

historyValues

The window, oldest first. Allocates, so it is for a reader rather than for a frame.

inspectorRows

The rows for a selection: the components every selected entity has, field by field.

isSelected

jumpToSourceCommand

Ask to look at a place in a file.

keyEvent

logEntries

The window, oldest first.

observeSession

Watch a session for one frame.

occupancy

How full the page cache is, or null where there is no cache to be full.

paintOverlay

Draw the overlay, or draw nothing because it is closed.

panelIdOf

Which panel a node is the root of, or null.

pointerEvent

primarySelection

The most recently added, which is what an inspector shows and what a gizmo pivots on.

profilerRows

One row per labelled pass, oldest index first, written into out.

pushFrame

pushRollback

recordGpuSample

Write one resolved sample over the three rows.

removeComponentCommand

Remove a component, keeping its values so undo can put them back.

rollbackValues

rowText

What a row shows to the right of its label. — is the mark for a disagreement.

selectedEntities

selectOnly

selectRange

Select everything between two entities in a caller-supplied order.

sessionReadout

The session and what has been seen of it, as the panel's readout.

setFieldCommand

Write one row's fields across the whole selection, as one entry.

toggleSelection

treeShape

A tree as a comparable string: structure, text, geometry and name, but never identity.

wheelEvent

Types

RowKind

A vector row is three number fields; anything else is one field.

SessionLike

A session as the network panel reads it, which a LockstepSession is as it stands.

Severity

UiEvent

What a panel is asked to deal with.

Constants

consolePanel

DISPLAY_LIMIT

How much of one entry a row shows. Past this the rest is still on the entry.

inspectorPanel

MIXED

What a row's value is when the selected entities disagree about it.

networkPanel

PANEL_PREFIX

The prefix a panel root's name carries, so the dock can recognise one.

PANEL_TITLE_HEIGHT

How tall the title row above every panel is, in the overlay's pixels. A panel's own space starts below it, so a host hit-testing a site by hand reads the content from site.y plus this.

profilerPanel