FXGLApplication (com.github.almasb:fxgl 0.2.9 API)

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 for all parts to use.

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 inherited from class javafx.application.Application
  STYLESHEET_CASPIAN, STYLESHEET_MODENA

Constructor Summary

Constructors
Constructor and Description

FXGLApplication()

Constructors
Constructor and Description
`FXGLApplication()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFXGLListener(FXGLListener listener)` Add listener for core FXGL callbacks.
`protected void`	`exit()` Exit the application.
`AchievementManager`	`getAchievementManager()`
`AssetLoader`	`getAssetLoader()`
`AudioPlayer`	`getAudioPlayer()`
`Display`	`getDisplay()`
`EventBus`	`getEventBus()`
`ExceptionHandler`	`getExceptionHandler()`
`Executor`	`getExecutor()`
`double`	`getHeight()` Returns target height of the application.
`Input`	`getInput()`
`MasterTimer`	`getMasterTimer()`
`Net`	`getNet()`
`NotificationService`	`getNotificationService()`
`long`	`getNow()`
`javafx.stage.Stage`	`getPrimaryStage()`
`QTE`	`getQTE()`
`QuestManager`	`getQuestManager()`
`javafx.geometry.Rectangle2D`	`getScreenBounds()` Returns the visual area within the application window, excluding window borders.
`ReadOnlyGameSettings`	`getSettings()`
`long`	`getTick()`
`UIFactory`	`getUIFactory()`
`double`	`getWidth()` Returns target width of the application.
`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

- Constructor Detail
  - FXGLApplication
```
public FXGLApplication()
```
- Method Detail
  - getPrimaryStage
```
public 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 void addFXGLListener(FXGLListener listener)
```
    Add listener for core FXGL callbacks.
    
    Parameters:
    
    listener - the listener
  - removeFXGLListener
```
public 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 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 void pause()
```
    Pause the application.
  - resume
```
protected void resume()
```
    Resume the application.
  - reset
```
protected void reset()
```
    Reset the application. After notifying all interested parties (where all should do a cleanup), System.gc() will be called.
  - exit
```
protected 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 double getWidth()
```
    Returns target width of the application. This is the width that was set using GameSettings. Note that the resulting width of the scene might be different due to end user screen, in which case transformations will be automatically scaled down to ensure identical image on all screens.
    
    Returns:
    
    target width
  - getHeight
```
public final double getHeight()
```
    Returns target height of the application. This is the height that was set using GameSettings. Note that the resulting height of the scene might be different due to end user screen, in which case transformations will be automatically scaled down to ensure identical image on all screens.
    
    Returns:
    
    target height
  - getScreenBounds
```
public final javafx.geometry.Rectangle2D getScreenBounds()
```
    Returns the visual area within the application window, excluding window borders. Note that it will return the rectangle with set target width and height, not actual screen width and height. Meaning on smaller screens the area will correctly return the GameSettings' width and height.
    Equivalent to new Rectangle2D(0, 0, getWidth(), getHeight()).
    
    Returns:
    
    screen bounds
  - getTick
```
public final long getTick()
```
    Returns:
    
    current tick
  - getNow
```
public final long getNow()
```
    Returns:
    
    current time since start of game in nanoseconds
  - getEventBus
```
public final EventBus getEventBus()
```
    Returns:
    
    event bus
  - getDisplay
```
public final Display getDisplay()
```
    Returns:
    
    display service
  - getInput
```
public final Input getInput()
```
    Returns:
    
    input service
  - getAudioPlayer
```
public final AudioPlayer getAudioPlayer()
```
    Returns:
    
    audio player
  - getAssetLoader
```
public final AssetLoader getAssetLoader()
```
    Returns:
    
    asset loader
  - getMasterTimer
```
public final MasterTimer getMasterTimer()
```
    Returns:
    
    master timer
  - getExecutor
```
public final Executor getExecutor()
```
    Returns:
    
    executor service
  - getNotificationService
```
public final NotificationService getNotificationService()
```
    Returns:
    
    notification service
  - getAchievementManager
```
public final AchievementManager getAchievementManager()
```
    Returns:
    
    achievement manager
  - getQTE
```
public final QTE getQTE()
```
    Returns:
    
    QTE service
  - getNet
```
public final Net getNet()
```
    Returns:
    
    net service
  - getExceptionHandler
```
public final ExceptionHandler getExceptionHandler()
```
    Returns:
    
    exception handler service
  - getUIFactory
```
public final UIFactory getUIFactory()
```
    Returns:
    
    UI factory service
  - getQuestManager
```
public final QuestManager getQuestManager()
```
    Returns:
    
    quest manager

Class FXGLApplication

Nested Class Summary

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

Field Summary

Fields inherited from class javafx.application.Application

Constructor Summary

Method Summary

Methods inherited from class javafx.application.Application

Methods inherited from class java.lang.Object

Constructor Detail

FXGLApplication

Method Detail

getPrimaryStage

getSettings

addFXGLListener

removeFXGLListener

init

start

stop

pause

resume

reset

exit

initSettings

getWidth

getHeight

getScreenBounds

getTick

getNow

getEventBus

getDisplay

getInput

getAudioPlayer

getAssetLoader

getMasterTimer

getExecutor

getNotificationService

getAchievementManager

getQTE

getNet

getExceptionHandler

getUIFactory

getQuestManager