Unity provides high-level APIs such as AndroidJavaObject
, AndroidJavaClass
, AndroidJavaProxy
, and AndroidApplication
that allow you to interact with Java/Kotlin code from C# scriptsA piece of code that allows you to create your own Components, trigger game events, modify Component properties over time and respond to user input in any way you like. More info
See in Glossary.
The following code examples demonstrate how to use these APIs.
The following code example creates an instance of java.lang.String initialized with a string, and retrieves the hash value for that string.
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;
}
}
}
This example:
AndroidJavaObject
that represents a java.lang.String.AndroidJavaObject
constructor takes at least one parameter, which is the name of the class to construct an instance of. Any parameters after the class name are for the constructor call on the object, in this case the text
parameter from GetJavaStringHashCode
.int
generic type parameter for Call
because hashCode()
returns the hash code as an integer.
Note: You can’t use dotted notation to instantiate a nested Java class. You must use the $
separator to instantiate inner classes. For example, Use android.view.ViewGroup$LayoutParams
or android/view/ViewGroup$LayoutParams
, where the LayoutParams
class is nested in the ViewGroup
class.
The following code example retrieves the cache directory for the current application in C# using the AndroidApplication
class.
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;
}
}
This example:
AndroidApplication.currentActivity
to access the current Android activity, without explicitly creating AndroidJavaClass
or AndroidJavaObject
instances.Note: This example is for reference purposes. Instead, to access the application’s cache and file directory use the Application.temporaryCachePath and Application.persistentDataPath APIs.
The following code example shows how to pass data from Java to Unity using UnitySendMessage
.
using UnityEngine;
using UnityEngine.Android;
public class JavaExamples : MonoBehaviour
{
private void Start()
{
AndroidJNIHelper.debug = true;
AndroidApplication.unityPlayer.CallStatic("UnitySendMessage", "My GameObject", "JavaMessage", "NewMessage");
}
private void JavaMessage(string message)
{
Debug.Log("message from java: " + message);
}
}
This example:
AndroidApplication.unityPlayer
to access the Java instance used by an activity without explicitly creating an AndroidJavaClass
instance.UnitySendMessage
method that’s a member of com.unity3d.player.UnityPlayer
.Although you call UnitySendMessage
from within Unity, it uses Java to relay the message, which then calls back to the native/Unity code to deliver it to the GameObjectThe fundamental object in Unity scenes, which can represent characters, props, scenery, cameras, waypoints, and more. A GameObject’s functionality is defined by the Components attached to it. More info
See in Glossary named My GameObject
which has an attached script that contains a method called JavaMessage
.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.