Game (litiengine 0.4.14 API)

java.lang.Object
- de.gurkenlabs.litiengine.Game

```
public final class Game
extends java.lang.Object
```
The Game class is without any doubt one of the classes that you will call a lot when creating a game with the LITIengine. It is designed to be the static container that provides access to all important aspects of the engine, e.g. it holds the GameInfo, the RenderEngine, the SoundEngine and many other major components.

We designed the API such that all important parts that make up the game are directly accessible via the Game class in a static manner. To be a little bit more technical, it is essentially a collection of core Singleton instances.

This class will also be your starting point when setting up a new LITIengine project. In order to launch your game, you need to at least call init(String...) and start() from your programs main(String[]) method.

Additionally, it provides an interface to hook up event listeners (e.g. GameListener or EnvironmentLoadedListener) for the most basic operations of a Game life cycle.

See Also:

GameListener, GameTerminatedListener, EnvironmentLoadedListener

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMMADLINE_ARG_NOGUI`
`static java.lang.String`	`COMMADLINE_ARG_RELEASE`
`protected static long`	`environmentLoadTick`
`static int`	`EXIT_GAME_CLOSED`
`static int`	`EXIT_GAME_CRASHED`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addEnvironmentLoadedListener(EnvironmentLoadedListener listener)`
`static void`	`addGameListener(GameListener listener)`
`static void`	`addGameTerminatedListener(GameTerminatedListener listener)`
`static void`	`allowDebug(boolean allow)` This flag indicates if the game currently supports debugging.
`static ICamera`	`getCamera()`
`static GameConfiguration`	`getConfiguration()`
`static IEnvironment`	`getEnvironment()`
`static GameInfo`	`getInfo()`
`static IGameLoop`	`getLoop()`
`static IMap`	`getMap(java.lang.String mapName)` Get a Map that was already loaded into memory by its name.
`static java.util.List<IMap>`	`getMaps()` Get a list of maps that are already loaded into memory.
`static GameMetrics`	`getMetrics()`
`static IPhysicsEngine`	`getPhysicsEngine()`
`static RenderEngine`	`getRenderEngine()`
`static RenderLoop`	`getRenderLoop()`
`static IScreenManager`	`getScreenManager()`
`static ISoundEngine`	`getSoundEngine()`
`static java.util.List<ITileset>`	`getTilesets()`
`static GameTime`	`getTime()`
`static boolean`	`hasStarted()`
`static void`	`hideGUI(boolean noGui)` This flag indicates whether the game should display the `ScreenManager` or not.
`static void`	`init(java.lang.String... args)` Initializes the infrastructure of the LITIengine game.
`static boolean`	`isDebug()`
`static boolean`	`isInNoGUIMode()`
`static void`	`load(java.lang.String gameResourceFile)` Load Spritesheets, Tilesets and Maps from a game resource file created with the utiLITI editor.
`static void`	`loadEnvironment(IEnvironment env)`
`static void`	`removeEnvironmentLoadedListener(EnvironmentLoadedListener listener)`
`static void`	`removeGameListener(GameListener listener)`
`static void`	`removeGameTerminatedListener(GameTerminatedListener listener)`
`static void`	`setCamera(ICamera cam)`
`static void`	`setInfo(GameInfo info)`
`static void`	`setInfo(java.lang.String gameInfoFile)`
`static void`	`setUncaughtExceptionHandler(java.lang.Thread.UncaughtExceptionHandler uncaughtExceptionHandler)`
`static void`	`start()` Starts the `GameLoops` and other components.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXIT_GAME_CLOSED
```
public static final int EXIT_GAME_CLOSED
```
    See Also:
    
    Constant Field Values
  - EXIT_GAME_CRASHED
```
public static final int EXIT_GAME_CRASHED
```
    See Also:
    
    Constant Field Values
  - COMMADLINE_ARG_RELEASE
```
public static final java.lang.String COMMADLINE_ARG_RELEASE
```
    See Also:
    
    Constant Field Values
  - COMMADLINE_ARG_NOGUI
```
public static final java.lang.String COMMADLINE_ARG_NOGUI
```
    See Also:
    
    Constant Field Values
  - environmentLoadTick
```
protected static long environmentLoadTick
```
- Method Detail
  - addGameListener
```
public static void addGameListener(GameListener listener)
```
  - removeGameListener
```
public static void removeGameListener(GameListener listener)
```
  - addGameTerminatedListener
```
public static void addGameTerminatedListener(GameTerminatedListener listener)
```
  - removeGameTerminatedListener
```
public static void removeGameTerminatedListener(GameTerminatedListener listener)
```
  - addEnvironmentLoadedListener
```
public static void addEnvironmentLoadedListener(EnvironmentLoadedListener listener)
```
  - removeEnvironmentLoadedListener
```
public static void removeEnvironmentLoadedListener(EnvironmentLoadedListener listener)
```
  - allowDebug
```
public static void allowDebug(boolean allow)
```
    This flag indicates if the game currently supports debugging. This should be set to false for release builds. The default value here is true and will allow debugging unless explicitly disabled by calling this method or providing the command line argument COMMADLINE_ARG_RELEASE when running the game.
    
    Parameters:
    
    allow - If set to true, the game will be told to allow debugging.
  - hideGUI
```
public static void hideGUI(boolean noGui)
```
    This flag indicates whether the game should display the ScreenManager or not. This can only be set before the game has been initialized with the init(String...) method. Afterwards it doesn't have an effect anymore. If set to true, the Window.setVisible(boolean) method won't be set to true and the RenderLoop won't be started. Also the Camera won't be updated.
    
    Parameters:
    
    noGui - If set to true, the GUI will be hidden.
  - isDebug
```
public static boolean isDebug()
```
  - isInNoGUIMode
```
public static boolean isInNoGUIMode()
```
  - getConfiguration
```
public static GameConfiguration getConfiguration()
```
  - getEnvironment
```
public static IEnvironment getEnvironment()
```
  - getInfo
```
public static GameInfo getInfo()
```
  - getLoop
```
public static IGameLoop getLoop()
```
  - getMap
```
public static IMap getMap(java.lang.String mapName)
```
    Get a Map that was already loaded into memory by its name. It is important that maps always have a unique name because only the first match will be retrieved.
    
    Parameters:
    
    mapName - the name of the map you want to load
    
    Returns:
    
    null if no map with the provided name was found, otherwise the first found map.
  - getMaps
```
public static java.util.List<IMap> getMaps()
```
    Get a list of maps that are already loaded into memory.
    
    Returns:
    
    a list of all previously loaded maps
  - getTilesets
```
public static java.util.List<ITileset> getTilesets()
```
  - getMetrics
```
public static GameMetrics getMetrics()
```
  - getPhysicsEngine
```
public static IPhysicsEngine getPhysicsEngine()
```
  - getRenderEngine
```
public static RenderEngine getRenderEngine()
```
  - getRenderLoop
```
public static RenderLoop getRenderLoop()
```
  - getScreenManager
```
public static IScreenManager getScreenManager()
```
  - getSoundEngine
```
public static ISoundEngine getSoundEngine()
```
  - getCamera
```
public static ICamera getCamera()
```
  - getTime
```
public static GameTime getTime()
```
  - hasStarted
```
public static boolean hasStarted()
```
  - init
```
public static void init(java.lang.String... args)
```
    Initializes the infrastructure of the LITIengine game. The following tasks are carried out by this method:
    - load the GameConfiguration
    - handle the specified program parameters
    - configure the logging
    - set the programs Locale according to the configured values.
    - initialize and attach core components like the PhysicsEngine
    - initialize the ScreenManger
    - initialize the Input
    - initialize the GameLoop and RenderLoop
    - set a default camera
    Parameters:
    
    args - The arguments passed to the programs entry point.
  - setUncaughtExceptionHandler
```
public static void setUncaughtExceptionHandler(java.lang.Thread.UncaughtExceptionHandler uncaughtExceptionHandler)
```
  - load
```
public static void load(java.lang.String gameResourceFile)
```
    Load Spritesheets, Tilesets and Maps from a game resource file created with the utiLITI editor.
    
    Parameters:
    
    gameResourceFile - the file name of the game resource file
  - loadEnvironment
```
public static void loadEnvironment(IEnvironment env)
```
  - start
```
public static void start()
```
    Starts the GameLoops and other components. After this method is called, the engine will start to render contents of the current Screen of the ScreenManager, the SoundEngine will start to playback Sounds and the different input devices (e.g. Mouse, Keyboard) will start to process player input.
    
    When the Game has started up successfully, it'll callback to the registered GameListeners.
    
    See Also:
    
    ScreenManager.getCurrentScreen(), SoundEngine, Input, GameListener.started()
  - setCamera
```
public static void setCamera(ICamera cam)
```
  - setInfo
```
public static void setInfo(GameInfo info)
```
  - setInfo
```
public static void setInfo(java.lang.String gameInfoFile)
```

Class Game

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXIT_GAME_CLOSED

EXIT_GAME_CRASHED

COMMADLINE_ARG_RELEASE

COMMADLINE_ARG_NOGUI

environmentLoadTick

Method Detail

addGameListener

removeGameListener

addGameTerminatedListener

removeGameTerminatedListener

addEnvironmentLoadedListener

removeEnvironmentLoadedListener

allowDebug

hideGUI

isDebug

isInNoGUIMode

getConfiguration

getEnvironment

getInfo

getLoop

getMap

getMaps

getTilesets

getMetrics

getPhysicsEngine

getRenderEngine

getRenderLoop

getScreenManager

getSoundEngine

getCamera

getTime

hasStarted

init

setUncaughtExceptionHandler

load

loadEnvironment

start

setCamera

setInfo

setInfo