com.almasb.fxgl.settings

Class GameSettings

java.lang.Object

com.almasb.fxgl.settings.ReadOnlyGameSettings

com.almasb.fxgl.settings.GameSettings

public final class GameSettings
extends ReadOnlyGameSettings

Data structure for variables that are initialised before the application (game) starts.

Modifying any data after the start of the game has no effect.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Field Summary

Fields inherited from class com.almasb.fxgl.settings.ReadOnlyGameSettings

appMode, closeConfirmation, credits, dialogFactory, enabledMenuItems, exceptionHandler, fullScreenAllowed, height, introEnabled, manualResizeEnabled, menuEnabled, menuKey, notificationViewClass, profilingEnabled, sceneFactory, singleStep, stageStyle, title, uiFactory, version, width

Constructor Summary

Constructors

Constructor and Description
GameSettings()

Method Summary

Modifier and Type	Method and Description
void	setApplicationMode(ApplicationMode mode) Sets application run mode.
void	setCloseConfirmation(boolean b) Setting to false will disable asking for confirmation on exit.
void	setCredits(Credits credits) Set additional credits.
void	setDialogFactory(DialogFactory dialogFactory) Provide a custom dialog factory.
void	setEnabledMenuItems(EnumSet<MenuItem> items)
void	setExceptionHandler(ExceptionHandler exceptionHandler) Provide a custom exception handler.
void	setFullScreenAllowed(boolean b) Setting to true will allow the game to be able to enter full screen from the menu.
void	setHeight(int height) Set target height.
void	setIntroEnabled(boolean b) If set to true, the intro video/animation will be played before the start of the game.
void	setManualResizeEnabled(boolean enabled) If enabled, users can drag the corner of the main window to resize it and the game.
void	setMenuEnabled(boolean b) Setting to true enables main and game menu.
void	setMenuKey(javafx.scene.input.KeyCode menuKey) Set the key that will trigger in-game menu.
void	setNotificationViewFactory(Class<? extends NotificationView> notificationViewFactory) Provide a custom notification service.
void	setProfilingEnabled(boolean b) Setting to true will enable profiler that reports on performance when FXGL exits.
void	setSceneFactory(SceneFactory sceneFactory) Provide a custom scene factory.
void	setSingleStep(boolean b)
void	setStageStyle(javafx.stage.StageStyle stageStyle)
void	setTitle(String title) Set title of the game.
void	setUIFactory(UIFactory uiFactory) Provide a custom UI factory.
void	setVersion(String version) Set version of the game.
void	setWidth(int width) Set target width.
ReadOnlyGameSettings	toReadOnly()

Methods inherited from class com.almasb.fxgl.settings.ReadOnlyGameSettings

getApplicationMode, getCredits, getDialogFactory, getEnabledMenuItems, getExceptionHandler, getHeight, getMenuKey, getNotificationViewFactory, getSceneFactory, getStageStyle, getTitle, getUIFactory, getVersion, getWidth, isCloseConfirmation, isFullScreenAllowed, isIntroEnabled, isManualResizeEnabled, isMenuEnabled, isProfilingEnabled, isSingleStep, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GameSettings

public GameSettings()

Method Detail

setTitle

public void setTitle(String title)

Set title of the game. This will be shown as the window header if the game isn't fullscreen.

Parameters:

title - app title

Default Value:

"Untitled FXGL Game Application"

setWidth

public void setWidth(int width)

Set target width. If the screen width is smaller, the game will automatically scale down the image while maintaining the aspect ratio.

All the game logic must use target width and height.

Parameters:

width - target width

Default Value:

800

setHeight

public void setHeight(int height)

Set target height. If the screen height is smaller, the game will automatically scale down the image while maintaining the aspect ratio.

All the game logic must use target width and height.

Parameters:

height - target height

Default Value:

600

setVersion

public void setVersion(String version)

Set version of the game.

Parameters:

version - app version

Default Value:

0.0

setIntroEnabled

public void setIntroEnabled(boolean b)

If set to true, the intro video/animation will be played before the start of the game.

Parameters:

b - intro flag

Default Value:

true

setMenuEnabled

public void setMenuEnabled(boolean b)

Setting to true enables main and game menu.

Parameters:

b - menu flag

Default Value:

true

setFullScreenAllowed

public void setFullScreenAllowed(boolean b)

Setting to true will allow the game to be able to enter full screen from the menu.

Parameters:

b - fullscreen flag

Default Value:

false

setProfilingEnabled

public void setProfilingEnabled(boolean b)

Setting to true will enable profiler that reports on performance when FXGL exits. Also shows render and performance FPS in the bottom left corner when the application is run.

Parameters:

b - profiling enabled flag

Default Value:

true

setCloseConfirmation

public void setCloseConfirmation(boolean b)

Setting to false will disable asking for confirmation on exit. This is useful for faster compile -> run -> exit.

Parameters:

b - ask for confirmation on close

Default Value:

true

setSingleStep

public void setSingleStep(boolean b)

setApplicationMode

public void setApplicationMode(ApplicationMode mode)

Sets application run mode. See ApplicationMode for more info.

Parameters:

mode - app mode

Default Value:

ApplicationMode#DEVELOPER

setMenuKey

public void setMenuKey(javafx.scene.input.KeyCode menuKey)

Set the key that will trigger in-game menu.

Parameters:

menuKey - menu key

setCredits

public void setCredits(Credits credits)

Set additional credits.

Parameters:

credits - credits object

setEnabledMenuItems

public void setEnabledMenuItems(EnumSet<MenuItem> items)

setManualResizeEnabled

public void setManualResizeEnabled(boolean enabled)

If enabled, users can drag the corner of the main window to resize it and the game.

Default Value:

false

setStageStyle

public void setStageStyle(javafx.stage.StageStyle stageStyle)

setSceneFactory

public void setSceneFactory(SceneFactory sceneFactory)

Provide a custom scene factory.

setDialogFactory

public void setDialogFactory(DialogFactory dialogFactory)

Provide a custom dialog factory.

setUIFactory

public void setUIFactory(UIFactory uiFactory)

Provide a custom UI factory.

setNotificationViewFactory

public void setNotificationViewFactory(Class<? extends NotificationView> notificationViewFactory)

Provide a custom notification service.

setExceptionHandler

public void setExceptionHandler(ExceptionHandler exceptionHandler)

Provide a custom exception handler.

toReadOnly

public ReadOnlyGameSettings toReadOnly()

Returns:

a read only copy of settings