GameApplication (fxgl 0.3.1 API)

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

```
public abstract class GameApplication
extends FXGLApplication
```
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 FXGL.getService())
4. initAchievements()
5. initInput()
6. preInit()
7. initAssets()
8. initGameVars()
9. initGame() OR loadState()
10. initPhysics()
11. initUI()
12. Start of main game loop execution on UI thread
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.
Callback / listener notes: instance of GameApplication will always be notified last along the chain of callbacks. However, as per documentation, events are always fired after listeners.
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 com.almasb.fxgl.app.FXGLApplication
  log
- 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 Concrete Methods
Modifier and Type	Method and Description
`GameScene`	`getGameScene()`
`GameState`	`getGameState()`
`GameWorld`	`getGameWorld()`
`MenuEventListener`	`getMenuListener()`
`PhysicsWorld`	`getPhysicsWorld()`
`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 SceneFactory`	`initSceneFactory()` Override to provide custom intro/loading/menu scenes.
`protected void`	`initUI()` Initialize UI objects.
`boolean`	`isMenuOpen()`
`boolean`	`isPaused()`
`protected void`	`loadState(DataFile dataFile)` Called when MenuEvent.LOAD occurs.
`protected void`	`onPostUpdate(double tpf)` Called after main loop tick has been completed.
`protected void`	`onUpdate(double tpf)` Main loop update phase, most of game logic.
`protected void`	`preInit()` This is called after core services are initialized but before any game init.
`protected DataFile`	`saveState()` Called when MenuEvent.SAVE occurs.
`protected void`	`startLoadedGame(DataFile dataFile)` (Re-)initializes the user application from the given data file and starts the game.
`protected void`	`startNewGame()` (Re-)initializes the user application as new and starts the game.

Methods inherited from class com.almasb.fxgl.app.FXGLApplication
addFXGLListener, exit, getAchievementManager, getAppBounds, getAssetLoader, getAudioPlayer, getDisplay, getEventBus, getExceptionHandler, getExecutor, getHeight, getInput, getMasterTimer, getNet, getNotificationService, getNow, getPrimaryStage, getQTE, getQuestService, getSettings, getTick, getUIFactory, getWidth, init, initSettings, pause, removeFXGLListener, reset, resume, start, 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
  - GameApplication
```
public GameApplication()
```
- Method Detail
  - getGameState
```
public final GameState getGameState()
```
    Returns:
    
    game state
  - getGameWorld
```
public final GameWorld getGameWorld()
```
    Returns:
    
    game world
  - getPhysicsWorld
```
public final PhysicsWorld getPhysicsWorld()
```
    Returns:
    
    physics world
  - getGameScene
```
public final GameScene getGameScene()
```
    Returns:
    
    game scene
  - initSceneFactory
```
protected SceneFactory initSceneFactory()
```
    Override to provide custom intro/loading/menu scenes.
    
    Returns:
    
    scene factory
  - 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.
    Note: This method is called prior to any game init to register input mappings in the menus.
```
 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.
  - saveState
```
protected DataFile saveState()
```
    Called when MenuEvent.SAVE occurs. Note: if you enable menus, you are responsible for providing appropriate serialization of your game state. Otherwise an exception will be thrown when save is called.
    
    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. Note: if you enable menus, you are responsible for providing appropriate deserialization of your game state. Otherwise an exception will be thrown when load is called.
    
    Parameters:
    
    dataFile - previously saved data
    
    Throws:
    
    UnsupportedOperationException - if was not overridden
  - 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)
```
    Main loop update phase, most of game logic.
    
    Parameters:
    
    tpf - time per frame
  - onPostUpdate
```
protected void onPostUpdate(double tpf)
```
    Called after main loop tick has been completed. 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)
  - isMenuOpen
```
public boolean isMenuOpen()
```
    Returns:
    
    true if any menu is open
  - isPaused
```
public boolean isPaused()
```
    Returns:
    
    true if game is paused or menu is open
  - startNewGame
```
protected void startNewGame()
```
    (Re-)initializes the user application as new and starts the game. Note: cannot be called during callbacks.
  - startLoadedGame
```
protected void startLoadedGame(DataFile dataFile)
```
    (Re-)initializes the user application from the given data file and starts the game. Note: cannot be called during callbacks.
    
    Parameters:
    
    dataFile - save data to load from
  - getMenuListener
```
public MenuEventListener getMenuListener()
```
    Returns:
    
    menu event handler associated with this game
    
    Throws:
    
    IllegalStateException - if menus are not enabled

Class GameApplication

Nested Class Summary

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

Field Summary

Fields inherited from class com.almasb.fxgl.app.FXGLApplication

Fields inherited from class javafx.application.Application

Constructor Summary

Method Summary

Methods inherited from class com.almasb.fxgl.app.FXGLApplication

Methods inherited from class javafx.application.Application

Methods inherited from class java.lang.Object

Constructor Detail

GameApplication

Method Detail

getGameState

getGameWorld

getPhysicsWorld

getGameScene

initSceneFactory

initAchievements

initInput

preInit

initAssets

saveState

loadState

initGameVars

initGame

initPhysics

initUI

onUpdate

onPostUpdate

isMenuOpen

isPaused

startNewGame

startLoadedGame

getMenuListener