Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: VirtualMenuKey

[20:7] extends: FxObj

Wraps an AussomVirtualMenuKey (subclass of FXGL's abstract VirtualMenuKey) so Aussom code can build a custom on-screen menu / pause button. Register the onCreateView callback to supply the JavaFX Node wrapper; FXGL wires the press so that the configured KeyCode is mocked. Example: vm = new VirtualMenuKey(fxgl.getInput(), "ESCAPE", true); vm.onCreateView(::buildMenuButton);

Methods

  • VirtualMenuKey (InputAjo, string KeyName = "ESCAPE", bool IsMenuEnabled = true)

    Creates a new VirtualMenuKey bridge.

    • @p InputAjo is an Input wrapper or AussomJavaObject.
    • @p KeyName is the javafx.scene.input.KeyCode enum name (e.g. "ESCAPE") to mock on press.
    • @p IsMenuEnabled chooses mockKeyPressEvent (true, fires menu hooks) versus mockKeyPress (false).
  • adopt (object Ajo)

    Wraps an existing AussomVirtualMenuKey AussomJavaObject.

  • onCreateView (callback Cb)

    Registers the createView callback. The callback takes no arguments and must return a JavaFX Node wrapper.

    • @p Cb is a callback () -> Node.
    • @r this object