UnityPlayerActivity Java コードの拡張

このページの各セクション

• UnityPlayerActivity コードの拡張
• カスタムの UnityPlayerActivity ファイルから Unity 起動引数を指定
• UnityPlayerActivity のサンプルマニフェストとサンプルファイル

UnityPlayerActivity Java コードの拡張

When you develop a Unity Android application, you can use plug-ins to extend the standard UnityPlayerActivity class (the primary Java class for the Unity Player on Android, similar to AppController.mm on Unity iOS). An application can override any and all basic interactions between the Android OS and the Unity Android application.

デフォルトの Activity をオーバーライドするには以下を行います。

• UnityPlayerActivity (Android ドキュメントの Activity を参照) から派生する新しい Activity を作成します。
• 新しい Activity がアプリケーションのエントリーポイントとして使用されるように Android Manifest を修正してください。

The easiest way to achieve this is to export your Project from Unity, then make the necessary modifications to the UnityPlayerActivity class in Android Studio.

To create a plug-in with your new Activity and add it to your Project, you must perform the following steps:

1. Extend the UnityPlayerActivity file. By default, the UnityPlayerActivity.java file is located at:
   
   

   Mac:

   /Applications/Unity/Unity.app/Contents/PlaybackEngines/AndroidPlayer/src/com/unity3d/player
   
   

   Windows

   C:\Program Files\Unity\Editor\Data\PlaybackEngines\AndroidPlayer\src\com\unity3d\player
   
   

   To extend the UnityPlayerActivity file, locate the classes.jar file included with Unity. You can find it in the installation folder (C:\Program Files\Unity\Editor\Data on Windows, or /Applications/Unity on Mac), in one of these subfolders:

   • PlaybackEngines/AndroidPlayer/Variations/mono

   • il2cpp/Development

   • Release/Classes/

   Locate the file, and add classes.jar to the classpath Unity uses to compile the new Activity. Compile your Activity source file and package it into a JAR or AAR package, then copy it into your Project folder.

2. Create a new Android Manifest to set the new Activity as the entry point of your application, then place the AndroidManifest.xml file in the Assets/Plugins/Android folder of your Project.

Specifying Unity startup arguments from a custom UnityPlayerActivity file

UnityPlayerActivityを拡張すると、String UnityPlayerActivity.updateUnityCommandLineArguments(String cmdLine) をオーバーライドして、Unity に起動時の引数を渡すことができます。

UnityPlayerActivity は、起動時にこのメソッドを呼び出します。このメソッドは、現在のコマンドライン引数 (NULL または空) を受け入れ、Unity に渡すコマンドライン引数の新しい文字列を返します。

Unity のコマンドラインインターフェースの概要については、コマンドライン引数 を参照してください。

次の例は、現在のデバイスに基づいてグラフィックス API を選択するために、これを使用する方法を示しています。

package com.company.product;
import com.unity3d.player.UnityPlayerActivity;
import android.os.Bundle;
import android.os.Build;

public class OverrideExample extends UnityPlayerActivity {
    private boolean preferVulkan() {
        // Google Pixel デバイスで Vulkan を使用
        if (Build.MANUFACTURER.equals("Google") && Build.MODEL.startsWith("Pixel"))
            return true;
        else
            return false;
    }

    private boolean preferES2() {
        // Android 5.1 以前を使うデバイスで OpenGL ES 2.0 を使用 
        if (Build.VERSION.SDK_INT <= Build.VERSION_CODES.LOLLIPOP_MR1)
            return true;
        else
            return false;
    }

    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)
    {
        if (preferVulkan())
            return appendCommandLineArgument(cmdLine, "-force-vulkan");
        else if (preferES2())
            return appendCommandLineArgument(cmdLine, "-force-gles20");
        else
            return cmdLine; // Unity に Player 設定に基づくグラフィックス API を選択させます
    }

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

UnityPlayerActivity のサンプルファイル

The following is an example UnityPlayerActivity file:

OverrideExample.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) {
    // UnityPlayerActivity.onCreate() を呼び出す
    super.onCreate(savedInstanceState);
    // logcat にデバッグメッセージをプリントする
    Log.d("OverrideActivity", "onCreate called!");
  }
  public void onBackPressed()
  {
    // UnityPlayerActivity.onBackPressed() を呼び出す代わりに、Back ボタンイベントを無視する
    // super.onBackPressed();
  }
}

The corresponding AndroidManifest.xml might look like the following:

<?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: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>
    </activity>
  </application>
</manifest>

---

• 2019.2 に新しいコードサンプルを追加しました。
• 2019.3 Unity 以降の AndroidManifest の例を更新しました。