Immersive support for Android games

Monkey Targets Forums/Android/Immersive support for Android games

SGEM	(Posted 2014) [#1]

The community here is very supportive, so here is my little contribution!

Android 4.4 (KitKat) and later support a so called Immersive mode for the soft navigation buttons. This allows them to be hidden but displayed again after swiping down from where the status bar should be.

Full details are available here: https://developer.android.com/training/system-ui/immersive.html

There are two source files and 2 steps to perform.

immersive.monkey

Strict

#if TARGET="android"

Import "native/immersive.${TARGET}.${LANG}"

Extern
Function EnableImmersiveMode:Bool() = "Immersive.EnableImmersiveMode"

#End

immersive.android.java

class Immersive extends ActivityDelegate implements Runnable {
	private static Immersive immersive;
	
	private Immersive()
	{
		
	}
	
	public static boolean EnableImmersiveMode()
	{
		if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) 
		{
			Log.d("Immersive", "Enabling immersive");
			immersive = new Immersive();
			BBAndroidGame.AndroidGame().AddActivityDelegate( immersive );
			// The initial onFocus as already been called by this point, so lets fake a call.
			BBAndroidGame.AndroidGame().GetGameView().post(immersive);
			return true;
		}
		Log.d("Immersive", "API version too low, not enabling immersive");
		return false;
	}
	
	@Override
	public void onResume() {
		// Resume is actually called as a result of onFocusChanged
		View decorView = BBAndroidGame.AndroidGame()._activity.getWindow().getDecorView();
        decorView.setSystemUiVisibility(
                View.SYSTEM_UI_FLAG_LAYOUT_STABLE
                | View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION
                | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN
                | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION
                | View.SYSTEM_UI_FLAG_FULLSCREEN
                | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);		
	}

	@Override
	public void run() {
		immersive.onResume();
	}
	
}

Integration
* Set targetSdkVersion to 19 or greater in the application manifest (you can do this in the templates folder of the android build folder)
* Make a call to EnableImmersiveMode() early in your code. I like to do it immediately after the loading screen has finished.
* Open a beer! You're done!

I will be updating my game Hop Or Pop with this in the next few days, but I have tested on 5 physical devices and the emulator covering a range of sdk versions.

Happy New Year everyone!

Snader

(Posted 2015) [#2]

Very nice! Will test soon!