DocumentationReference
Deprecation Timeline
Central tracker for public API compatibility aliases and planned removals.
Use this file as the single source of truth when pruning old names.
2026-05-31 - compatibility aliases added
These aliases were introduced to preserve backward compatibility after the API naming refactor.
BT namespace
Removal target: 2.0.0
BT.pointerPosValid()→BT.isPointerActive()BT.buttonDown()→BT.isDown()BT.buttonPressed()→BT.isPressed()BT.buttonReleased()→BT.isReleased()BT.gamepadConnected()→BT.isGamepadConnected()BT.keyDown()→BT.isKeyDown()BT.keyPressed()→BT.isKeyPressed()BT.keyReleased()→BT.isKeyReleased()
HardwareSettings compatibility fields
Removal target: 2.0.0
detectDroppedFrames→isDetectingDroppedFramesoverlayEnabled→isOverlayEnabledoverlayVisibleAtStart→isOverlayVisibleAtStartoverlayToggleHintVisible→isOverlayToggleHintVisibleoverlayToggleEnabled→isOverlayToggleEnabledoverlayPaletteView→isOverlayPaletteEnabledoverlayTimingChart→isOverlayTimingChartEnabledoverlayRendererDiagnosticsBar→isOverlayRendererDiagnosticsBarEnabled
BootstrapOptions compatibility fields
Removal target: 2.0.0
canvasId→canvasIDcontainerId→containerIDwaitForDOMReady→isWaitingForDOMReady
Class method aliases
Removal target: 2.0.0
SpriteSheet.isIndexized()→SpriteSheet.isIndexed()Rect2i.containsXY()→Rect2i.isContainingXY()Rect2i.intersectionTo()→Rect2i.intersectTo()Timer.tick()→Timer.fireIfElapsed()Vector2i.equals()→Vector2i.isEqual()Rect2i.equals()→Rect2i.isEqual()Color32.equals()→Color32.isEqual()Rect2i.contains()→Rect2i.isContaining()Rect2i.intersects()→Rect2i.isIntersecting()
Removal checklist
- Search for
@deprecated Deprecated sinceinsrc/(every public alias uses that versioned form). - Remove aliases only after confirming downstream demos/apps have migrated.
Public aliases only
This tracker lists public compatibility aliases only. Internal deprecated helpers that used to live beside overlay
layout functions and RenderPaletteUsage re-exports were removed rather than carried forward - search @deprecated in
src/ for anything that remains outside this list.
See also
API: Core
Current BT getters and HardwareSettings fields.
Input Guide
Current input API names.
Overlay Guide
Current overlay configure flags.
Developer Experience
Boolean naming and migration policy.
Last updated on September 9, 2026