uk.co.electronstudio.retrowar

Class App

uk.co.electronstudio.retrowar.App

Direct Known Subclasses:

SimpleApp

public class App

Main libgdx common application class. Created by platform specific launchers. Delegates actual rendering loop to Screens

For most games you can use subclass SimpleApp rather than App directly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	App.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static App.Companion	Companion
static App	app A static reference to the singleton Application
GameFactory	controllerTest
uk.co.electronstudio.sdl2gdx.SDL2ControllerManager	controllers
GameFactory	screenTest1
GameFactory	screenTest2
RetroShader	shader

Constructor Summary

Constructors

Constructor and Description
App(Callback callback, Logger logger, ManualGC manualGC) Main libgdx common application class. Created by platform specific launchers. Delegates actual rendering loop to Screens

Method Summary

Modifier and Type	Method and Description
boolean	anyKeyHit() has any key or controller button or mouse recently been hit?
void	applyMusicVolume(float volume)
void	clearEvents() If player hit a key during game, you dont want that event to then take effect in the menu after the game, so you call this.
void	configureSessionWithPreSelectedInputDevice(GameSession session) For some games, e.g. a standalone mobile game, you dont want the player to have to hit a button to enter the game. This auto-adds the first player to the game so he doesnt have to this.
void	findIPaddress() Tries to connect to AWS to get current IP address in separate thread so wont slow down launch waiting for result
Player	findPlayerAssociatedWithController(uk.co.electronstudio.sdl2gdx.SDL2Controller c)
static App	getApp() A static reference to the singleton Application
Callback	getCallback() For setting maximum FPS,
uk.co.electronstudio.retrowar.network.Client	getClient() May be null if no Client
java.util.Map<uk.co.electronstudio.sdl2gdx.SDL2Controller,uk.co.electronstudio.retrowar.PlayerData>	getControllerMappings()
GameFactory	getControllerTest()
uk.co.electronstudio.sdl2gdx.SDL2ControllerManager	getControllers()
de.golfgl.gdxgameanalytics.GameAnalytics	getGameAnalytics() If you are using GameAnalytics service set this, otherwise null
uk.co.electronstudio.retrowar.music.ibxm.IBXMPlayer	getIbxmPlayer()
java.lang.String	getIp() Current IP address, if known. Else "unknown"
Logger	getLogger() If debug is on then logs are sent here,
ManualGC	getManualGC() GDX on iOS has very poor garbage collection.
boolean	getMouseJustClicked()
java.util.List<uk.co.electronstudio.retrowar.PlayerData>	getPlayerData()
java.util.List<uk.co.electronstudio.retrowar.Player>	getPlayers()
com.badlogic.gdx.Screen	getSavedScreen()
GameFactory	getScreenTest1()
GameFactory	getScreenTest2()
uk.co.electronstudio.retrowar.network.Server	getServer() May be null if no Server
RetroShader	getShader()
com.badlogic.gdx.Screen	getTitle() Title screen
java.lang.String	getVersionString()
void	initialiseAndroid()
void	initialiseControllers() Populates mappedControllers
void	initialiseDesktop()
void	initialiseNetwork() Setup network stuff, not currently working
void	initialisePrefs() Prefs can have behviour attached, like setting the screen resolution. This triggers it for all of them, if they have it.
void	initialiseShader()
void	initialiseSteam()
void	initializeInput()
void	loadPlayerData()
void	quit()
void	restoreSavedScreenAndDisposeCurrentScreen()
void	savePlayerData()
static void	setApp(App p) A static reference to the singleton Application
void	setClient(uk.co.electronstudio.retrowar.network.Client p) May be null if no Client
void	setControllerTest(GameFactory p)
void	setControllers(uk.co.electronstudio.sdl2gdx.SDL2ControllerManager p)
void	setFPS(int f) Uses the Callback to set max FPS, if the platform supports it
void	setGameAnalytics(de.golfgl.gdxgameanalytics.GameAnalytics p) If you are using GameAnalytics service set this, otherwise null
void	setIp(java.lang.String p) Current IP address, if known. Else "unknown"
void	setPlayerData(java.util.List<uk.co.electronstudio.retrowar.PlayerData> p)
void	setSavedScreen(com.badlogic.gdx.Screen p)
void	setScreenMode()
void	setScreenTest1(GameFactory p)
void	setScreenTest2(GameFactory p)
void	setServer(uk.co.electronstudio.retrowar.network.Server p) May be null if no Server
void	setShader(RetroShader p)
void	setTitle(com.badlogic.gdx.Screen p) Title screen
void	showTitleScreen()
void	submitAnalytics(java.lang.String s)
void	submitAnalyticsProgress(java.lang.String game, java.lang.String level)
void	swapScreenAndDispose(com.badlogic.gdx.Screen screen) Displays a new screen and disposes of the old one
void	swapScreenAndSave(com.badlogic.gdx.Screen screen) Displays a new screen and save old one for later
java.lang.String	testSandbox() For testing sandbox permissions, attempts to read property we shouldnt be allowed to read

Field Detail

controllers

public uk.co.electronstudio.sdl2gdx.SDL2ControllerManager controllers

controllerTest

public GameFactory controllerTest

screenTest1

public GameFactory screenTest1

screenTest2

public GameFactory screenTest2

shader

public RetroShader shader

app

public static App app

A static reference to the singleton Application

Companion

public static App.Companion Companion

Constructor Detail

App

public App(Callback callback,
           Logger logger,
           ManualGC manualGC)

Main libgdx common application class. Created by platform specific launchers. Delegates actual rendering loop to Screens

For most games you can use subclass SimpleApp rather than App directly.

Parameters:

callback - For setting maximum FPS, platform specific

logger - If debug is on then logs are sent here, which may send them to screen, file orcloud.

manualGC - GDX on iOS has very poor garbage collection. Supply one of these to disableit and do your own GC. Otherwise null.

callback - For setting maximum FPS, platform specific

logger - If debug is on then logs are sent here, which may send them to screen, file or cloud.

manualGC - GDX on iOS has very poor garbage collection. Supply one of these to disable it and do your own GC. Otherwise null.

Method Detail

getTitle

public com.badlogic.gdx.Screen getTitle()

Title screen

setTitle

public void setTitle(com.badlogic.gdx.Screen p)

Title screen

getGameAnalytics

public de.golfgl.gdxgameanalytics.GameAnalytics getGameAnalytics()

If you are using GameAnalytics service set this, otherwise null

setGameAnalytics

public void setGameAnalytics(de.golfgl.gdxgameanalytics.GameAnalytics p)

If you are using GameAnalytics service set this, otherwise null

getControllers

public uk.co.electronstudio.sdl2gdx.SDL2ControllerManager getControllers()

setControllers

public void setControllers(uk.co.electronstudio.sdl2gdx.SDL2ControllerManager p)

getPlayers

public java.util.List<uk.co.electronstudio.retrowar.Player> getPlayers()

findPlayerAssociatedWithController

public Player findPlayerAssociatedWithController(uk.co.electronstudio.sdl2gdx.SDL2Controller c)

getPlayerData

public java.util.List<uk.co.electronstudio.retrowar.PlayerData> getPlayerData()

setPlayerData

public void setPlayerData(java.util.List<uk.co.electronstudio.retrowar.PlayerData> p)

getControllerMappings

public java.util.Map<uk.co.electronstudio.sdl2gdx.SDL2Controller,uk.co.electronstudio.retrowar.PlayerData> getControllerMappings()

loadPlayerData

public void loadPlayerData()

savePlayerData

public void savePlayerData()

findIPaddress

public void findIPaddress()

Tries to connect to AWS to get current IP address in separate thread so wont slow down launch waiting for result

setFPS

public void setFPS(int f)

Uses the Callback to set max FPS, if the platform supports it

initialiseNetwork

public void initialiseNetwork()

Setup network stuff, not currently working

getIp

public java.lang.String getIp()

Current IP address, if known. Else "unknown"

setIp

public void setIp(java.lang.String p)

Current IP address, if known. Else "unknown"

getServer

public uk.co.electronstudio.retrowar.network.Server getServer()

May be null if no Server

setServer

public void setServer(uk.co.electronstudio.retrowar.network.Server p)

May be null if no Server

getClient

public uk.co.electronstudio.retrowar.network.Client getClient()

May be null if no Client

setClient

public void setClient(uk.co.electronstudio.retrowar.network.Client p)

May be null if no Client

getControllerTest

public GameFactory getControllerTest()

setControllerTest

public void setControllerTest(GameFactory p)

getScreenTest1

public GameFactory getScreenTest1()

setScreenTest1

public void setScreenTest1(GameFactory p)

getScreenTest2

public GameFactory getScreenTest2()

setScreenTest2

public void setScreenTest2(GameFactory p)

getIbxmPlayer

public uk.co.electronstudio.retrowar.music.ibxm.IBXMPlayer getIbxmPlayer()

getShader

public RetroShader getShader()

setShader

public void setShader(RetroShader p)

anyKeyHit

public boolean anyKeyHit()

has any key or controller button or mouse recently been hit?

testSandbox

public java.lang.String testSandbox()

For testing sandbox permissions, attempts to read property we shouldnt be allowed to read

getMouseJustClicked

public boolean getMouseJustClicked()

getVersionString

public java.lang.String getVersionString()

getSavedScreen

public com.badlogic.gdx.Screen getSavedScreen()

setSavedScreen

public void setSavedScreen(com.badlogic.gdx.Screen p)

swapScreenAndDispose

public void swapScreenAndDispose(com.badlogic.gdx.Screen screen)

Displays a new screen and disposes of the old one

swapScreenAndSave

public void swapScreenAndSave(com.badlogic.gdx.Screen screen)

Displays a new screen and save old one for later

restoreSavedScreenAndDisposeCurrentScreen

public void restoreSavedScreenAndDisposeCurrentScreen()

showTitleScreen

public void showTitleScreen()

quit

public void quit()

clearEvents

public void clearEvents()

If player hit a key during game, you dont want that event to then take effect in the menu after the game, so you call this.

initialisePrefs

public void initialisePrefs()

Prefs can have behviour attached, like setting the screen resolution. This triggers it for all of them, if they have it.

initialiseControllers

public void initialiseControllers()

Populates mappedControllers

initializeInput

public void initializeInput()

initialiseDesktop

public void initialiseDesktop()

initialiseAndroid

public void initialiseAndroid()

initialiseShader

public void initialiseShader()

initialiseSteam

public void initialiseSteam()

setScreenMode

public void setScreenMode()

submitAnalytics

public void submitAnalytics(java.lang.String s)

submitAnalyticsProgress

public void submitAnalyticsProgress(java.lang.String game,
                                    java.lang.String level)

configureSessionWithPreSelectedInputDevice

public void configureSessionWithPreSelectedInputDevice(GameSession session)

For some games, e.g. a standalone mobile game, you dont want the player to have to hit a button to enter the game. This auto-adds the first player to the game so he doesnt have to this.

applyMusicVolume

public void applyMusicVolume(float volume)

getCallback

public Callback getCallback()

For setting maximum FPS,

platform specific

getLogger

public Logger getLogger()

If debug is on then logs are sent here,

which may send them to screen, file orcloud.

getManualGC

public ManualGC getManualGC()

GDX on iOS has very poor garbage collection.

Supply one of these to disableit and do your own GC. Otherwise null.

getApp

public static App getApp()

A static reference to the singleton Application

setApp

public static void setApp(App p)

A static reference to the singleton Application