文档

Unity 引擎

Unity 引擎

从 Java 和 Kotlin 插件代码调用 C# 代码

从 Java 和 Kotlin 插件代码中调用 C# Script代码。
阅读时间5 分钟最后更新于 5 天前

Java 和 Kotlin 插件代码可以调用 C# 脚本,例如,向 Unity 通知 Android 事件或返回插件代码的result。有两种方法可以做到这一点:
  • 向具有
    UnitySendMessage
    的游戏对象发送 message。
  • 使用 AndroidJavaProxy 通过回调接口调用 C# 方法。
有关与 Java 和 Kotlin 实现的等效 C#,请参阅从 C# 脚本调用 Java 和 Kotlin 插件代码。
注意
要调试任一方法,请将 AndroidJNIHelper.debug 设置为
true
以日志 Unity 为每次调用执行的 JNI Activity。

向游戏对象发送 message

使用
UnitySendMessage
将 Java 或 Kotlin 插件代码中的字符串发送到指定游戏对象 ON 的方法。这是一个单向调用,其中 C# 方法收字字符串,但不向插件返回值。使用于Simple通知。
插件使用三个参数调用
UnitySendMessage
:Target 游戏对象的名称、要调用的方法的名称和字符串 message。
以下 Java 示例实现了
UnitySendMessage
:
package com.example.androidplugin;import com.unity3d.player.UnityPlayer;public class MessageSender { public static void sendToUnity(String gameObjectName) { UnityPlayer.UnitySendMessage(gameObjectName, "OnMessageReceived", "Hello from Java"); }}
以下 Kotlin 示例实现了
UnitySendMessage
:
package com.example.androidpluginimport com.unity3d.player.UnityPlayerobject MessageSender { @JvmStatic fun sendToUnity(gameObjectName:字符串 UnityPlayer.UnitySendMessage(gameObjectName, "OnMessageReceived", "Hello from Kotlin") }}
在 C# Script 中,添加
UnitySendMessage
Calls 的方法。确保脚本所挂的是 Name 与第一个参数匹配的游戏对象。
using UnityEngine;public class MessageReceiver :MonoBehaviour{ void Start() { gameObject.name = "MessageReceiver"; using var sender = new AndroidJavaClass("com.example.androidplugin.MessageSender"); sender.CallStatic("sendToUnity", gameObject.name); } void OnMessageReceived(string message) { Debug.Log("Message from plug-in: " + message); }}
此示例:
  1. 设置游戏对象对象的Name以Match插件发送的TargetName。
  2. Calls 插件,该插件使用
    UnitySendMessage
    将字符串发送回指定游戏对象的 ON
    OnMessageReceived
    方法。
  3. 记录插件发送的 message。
注意
在此示例中,C# 直接Calls插件来触发器message,因此可以在没有 Android 事件的情况下运行示例。在实际项目中,插件会调用
UnitySendMessage
来响应 Android 事件,例如按钮点击或 Lifecycle 回调。
UnitySendMessage
具有以下限制:
  • 只能使用 signature
    void MethodName(string message)
    调用 C# 方法。
  • Calls 是异步的,延时为一帧。
  • 具有相同 Name 的多个游戏对象可能会导致冲突。
要发送字字符串Other的数据,请将其Serialize化为 json 字字符串。有关更多信息,请参阅 Java/Kotlin 和 C# 代码的支持数据类型。

通过回调接口调用 C# 方法

使用 AndroidJavaProxy 以 C# 实现 Java 或 Kotlin 接口。When插件Calls接口ON的方法时,Unity 会运行 C# 实现。此方法可使用于类型化回调,或用于通道结构化数据或返回回值。
在插件中定义一个接口和Calls它的类。以下插件代码Calls接口方法将message通道 C#。

Java 插件代码

package com.example.androidplugin;public class Greeter { public interface GreetingCallback { void onGreeting(String message); } public void requestGreeting(GreetingCallback callback) { callback.onGreeting("Hello from Java"); }}
### Kotlin plug-in code
package com.example.androidplugin类 Greeter { interface GreetingCallback { fun onGreeting( message:字符串 } fun requestGreeting(callback:GreetingCallback) { 回调.onGreeting("Hello from Kotlin") }}
在 C# Script 中,创建派生自
AndroidJavaProxy
并实现该接口的类。将此类的实例通道到插件。
using UnityEngine;public class GreetingExample :MonoBehaviour{ 类 GreetingCallback:AndroidJavaProxy { public GreetingCallback() : base("com.example.androidplugin.Greeter$GreetingCallback") { } void onGreeting(string message) { Debug.Log("Greeting from plug-in: " + message); } } void Start() { using var greeter = new AndroidJavaObject("com.example.androidplugin.Greeter"); greeter.Call("requestGreeting", new GreetingCallback()); }}
此示例:
  1. 创建派生自
    AndroidJavaProxy
    的 C#
    GreetingCallback
    类,并将接口 Name 传递给底部构造函数。由于
    GreetingCallback
    嵌套在
    Greeter
    类中,因此 Name 使用
    $
    分隔符:
    com.example.androidplugin.Greeter$GreetingCallback
    。
  2. 使用与接口方法匹配的 signature 实现
    onGreeting
    。Unity 会自动将接口ON的Calls路由到此 C# 实现。
  3. 为
    Greeter
    插件类创建
    AndroidJavaObject
    并调用
    requestGreeting
    ,传递代理。然后,插件会调用运行 C# 实现的
    onGreeting
    。
注意
在此示例中,插件ON Unity 的主要线程上Calls接口方法。如果您的插件从背景线程Calls 方法,则 C# 实现会ON背景线程上运行。在这种情况下,使用 AndroidApplication.InvokeOnUnityMainThread 在主要线程上运行 Any Unity API Calls。
ON 编写插件代码的更多信息,请参阅 Java 和 Kotlin 音频源插件。

其他资源