com.almasb.fxgl.app

Class FXGLApplication

java.lang.Object

javafx.application.Application

com.almasb.fxgl.app.FXGLApplication

Direct Known Subclasses:

GameApplication

public abstract class FXGLApplication
extends javafx.application.Application

General FXGL application that configures services, settings and properties to be used by the framework.

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from class javafx.application.Application

javafx.application.Application.Parameters

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	log Use system logger fallback until actual logger is ready.

Fields inherited from class javafx.application.Application

STYLESHEET_CASPIAN, STYLESHEET_MODENA

Constructor Summary

Constructors

Constructor and Description
FXGLApplication()

Method Summary

Modifier and Type	Method and Description
void	addFXGLListener(FXGLListener listener) Add listener for core FXGL callbacks.
protected void	exit() Exit the application.
AchievementManager	getAchievementManager()
javafx.geometry.Rectangle2D	getAppBounds()
AssetLoader	getAssetLoader()
AudioPlayer	getAudioPlayer()
Display	getDisplay()
EventBus	getEventBus()
ExceptionHandler	getExceptionHandler()
Executor	getExecutor()
int	getHeight()
Input	getInput()
MasterTimer	getMasterTimer()
Net	getNet()
NotificationService	getNotificationService()
long	getNow()
javafx.stage.Stage	getPrimaryStage()
QTE	getQTE()
QuestService	getQuestService()
ReadOnlyGameSettings	getSettings()
long	getTick()
UIFactory	getUIFactory()
int	getWidth()
void	init()
protected abstract void	initSettings(GameSettings settings) Initialize app settings.
protected void	pause() Pause the application.
void	removeFXGLListener(FXGLListener listener) Remove previously added listener.
protected void	reset() Reset the application.
protected void	resume() Resume the application.
void	start(javafx.stage.Stage primaryStage)
void	stop()

Methods inherited from class javafx.application.Application

getHostServices, getParameters, getUserAgentStylesheet, launch, launch, notifyPreloader, setUserAgentStylesheet

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static Logger log

Use system logger fallback until actual logger is ready.

Constructor Detail

FXGLApplication

public FXGLApplication()

Method Detail

getPrimaryStage

public final javafx.stage.Stage getPrimaryStage()

Returns:

primary stage as set by JavaFX

getSettings

public final ReadOnlyGameSettings getSettings()

Returns:

read only copy of game settings

addFXGLListener

public final void addFXGLListener(FXGLListener listener)

Add listener for core FXGL callbacks.

Parameters:

listener - the listener

removeFXGLListener

public final void removeFXGLListener(FXGLListener listener)

Remove previously added listener.

Parameters:

listener - the listener

init

public final void init()
                throws Exception

Overrides:

init in class javafx.application.Application

Throws:

Exception

start

public final void start(javafx.stage.Stage primaryStage)
                 throws Exception

Specified by:

start in class javafx.application.Application

Throws:

Exception

stop

public final void stop()

Overrides:

stop in class javafx.application.Application

pause

protected final void pause()

Pause the application.

resume

protected final void resume()

Resume the application.

reset

protected final void reset()

Reset the application. After notifying all interested parties (where all should do a cleanup), System.gc() will be called.

exit

protected final void exit()

Exit the application. Safe to call this from a paused state.

initSettings

protected abstract void initSettings(GameSettings settings)

Initialize app settings.

Parameters:

settings - app settings

getWidth

public final int getWidth()

Returns:

target width as set by GameSettings

getHeight

public final int getHeight()

Returns:

target height as set by GameSettings

getAppBounds

public final javafx.geometry.Rectangle2D getAppBounds()

Returns:

app bounds as set by GameSettings

getTick

public final long getTick()

Returns:

current tick (frame)

getNow

public final long getNow()

Returns:

current time since start of game in nanoseconds

getEventBus

public final EventBus getEventBus()

getDisplay

public final Display getDisplay()

getInput

public final Input getInput()

getAudioPlayer

public final AudioPlayer getAudioPlayer()

getAssetLoader

public final AssetLoader getAssetLoader()

getMasterTimer

public final MasterTimer getMasterTimer()

getExecutor

public final Executor getExecutor()

getNotificationService

public final NotificationService getNotificationService()

getAchievementManager

public final AchievementManager getAchievementManager()

getQTE

public final QTE getQTE()

getNet

public final Net getNet()

getExceptionHandler

public final ExceptionHandler getExceptionHandler()

getUIFactory

public final UIFactory getUIFactory()

getQuestService

public final QuestService getQuestService()