Unity Android

https://docs.unity3d.com/6000.3/Documentation/Manual/android
Admin
Unity Android documentation provides comprehensive guides for developing, building, and deploying...
Tokens:53,019
Snippets:872
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example Activity Extending UnityPlayerGameActivity

Source: https://docs.unity3d.com/6000.3/Documentation/Manual/android-custom-activity.html

This snippet demonstrates creating a custom activity that extends UnityPlayerGameActivity, suitable for projects using the GameActivity application entry point. It overrides onCreate and onBackPressed similarly to the UnityPlayerActivity example.

```java
package com.company.product;
import com.unity3d.player.UnityPlayerGameActivity;
import android.os.Bundle;
import android.util.Log;

public class OverrideExample extends UnityPlayerGameActivity {
  protected void onCreate(Bundle savedInstanceState) {
    // Calls UnityPlayerGameActivity.onCreate()
    super.onCreate(savedInstanceState);
    // Prints debug message to Logcat
    Log.d("OverrideActivity", "onCreate called!");
  }
  public void onBackPressed()
  {
    // Instead of calling UnityPlayerGameActivity.onBackPressed(), this example ignores the back button event
    // super.onBackPressed();
  }
}
```

--------------------------------

### ADB Command to Pass -systemallocator Argument

Source: https://docs.unity3d.com/6000.3/Documentation/Manual/android-custom-activity-command-line.html

This example demonstrates how to pass the '-systemallocator' command-line argument to your Unity application using ADB. Ensure you replace placeholder package and activity names with your actual application details.

```bash
adb shell am start -n "com.Company.MyGame/com.unity3d.player.UnityPlayerActivity" -e unity "-systemallocator"
```

--------------------------------

### Configure Custom Asset Pack Delivery Mode

Source: https://docs.unity3d.com/6000.3/Documentation/Manual/android-asset-packs-create-custom.html

Use this `build.gradle` file within your custom asset pack directory to set the delivery mode. This example configures the 'fast-follow' delivery type.

```gradle
apply plugin: 'com.android.asset-pack'
assetPack {
    packName = "MyAssets1"
    dynamicDelivery {
        deliveryType = "fast-follow"
    }
}

```

--------------------------------

### Android Manifest for GameActivity Custom Activity Entry Point

Source: https://docs.unity3d.com/6000.3/Documentation/Manual/android-custom-activity.html

Configure the Android Manifest for a custom activity with 'GameActivity' as the application entry point. This example includes meta-data for the 'game' library.

```xml
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.company.product">
  <application android:icon="@drawable/app_icon" android:label="@string/app_name">
    <activity android:name="com.YourPackage.name.OverrideExample"
             android:theme="@style/BaseUnityGameActivityTheme"
             android:label="@string/app_name"
             android:configChanges="fontScale|keyboard|keyboardHidden|locale|mnc|mcc|navigation|orientation|screenLayout|screenSize|smallestScreenSize|uiMode|touchscreen">
        <intent-filter>
            <action android:name="android.intent.action.MAIN" />
            <category android:name="android.intent.category.LAUNCHER" />
        </intent-filter>
        <meta-data android:name="android.app.lib_name" android:value="game" />
    </activity>
  </application>
</manifest>

```

--------------------------------

### Install Custom Signal Handlers from Java

Source: https://docs.unity3d.com/6000.3/Documentation/Manual/android-handle-crashes.html

Call this method from Java to install Unity's custom signal handlers. It's recommended to call this from Java to ensure it runs before potential C# code execution during a crash.

```java
public native void InstallCustomSignalHandlersFromJava();
static
{
    System.loadLibrary("il2cpp");
}
// Setup activity layout
@Override protected void onCreate(Bundle savedInstanceState)
{
    InstallCustomSignalHandlersFromJava();
    ...
    mUnityPlayer = new UnityPlayer(this, this);
    setContentView(mUnityPlayer);
    mUnityPlayer.requestFocus();
}
...
```

--------------------------------

### Android Library build.gradle Configuration

Source: https://docs.unity3d.com/6000.3/Documentation/Manual/android-library-plugin-create.html

This is an example of a build.gradle file for an Android Library plug-in. It specifies build settings, dependencies, and SDK versions. Override the default build.gradle generated by Unity with this file to customize your library's build process.

```gradle
apply plugin: 'com.android.library'

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
}

android {
    namespace "com.company.myfeature"
    compileSdk getProperty("unity.compileSdkVersion") as int
    buildToolsVersion getProperty("unity.buildToolsVersion")

    compileOptions {
        sourceCompatibility JavaVersion.valueOf(getProperty("unity.javaCompatabilityVersion"))
        targetCompatibility JavaVersion.valueOf(getProperty("unity.javaCompatabilityVersion"))
    }

    defaultConfig {
        minSdk getProperty("unity.minSdkVersion") as int
        targetSdk getProperty("unity.targetSdkVersion") as int
        ndk {
            abiFilters.addAll(getProperty("unity.abiFilters").tokenize(','))
            debugSymbolLevel getProperty("unity.debugSymbolLevel")
        }
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
}

```

--------------------------------

### Example Activity Extending UnityPlayerActivity

Source: https://docs.unity3d.com/6000.3/Documentation/Manual/android-custom-activity.html

This snippet shows how to create a custom activity by extending UnityPlayerActivity. It overrides onCreate to log a message and onBackPressed to ignore the back button event. Use this when not using the GameActivity application entry point.

```java
package com.company.product;
import com.unity3d.player.UnityPlayerActivity;
import android.os.Bundle;
import android.util.Log;

public class OverrideExample extends UnityPlayerActivity {
  protected void onCreate(Bundle savedInstanceState) {
    // Calls UnityPlayerActivity.onCreate()
    super.onCreate(savedInstanceState);
    // Prints debug message to Logcat
    Log.d("OverrideActivity", "onCreate called!");
  }
  public void onBackPressed()
  {
    // Instead of calling UnityPlayerActivity.onBackPressed(), this example ignores the back button event
    // super.onBackPressed();
  }
}
```

--------------------------------

### Download Asset Pack with Callback

Source: https://docs.unity3d.com/6000.3/Documentation/Manual/android-asset-packs-manage.html

Initiate the download of an asset pack and provide a callback function to monitor download progress. The callback receives detailed asset pack information.

```csharp
AndroidAssetPacks.DownloadAssetPackAsync(assetPackName, (info) => { /* handle info */ })
```

--------------------------------

### Manifest Merger Log Entry Example

Source: https://docs.unity3d.com/6000.3/Documentation/Manual/android-troubleshooting.html

This log entry shows an example of an 'IMPLIED' permission in the manifest merger report. It indicates the permission added and the reason for its inclusion, such as a target SDK version mismatch.

```text
IMPLIED from D:\MyProject\Library\Bee\Android\Prj\IL2CPP\Gradle\launcher\src\main\AndroidManifest.xml:2:1-5:12 reason: com.test.package has a targetSdkVersion < 4
uses-permission#android.permission.READ_PHONE_STATE


```

--------------------------------

### Download Asset Pack

Source: https://docs.unity3d.com/6000.3/Documentation/Manual/android-asset-packs-manage.html

Initiate the download of a specified asset pack. The returned operation can be used to monitor progress.

```csharp
AndroidAssetPacks.DownloadAssetPackAsync(assetPackName)
```

--------------------------------

### Get Java String Hash Code

Source: https://docs.unity3d.com/6000.3/Documentation/Manual/android-high-level-api-code-examples.html

Creates an AndroidJavaObject for java.lang.String and retrieves its hash code. Use this to interact with Java String objects.

```csharp
using UnityEngine;
public class JavaExamples
{
    public static int GetJavaStringHashCode(string text)
    {
        using (AndroidJavaObject jo = new AndroidJavaObject("java.lang.String", text))
        {
            int hash = jo.Call<int>("hashCode");
            return hash;
        }
    }
}

```

--------------------------------

### Pass custom startup parameters from native Android app

Source: https://docs.unity3d.com/6000.3/Documentation/Manual/android-custom-activity-command-line.html

Override `updateUnityCommandLineArguments` to retrieve custom parameters like 'startLevel' from the Android Intent extras. Appends these parameters to the Unity command line.

```java
package com.company.product;
import com.unity3d.player.UnityPlayerActivity;
import android.os.Bundle;
import android.content.Intent;

public class CustomParameterExample extends UnityPlayerActivity {
    private String appendCommandLineArgument(String cmdLine, String arg) {
        if (arg == null || arg.isEmpty())
            return cmdLine;
        else if (cmdLine == null || cmdLine.isEmpty())
            return arg;
        else
            return cmdLine + " " + arg; 
    }

    @Override protected String updateUnityCommandLineArguments(String cmdLine)
    {
        // Get custom parameters passed from the native Android application
        Intent intent = getIntent();
        Bundle extras = intent.getExtras();
        
        if (extras != null && extras.containsKey("startLevel")) {
            int level = extras.getInt("startLevel");
            cmdLine = appendCommandLineArgument(cmdLine, "-level " + level);
        }
        
        return cmdLine;
    }

    @Override protected void onCreate(Bundle savedInstanceState)
    {
        super.onCreate(savedInstanceState);
    }
}

```

--------------------------------

### Retrieve Application Cache Directory in C#

Source: https://docs.unity3d.com/6000.3/Documentation/Manual/android-high-level-api-code-examples.html

Use this to get the cache directory for the current application. Note that `Application.temporaryCachePath` and `Application.persistentDataPath` are recommended alternatives.

```csharp
using UnityEngine;
using UnityEngine.Android;

public class JavaExamples
{
    public static string GetApplicationCacheDirectory()
    {
        using var javaFile = AndroidApplication.currentActivity.Call<AndroidJavaObject>("getCacheDir");
        var cacheDirectory = javaFile.Call<string>("getCanonicalPath");
        return cacheDirectory;
    }
}
```

--------------------------------

### Get Unity Asset Pack Names

Source: https://docs.unity3d.com/6000.3/Documentation/Manual/android-asset-packs-manage.html

Retrieve the names of all Unity-generated asset packs. Custom asset pack names must be managed manually.

```csharp
AndroidAssetPacks.GetCoreUnityAssetPackNames
```
Tokens:
Raw