CoreEngine (AchternEngine 0.4 API)

java.lang.Object
- org.achtern.AchternEngine.core.CoreEngine

All Implemented Interfaces:

Runnable, EngineHolder<RenderEngine>
```
public class CoreEngine
extends Object
implements Runnable, EngineHolder<RenderEngine>
```
The CoreEngine is the main entry point of the AchternEngine. The Engine is running the main loop and manages Game and RenderEngine.

Field Summary

Fields
Modifier and Type	Field and Description
`protected BindingProvider`	`bindingProvider` Only used during bootstrap to manage the hardware/native binding and provide the bindings during runtime
`static org.slf4j.Logger`	`LOGGER`
`protected Window`	`window` The Main Render Window
`protected List<WindowChangeListener>`	`windowChangeListenerList`

Constructor Summary

Constructors
Constructor and Description

CoreEngine(Game game, BindingProvider binding)
Creates a new Game Holder and runner

Constructors
Constructor and Description
`CoreEngine(Game game, BindingProvider binding)` Creates a new Game Holder and runner

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addWindowChangeListener(WindowChangeListener listener)`
`void`	`cleanUp()` Disposes the window.
`protected void`	`createWindow(String title, Dimension dimensions)` Creates a new Window.
`BindingProvider`	`getBindingProvider()` Only used during bootstrap to manage the hardware/native binding and provide the bindings during runtime
`RenderEngine`	`getEngine()` Retrieves the stored engine
`FPS`	`getFps()` Returns the FPS counter
`Game`	`getGame()`
`RenderEngine`	`getRenderEngine()` A nice name for getEngine().
`Window`	`getWindow()`
`void`	`removeWindowChangeListener(WindowChangeListener listener)`
`void`	`requestStop()` Request a force stop of the engine
`void`	`run()` Runs the game.
`void`	`setBindingProvider(BindingProvider bindingProvider)` Only used during bootstrap to manage the hardware/native binding and provide the bindings during runtime
`void`	`setEngine(RenderEngine engine)` Inject the engine
`void`	`start(double framerate)` Starts the game, limiting it to a given framerate (fps)
`protected void`	`stop()` Stops the game.
`boolean`	`stopRequested()` Whether a force stop was request via `requestStop()`

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

- Field Detail
  - LOGGER
```
public static final org.slf4j.Logger LOGGER
```
  - bindingProvider
```
protected BindingProvider bindingProvider
```
    Only used during bootstrap to manage the hardware/native binding and provide the bindings during runtime
  - window
```
protected Window window
```
    The Main Render Window
  - windowChangeListenerList
```
protected List<WindowChangeListener> windowChangeListenerList
```
- Constructor Detail
  - CoreEngine
```
public CoreEngine(Game game,
                  BindingProvider binding)
```
    Creates a new Game Holder and runner
    
    Parameters:
    
    game - The game to run.
    
    binding - Binding Manager
- Method Detail
  - requestStop
```
public void requestStop()
```
    Request a force stop of the engine
  - stopRequested
```
public boolean stopRequested()
```
    Whether a force stop was request via requestStop()
    
    Returns:
    
    stopRequest
  - createWindow
```
protected void createWindow(String title,
                            Dimension dimensions)
```
    Creates a new Window.
    
    Parameters:
    
    title - The window's title
    
    dimensions - The window's dimensions
  - start
```
public void start(double framerate)
```
    Starts the game, limiting it to a given framerate (fps)
    
    Parameters:
    
    framerate - The max. framerate (fps)
  - stop
```
protected void stop()
```
    Stops the game.
  - run
```
public void run()
```
    Runs the game. First it inits it. This will show a loading screen. And then update, input and renders it.
    
    Specified by:
    
    run in interface Runnable
  - cleanUp
```
public void cleanUp()
```
    Disposes the window. Destroying Mouse and Keyboard.
  - addWindowChangeListener
```
public void addWindowChangeListener(WindowChangeListener listener)
```
  - removeWindowChangeListener
```
public void removeWindowChangeListener(WindowChangeListener listener)
```
  - getFps
```
public FPS getFps()
```
    Returns the FPS counter
    
    Returns:
    
    the FPS counter
  - getRenderEngine
```
public RenderEngine getRenderEngine()
```
    A nice name for getEngine(). Nothing more. But will return the associated render engine.
    
    Returns:
    
    The main render engine
  - setEngine
```
public void setEngine(RenderEngine engine)
```
    Description copied from interface: EngineHolder
    
    Inject the engine
    
    Specified by:
    
    setEngine in interface EngineHolder<RenderEngine>
    
    Parameters:
    
    engine - The engine to store
    
    See Also:
    
    EngineHolder.getEngine()
  - getEngine
```
public RenderEngine getEngine()
```
    Description copied from interface: EngineHolder
    
    Retrieves the stored engine
    
    Specified by:
    
    getEngine in interface EngineHolder<RenderEngine>
    
    Returns:
    
    The stored engine
    
    See Also:
    
    EngineHolder.setEngine(Object)
  - getGame
```
public Game getGame()
```
  - getWindow
```
public Window getWindow()
```
  - getBindingProvider
```
@Generated(value="lombok")
public BindingProvider getBindingProvider()
```
    Only used during bootstrap to manage the hardware/native binding and provide the bindings during runtime
    
    Returns:
    
    current binding provider
  - setBindingProvider
```
@Generated(value="lombok")
public void setBindingProvider(BindingProvider bindingProvider)
```
    Only used during bootstrap to manage the hardware/native binding and provide the bindings during runtime
    
    Parameters:
    
    bindingProvider - the new binding provider

Class CoreEngine

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER

bindingProvider

window

windowChangeListenerList

Constructor Detail

CoreEngine

Method Detail

requestStop

stopRequested

createWindow

start

stop

run

cleanUp

addWindowChangeListener

removeWindowChangeListener

getFps

getRenderEngine

setEngine

getEngine

getGame

getWindow

getBindingProvider

setBindingProvider