Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: FXGLMenu

[31:7] extends: FxglSubScene

Wraps FXGL's abstract FXGLMenu (com.almasb.fxgl.app.scene.FXGLMenu), the SubScene base every built-in and custom menu extends. FXGLMenu adds engine-aware shortcuts on top of SubScene (fireNewGame, fireResume, fireLoad, fireSave, fireDelete, fireExit, fireExitToMainMenu) that any subclass uses to drive game flow. Those fire* shortcuts are protected in FXGL, so they are reachable only from a Java subclass, not from an adopted wrapper; they are not part of the externally callable API. Menu content is built through the inherited Scene surface: getContentRoot returns the menu's content Pane, and addChild / removeChild attach and detach JavaFX nodes such as a VBox of buttons. This mirrors FXGL, where those methods live on com.almasb.fxgl.scene.Scene rather than on FXGLMenu itself. Direct construction from Aussom is not supported because the class is abstract; pick FXGLDefaultMenu or SimpleGameMenu for concrete instances or override the menu factories on a SceneFactory. Aussom users hold an FXGLMenu wrapper via adopt after obtaining one from the engine.

Methods

  • FXGLMenu ()

    Empty default constructor; populated by adopt.

  • adopt (object Ajo)

    Wraps an existing FXGLMenu AussomJavaObject.

    • @p Ajo is an AussomJavaObject around an FXGLMenu.
    • @r A new wrapper.