Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: DevService

[19:7] extends: EngineService

Wraps FXGL's DevService (com.almasb.fxgl.dev.DevService), the EngineService that drives the developer overlays (Dev Console, Dev Pane, debug messages, bounding-box rendering). Every public method is a no-op when the application runs in RELEASE mode or GameSettings.isDeveloperMenuEnabled is false. Reached at runtime via fxgl.getDevService; obtain a wrapper via adopt.

Methods

  • DevService (Ajo = null)

    Creates a DevService wrapper. Empty by default; the (Ajo) form wraps an existing instance from fxgl.getDevService.

    • @p Ajo is an optional AussomJavaObject around a DevService.
  • adopt (object Ajo)

    Wraps an existing DevService AussomJavaObject.

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

    Returns true while the Dev Console is open.

    • @r A bool.
  • isDevPaneOpen ()

    Returns true while the Dev Pane is open.

    • @r A bool.
  • openConsole ()

    Opens the Dev Console.

    • @r this object
  • closeConsole ()

    Closes the Dev Console.

    • @r this object
  • openDevPane ()

    Opens the Dev Pane.

    • @r this object
  • closeDevPane ()

    Closes the Dev Pane.

    • @r this object
  • pushDebugMessage (string Message)

    Pushes a transient debug message onto the Dev Pane's message strip (removed after 5 seconds).

    • @p Message is the message text.
    • @r this object