GameApplication (fxgl 0.3.4 API)

java.lang.Object
- javafx.application.Application
- - com.almasb.fxgl.app.GameApplication

```
public abstract class GameApplication
extends javafx.application.Application
```
To use FXGL extend this class and implement necessary methods. The initialization process can be seen below (irrelevant phases are omitted):
1. Instance fields of YOUR subclass of GameApplication
2. initSettings()
3. Services configuration (after this you can safely call any FXGL.* methods)
4. initAchievements()
5. initInput()
6. preInit()
7. initAssets()
8. initGameVars()
9. initGame() OR loadState()
10. initPhysics()
11. initUI()
Unless explicitly stated, methods are not thread-safe and must be executed on the JavaFX Application (UI) Thread. By default all callbacks are executed on the JavaFX Application (UI) Thread.
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

GameApplication()

Constructors
Constructor and Description
`GameApplication()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExitListener(ExitListener listener)`
`void`	`addPlayStateListener(StateListener listener)`
`void`	`addUpdateListener(UpdateListener listener)`
`protected void`	`exit()` Exit the application.
`javafx.geometry.Rectangle2D`	`getAppBounds()`
`AssetLoader`	`getAssetLoader()`
`AudioPlayer`	`getAudioPlayer()`
`Display`	`getDisplay()`
`EventBus`	`getEventBus()`
`ExceptionHandler`	`getExceptionHandler()`
`Executor`	`getExecutor()`
`Gameplay`	`getGameplay()`
`GameScene`	`getGameScene()`
`GameState`	`getGameState()`
`GameWorld`	`getGameWorld()`
`int`	`getHeight()`
`Input`	`getInput()`
`Timer`	`getMasterTimer()`
`MenuEventListener`	`getMenuListener()`
`Net`	`getNet()`
`NotificationService`	`getNotificationService()`
`PhysicsWorld`	`getPhysicsWorld()`
`ReadOnlyGameSettings`	`getSettings()`
`AppStateMachine`	`getStateMachine()`
`long`	`getTick()`
`UIFactory`	`getUIFactory()`
`int`	`getWidth()`
`void`	`init()`
`protected void`	`initAchievements()` Override to register your achievements.
`protected void`	`initAssets()` Initialize game assets, such as Texture, Sound, Music, etc.
`protected void`	`initGame()` Initialize game objects.
`protected void`	`initGameVars(Map<String,Object> vars)` Can be overridden to provide global variables.
`protected void`	`initInput()` Initialize input, i.e.
`protected void`	`initPhysics()` Initialize collision handlers, physics properties.
`protected abstract void`	`initSettings(GameSettings settings)` Initialize app settings.
`protected void`	`initUI()` Initialize UI objects.
`protected void`	`loadState(DataFile dataFile)` Called when MenuEvent.LOAD occurs.
`protected void`	`onPausedUpdate(double tpf)` Called every frame in any non-Play state.
`protected void`	`onPostUpdate(double tpf)` Called after main loop tick has been completed in Play state.
`protected void`	`onUpdate(double tpf)` Called every frame _only_ in Play state.
`protected void`	`preInit()` This is called after core services are initialized but before any game init.
`void`	`removeExitListener(ExitListener listener)`
`void`	`removePlayStateListener(StateListener listener)`
`void`	`removeUpdateListener(UpdateListener listener)`
`protected DataFile`	`saveState()` Called when MenuEvent.SAVE occurs.
`void`	`start(javafx.stage.Stage stage)` This is the main entry point as run by the JavaFX platform.
`protected void`	`startNewGame()` (Re-)initializes the user application as new and starts the game.
`void`	`stop()`
`double`	`tpf()`

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
  - GameApplication
```
public GameApplication()
```
- Method Detail
  - start
```
public final void start(javafx.stage.Stage stage)
```
    This is the main entry point as run by the JavaFX platform.
    
    Specified by:
    
    start in class javafx.application.Application
  - startNewGame
```
protected void startNewGame()
```
    (Re-)initializes the user application as new and starts the game.
  - exit
```
protected final void exit()
```
    Exit the application.
  - getMenuListener
```
public final MenuEventListener getMenuListener()
```
    Returns:
    
    menu event handler associated with this game
    
    Throws:
    
    IllegalStateException - if menus are not enabled
  - addUpdateListener
```
public final void addUpdateListener(UpdateListener listener)
```
  - removeUpdateListener
```
public final void removeUpdateListener(UpdateListener listener)
```
  - addExitListener
```
public final void addExitListener(ExitListener listener)
```
  - removeExitListener
```
public final void removeExitListener(ExitListener listener)
```
  - addPlayStateListener
```
public final void addPlayStateListener(StateListener listener)
```
  - removePlayStateListener
```
public final void removePlayStateListener(StateListener listener)
```
  - init
```
public final void init()
```
    Overrides:
    
    init in class javafx.application.Application
  - stop
```
public final void stop()
```
    Overrides:
    
    stop in class javafx.application.Application
  - initSettings
```
protected abstract void initSettings(GameSettings settings)
```
    Initialize app settings.
    
    Parameters:
    
    settings - app settings
  - initAchievements
```
protected void initAchievements()
```
    Override to register your achievements.
```
 Example:

 AchievementManager am = getAchievementManager();
 am.registerAchievement(new Achievement("Score Master", "Score 20000 points"));
 
```
  - initInput
```
protected void initInput()
```
    Initialize input, i.e. bind key presses, bind mouse buttons.
```
 Example:

 Input input = getInput();
 input.addAction(new UserAction("Move Left") {
      protected void onAction() {
          playerControl.moveLeft();
      }
 }, KeyCode.A);
 
```
  - preInit
```
protected void preInit()
```
    This is called after core services are initialized but before any game init. Called only once per application lifetime.
  - initAssets
```
protected void initAssets()
```
    Initialize game assets, such as Texture, Sound, Music, etc.
  - initGameVars
```
protected void initGameVars(Map<String,Object> vars)
```
    Can be overridden to provide global variables.
    
    Parameters:
    
    vars - map containing CVars (global variables)
  - initGame
```
protected void initGame()
```
    Initialize game objects.
  - initPhysics
```
protected void initPhysics()
```
    Initialize collision handlers, physics properties.
  - initUI
```
protected void initUI()
```
    Initialize UI objects.
  - onUpdate
```
protected void onUpdate(double tpf)
```
    Called every frame _only_ in Play state.
    
    Parameters:
    
    tpf - time per frame
  - onPostUpdate
```
protected void onPostUpdate(double tpf)
```
    Called after main loop tick has been completed in Play state. It can be used to de-register callbacks / listeners and call various methods that otherwise might interfere with main loop.
    
    Parameters:
    
    tpf - time per frame (same as main update tpf)
  - onPausedUpdate
```
protected void onPausedUpdate(double tpf)
```
    Called every frame in any non-Play state.
    
    Parameters:
    
    tpf - time per frame
  - saveState
```
protected DataFile saveState()
```
    Called when MenuEvent.SAVE occurs.
    
    Returns:
    
    data with required info about current state
    
    Throws:
    
    UnsupportedOperationException - if was not overridden
  - loadState
```
protected void loadState(DataFile dataFile)
```
    Called when MenuEvent.LOAD occurs.
    
    Parameters:
    
    dataFile - previously saved data
    
    Throws:
    
    UnsupportedOperationException - if was not overridden
  - tpf
```
public final double tpf()
```
    Returns:
    
    time per frame for current frame
  - getStateMachine
```
public final AppStateMachine getStateMachine()
```
  - getGameState
```
public final GameState getGameState()
```
  - getGameWorld
```
public final GameWorld getGameWorld()
```
  - getPhysicsWorld
```
public final PhysicsWorld getPhysicsWorld()
```
  - getGameScene
```
public final GameScene getGameScene()
```
  - getGameplay
```
public final Gameplay getGameplay()
```
  - getInput
```
public final Input getInput()
```
    Returns:
    
    play state input
  - getMasterTimer
```
public final Timer getMasterTimer()
```
    Returns:
    
    play state timer
  - getSettings
```
public final ReadOnlyGameSettings getSettings()
```
    Returns:
    
    read only copy of game 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)
  - getEventBus
```
public final EventBus getEventBus()
```
  - getDisplay
```
public final Display getDisplay()
```
  - getAudioPlayer
```
public final AudioPlayer getAudioPlayer()
```
  - getAssetLoader
```
public final AssetLoader getAssetLoader()
```
  - getExecutor
```
public final Executor getExecutor()
```
  - getNotificationService
```
public final NotificationService getNotificationService()
```
  - getNet
```
public final Net getNet()
```
  - getExceptionHandler
```
public final ExceptionHandler getExceptionHandler()
```
  - getUIFactory
```
public final UIFactory getUIFactory()
```

Class GameApplication

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

GameApplication

Method Detail

start

startNewGame

exit

getMenuListener

addUpdateListener

removeUpdateListener

addExitListener

removeExitListener

addPlayStateListener

removePlayStateListener

init

stop

initSettings

initAchievements

initInput

preInit

initAssets

initGameVars

initGame

initPhysics

initUI

onUpdate

onPostUpdate

onPausedUpdate

saveState

loadState

tpf

getStateMachine

getGameState

getGameWorld

getPhysicsWorld

getGameScene

getGameplay

getInput

getMasterTimer

getSettings

getWidth

getHeight

getAppBounds

getTick

getEventBus

getDisplay

getAudioPlayer

getAssetLoader

getExecutor

getNotificationService

getNet

getExceptionHandler

getUIFactory