Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Game state hinting

Describes how game state hinting works with information on the automated and manual ways.
Read time 2 minutesLast updated 12 days ago
Android's game state feature indicates to the operating system whether your application is in a loading state and also whether Android can interrupt the application. Depending on the state of the application, Android can perform certain optimizations. For example, if the application is in a loading state, the operating system can provide more resources to the application to help optimize the load process. However, whether the operating system does this depends on various other factors and settings, so you can't guarantee that this will always happen.

Requirements and compatibility

Android's game state feature requires Android version 13.

Game state hinting in Unity

Unity provides game state hinting in two ways.

Automated game state hinting

Unity Player automatically sets the following parameters to indicate the game state to the operating system:
  • Application loading state as 
    isLoading
    parameter. This parameter is set to true during initial loading, when loading a scene, loading asset packs, or when sending a web request.
  • Current scene index or the type of the currently loaded content as 
    label
    parameter.
  • Current quality level as 
    quality
    parameter.
  • Default game state mode MODE_UNKNOWN as 
    mode
    parameter. The default value is changed to MODE_CONTENT when a full-screen video or a full-screen ad is displayed.
You can use the AndroidGame.Automatic.SetGameState method to override the default MODE_UNKNOWN mode with the value based on the actual state of your game.

Manual game state hinting

You can use AndroidGame.SetGameState method to indicate the current game state of your application to Android. It’s best practice to call this method when your application transitions to or from a loading state to make sure the operating system is aware of the state of your application.
Note
Automated game state hinting is disabled if you call AndroidGame.SetGameState method.

Additional resources