Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: EmbeddedPaneWindow

[21:7] extends: FxObj

Wraps FXGL's EmbeddedPaneWindow (com.almasb.fxgl.app.EmbeddedPaneWindow), the MainWindow subclass FXGL uses when the game runs inside an embedding FXGLPane rather than its own top-level Stage. Holds the pane, the FXGLScene, and the runtime settings that drive scaling and input-focus behavior. Construct with an FXGLPane (the host pane), an FXGLScene (the initial scene), and the runtime ReadOnlyGameSettings the engine is using. Typically obtained from the engine; direct construction is for advanced embedding code.

Methods

  • EmbeddedPaneWindow (object PaneObj = null, object SceneAjo = null, object SettingsAjo = null)

    Creates a new EmbeddedPaneWindow.

    • @p PaneObj is an FXGLPane wrapper or raw AJO.
    • @p SceneAjo is an FXGLScene AJO.
    • @p SettingsAjo is a ReadOnlyGameSettings AJO.
  • adopt (object Ajo)

    Wraps an existing EmbeddedPaneWindow AussomJavaObject.

  • getFxglPane ()

    Returns the host FXGLPane wrapper.

  • getStage ()

    Returns the JavaFX Stage hosting this embedded window.

  • getX ()

    Returns the window's screen-x position.

  • getY ()

    Returns the window's screen-y position.

  • isFocused ()

    Returns true when the host stage currently has focus.

  • getWidth ()

    Returns the host stage width.

  • getHeight ()

    Returns the host stage height.

  • iconifiedProperty ()

    Returns the iconified ReadOnlyBooleanProperty for binding.

  • addCSS (list CssList)

    Adds one or more CSS sheets to the embedded scene. Pass an Aussom list of CSS wrappers or raw CSS AJOs.

  • show ()

    Shows the embedded window (binds the pane to the engine).

  • close ()

    Closes the embedded window.

  • takeScreenshot ()

    Returns a JavaFX Image AJO containing a screenshot of the current frame.