com.almasb.fxgl.scene

Class FXGLMenu

java.lang.Object

com.almasb.fxgl.scene.FXGLScene

com.almasb.fxgl.scene.FXGLMenu

Direct Known Subclasses:

FXGLDefaultMenu

public abstract class FXGLMenu
extends FXGLScene

This is a base class for main/game menus. It provides several convenience methods for those who just want to extend an existing menu. It also allows for implementors to build menus from scratch. Freshly build menus can interact with FXGL by calling fire* methods. Both main and game menus should have the following items:

• Background
• Title
• Version
• Profile name
• Menu Body
• Menu Content

However, in reality a menu can contain anything.

Author:

Almas Baimagambetov (AlmasB) ([email protected])

Property Summary

Properties inherited from class com.almasb.fxgl.scene.FXGLScene

activeProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	FXGLMenu.MenuContent A generic vertical box container for menu content where each element is followed by a separator.

Field Summary

Fields

Modifier and Type	Field and Description
protected GameApplication	app
protected javafx.scene.layout.Pane	contentRoot
protected FXGLMenu.MenuContent	EMPTY
protected MenuEventHandler	listener
protected static Logger	log
protected javafx.scene.layout.Pane	menuRoot
protected MenuType	type

Constructor Summary

Constructors

Constructor and Description
FXGLMenu(GameApplication app, MenuType type)

Method Summary

Modifier and Type	Method and Description
protected void	addUINode(javafx.scene.Node node) Adds a UI node.
protected abstract javafx.scene.control.Button	createActionButton(javafx.beans.binding.StringBinding name, Runnable action)
protected abstract javafx.scene.control.Button	createActionButton(String name, Runnable action)
protected abstract javafx.scene.Node	createBackground(double width, double height) Create menu background.
protected FXGLMenu.MenuContent	createContentAchievements()
protected FXGLMenu.MenuContent	createContentAudio()
protected javafx.scene.control.Button	createContentButton(javafx.beans.binding.StringBinding name, Supplier<FXGLMenu.MenuContent> contentSupplier)
protected javafx.scene.control.Button	createContentButton(String name, Supplier<FXGLMenu.MenuContent> contentSupplier)
protected FXGLMenu.MenuContent	createContentControls()
protected FXGLMenu.MenuContent	createContentCredits()
protected FXGLMenu.MenuContent	createContentFeedback()
protected FXGLMenu.MenuContent	createContentGameplay()
protected FXGLMenu.MenuContent	createContentLoad()
protected FXGLMenu.MenuContent	createContentVideo() https://github.com/AlmasB/FXGL/issues/493
protected abstract javafx.scene.Node	createProfileView(String profileName) Create view for profile name.
protected abstract javafx.scene.Node	createTitleView(String title) Create view for the app title.
protected abstract javafx.scene.Node	createVersionView(String version) Create view for version string.
protected void	fireContinue() Loads the game state from last modified save file.
protected void	fireDelete(SaveFile fileName)
protected void	fireExit() App will clean up the world/the scene and exit.
protected void	fireExitToMainMenu() App will clean up the world/the scene and enter main menu.
protected void	fireLoad(SaveFile fileName) Loads the game state from previously saved file.
protected void	fireLogout() Can only be fired from main menu.
protected void	fireMultiplayer() Call multiplayer access in main menu.
protected void	fireNewGame() Can only be fired from main menu.
protected void	fireResume() Can only be fired from game menu.
protected void	fireSave() Can only be fired from game menu.
protected void	switchMenuContentTo(javafx.scene.Node content) Switches current active content to given.
protected void	switchMenuTo(javafx.scene.Node menuBox) Switches current active menu body to given.

Methods inherited from class com.almasb.fxgl.scene.FXGLScene

activeProperty, appendCSS, bindSize, clearCSS, clearEffect, getContentRoot, getEffect, getHeight, getRoot, getViewport, getWidth, setBackgroundColor, setBackgroundRepeat, setBackgroundRepeat, setCursor, setEffect

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static final Logger log

app

protected final GameApplication app

type

protected final MenuType type

listener

protected MenuEventHandler listener

menuRoot

protected final javafx.scene.layout.Pane menuRoot

contentRoot

protected final javafx.scene.layout.Pane contentRoot

EMPTY

protected final FXGLMenu.MenuContent EMPTY

Constructor Detail

FXGLMenu

public FXGLMenu(GameApplication app,
                MenuType type)

Method Detail

switchMenuTo

protected void switchMenuTo(javafx.scene.Node menuBox)

Switches current active menu body to given.

Parameters:

menuBox - parent node containing menu body

switchMenuContentTo

protected void switchMenuContentTo(javafx.scene.Node content)

Switches current active content to given.

Parameters:

content - menu content

createActionButton

protected abstract javafx.scene.control.Button createActionButton(String name,
                                                                  Runnable action)

createActionButton

protected abstract javafx.scene.control.Button createActionButton(javafx.beans.binding.StringBinding name,
                                                                  Runnable action)

createContentButton

protected javafx.scene.control.Button createContentButton(String name,
                                                          Supplier<FXGLMenu.MenuContent> contentSupplier)

createContentButton

protected javafx.scene.control.Button createContentButton(javafx.beans.binding.StringBinding name,
                                                          Supplier<FXGLMenu.MenuContent> contentSupplier)

createBackground

protected abstract javafx.scene.Node createBackground(double width,
                                                      double height)

Create menu background.

Parameters:

width - width of the app

height - height of the app

Returns:

menu background UI object

createTitleView

protected abstract javafx.scene.Node createTitleView(String title)

Create view for the app title.

Parameters:

title - app title

Returns:

UI object

createVersionView

protected abstract javafx.scene.Node createVersionView(String version)

Create view for version string.

Parameters:

version - version string

Returns:

UI object

createProfileView

protected abstract javafx.scene.Node createProfileView(String profileName)

Create view for profile name.

Parameters:

profileName - profile user name

Returns:

UI object

createContentLoad

protected final FXGLMenu.MenuContent createContentLoad()

Returns:

menu content containing list of save files and loadTask/delete buttons

createContentGameplay

protected final FXGLMenu.MenuContent createContentGameplay()

Returns:

menu content with difficulty and playtime

createContentControls

protected final FXGLMenu.MenuContent createContentControls()

Returns:

menu content containing input mappings (action -> key/mouse)

createContentVideo

protected final FXGLMenu.MenuContent createContentVideo()

https://github.com/AlmasB/FXGL/issues/493

Returns:

menu content with video settings

createContentAudio

protected final FXGLMenu.MenuContent createContentAudio()

Returns:

menu content containing music and sound volume sliders

createContentCredits

protected final FXGLMenu.MenuContent createContentCredits()

Returns:

menu content containing a list of credits

createContentFeedback

protected final FXGLMenu.MenuContent createContentFeedback()

Returns:

menu content containing feedback options

createContentAchievements

protected final FXGLMenu.MenuContent createContentAchievements()

Returns:

menu content containing a list of achievements

addUINode

protected final void addUINode(javafx.scene.Node node)

Adds a UI node.

Parameters:

node - the node to add

fireNewGame

protected final void fireNewGame()

Can only be fired from main menu. Starts new game.

fireContinue

protected final void fireContinue()

Loads the game state from last modified save file.

fireLoad

protected final void fireLoad(SaveFile fileName)

Loads the game state from previously saved file.

Parameters:

fileName - name of the saved file

fireSave

protected final void fireSave()

Can only be fired from game menu. Saves current state of the game with given file name.

fireDelete

protected final void fireDelete(SaveFile fileName)

Parameters:

fileName - name of the save file

fireResume

protected final void fireResume()

Can only be fired from game menu. Will close the menu and unpause the game.

fireLogout

protected final void fireLogout()

Can only be fired from main menu. Logs out the user profile.

fireMultiplayer

protected final void fireMultiplayer()

Call multiplayer access in main menu. Currently not supported.

fireExit

protected final void fireExit()

App will clean up the world/the scene and exit.

fireExitToMainMenu

protected final void fireExitToMainMenu()

App will clean up the world/the scene and enter main menu.