Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: DevPane

[19:7] extends: FxObj

Wraps FXGL's DevPane (com.almasb.fxgl.dev.DevPane), the slide-out developer overlay built and managed by DevService. Renders a scrollable accordion of developer-visible settings (every devXxx property on ReadOnlyGameSettings), a transparent debug-message strip, and helpers for adding visual debug points anchored at world coordinates. Aussom users hold a DevPane wrapper via adopt; direct construction is unusual because DevPane is built by DevService.onInit.

Methods

  • DevPane (SceneServiceObj = null, SettingsObj = null)

    Creates a new DevPane. Pass null for SceneServiceObj to construct an empty wrapper for adopt; otherwise wires a fresh DevPane on the supplied SceneService and ReadOnlyGameSettings.

    • @p SceneServiceObj is an AussomJavaObject around a SceneService, or null.
    • @p SettingsObj is an AussomJavaObject around a ReadOnlyGameSettings.
  • adopt (object Ajo)

    Wraps an existing DevPane AussomJavaObject.

    • @p Ajo is an AussomJavaObject around a DevPane.
    • @r A new wrapper.
  • isOpen ()

    Returns true while the pane's InGamePanel is open.

    • @r A bool.
  • open ()

    Opens the dev pane.

    • @r this object
  • close ()

    Closes the dev pane.

    • @r this object
  • pushMessage (string Message)

    Pushes a transient debug message onto the message strip.

    • @p Message is the message text.
    • @r this object
  • addDebugPoint (double X, double Y)

    Adds a debug point view at the given world location.

    • @p X is the X coordinate.
    • @p Y is the Y coordinate.
    • @r this object
  • removeDebugPoint (double X, double Y)

    Removes the debug point view at the given location.

    • @p X is the X coordinate.
    • @p Y is the Y coordinate.
    • @r this object
  • onGameReady (object VarsObj)

    Hook called by DevService when the game is ready (the world property map is populated). Exposed for adoption flows that drive the pane manually.

    • @p VarsObj is an AussomJavaObject around a PropertyMap.
    • @r this object