Flutter集成Unity游戏引擎插件flutter_unity的使用

Flutter集成Unity游戏引擎插件flutter_unity的使用

简介

flutter_unity 是一个Flutter插件，允许在Flutter项目中嵌入Unity项目。它支持Android和iOS平台。

使用方法

要使用此插件，请在 pubspec.yaml 文件中添加 flutter_unity 作为依赖项。

示例项目

参考提供的示例项目和包含的Unity项目，可以更好地理解如何使用 flutter_unity 插件。

测试

要测试此插件，请按照以下步骤操作：

1. 运行 git clone https://github.com/Glartek/flutter-unity.git 创建 flutter-unity 的本地副本。
2. 在 Android Studio 中打开 flutter-unity。

Android

1. 连接你的Android设备并运行项目。

iOS

1. 配置示例项目和包含的Unity项目。
2. 连接你的iOS设备并运行项目。

配置Unity项目

Android

1. 打开 File > Build Settings…，选择 Android 并点击 Switch Platform。
2. 点击 Add Open Scenes。
3. 勾选 Export Project。
4. 点击 Player Settings…，配置以下设置：
   • Resolution and Presentation > Start in fullscreen mode: No
   • Other Settings > Rendering > Graphics APIs: OpenGLES3
   • Other Settings > Configuration > Scripting Backend: IL2CPP
   • Other Settings > Configuration > Target Architectures: ARMv7, ARM64
5. 关闭 Player Settings 窗口。
6. 点击 Export 并保存为 unityExport。

iOS

1. 打开 File > Build Settings…，选择 iOS 并点击 Switch Platform。
2. 点击 Add Open Scenes。
3. 点击 Build 并保存为 UnityProject。

配置Flutter项目

Android

1. 将 unityExport 文件夹复制到 <your_flutter_project>/android/unityExport。
2. 运行 flutter pub run flutter_unity:unity_export_transmogrify。
3. 打开 <your_flutter_project>/android/unityExport/build.gradle，检查是否包含 buildTypes { profile {} }。如果没有，请添加以下代码：

   buildTypes {
       profile {}
   }
   

4. 打开 <your_flutter_project>/android/build.gradle，在 allprojects { repositories {} } 下添加以下代码：

   flatDir {
       dirs "${project(':unityExport').projectDir}/libs"
   }
   

5. 打开 <your_flutter_project>/android/settings.gradle，添加以下代码：

   include ':unityExport'
   

6. 打开 <your_flutter_project>/android/app/src/main/AndroidManifest.xml，添加以下权限：

   <uses-permission android:name="android.permission.WAKE_LOCK"/>
   

步骤1、2和3必须在每次构建新的Unity项目时重复执行。

iOS

1. 将 UnityProject 文件夹复制到 <your_flutter_project>/ios/UnityProject，并在 Xcode 中打开 <your_flutter_project>/ios/Runner.xcworkspace。
2. 打开 File > Add Files to “Runner”…，添加 <your_flutter_project>/ios/UnityProject/Unity-iPhone.xcodeproj。
3. 选择 Unity-iPhone/Data，在 Inspectors 窗格中将 Target Membership 设置为 UnityFramework。
4. 选择 Unity-iPhone，选择 PROJECT : Unity-iPhone，在 Build Settings 标签页中配置以下设置：
   • Build Options > Enable Bitcode: No
   • Linking > Other Linker Flags: -Wl,-U,_FlutterUnityPluginOnMessage
5. 选择 Runner，选择 TARGETS : Runner，在 General 标签页中配置以下设置：
   • Frameworks, Libraries, and Embedded Content:

     Name	Embed
     UnityFramework.framework	Embed & Sign

6. 选择 Runner/Runner/Info.plist，配置以下键值对：

   Key	Type	Value
   io.flutter.embedded_views_preview	Boolean	YES

步骤1、3和4必须在每次构建新的Unity项目时重复执行。

Flutter与Unity之间的消息传递

Flutter

要发送消息，在 UnityView 小部件中定义 onCreated 回调，并使用从接收的 controller 中的 send 方法。要接收消息，在 UnityView 小部件中定义 onMessage 回调。

Unity

要发送和接收消息，将 FlutterUnityPlugin.cs 包含在项目中，并使用 Messages.Send 和 Messages.Receive 方法。Message 对象有以下成员：

• id (int)：非负数表示接收消息时的源视图，发送消息时的目标视图。发送消息时，也可以设置为负数，表示消息是发给任何现有视图的。
• data (string)：实际的消息内容。

完整示例Demo

import 'package:flutter/material.dart';
import 'package:flutter_unity/flutter_unity.dart';

void main() => runApp(App());

class App extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomePage(),
    );
  }
}

class HomePage extends StatefulWidget {
  [@override](/user/override)
  _HomePageState createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  [@override](/user/override)
  void initState() {
    super.initState();
  }

  [@override](/user/override)
  void dispose() {
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Plugin example app'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            Navigator.push(context,
                MaterialPageRoute(builder: (context) => UnityViewPage()));
          },
          child: Text('Test'),
        ),
      ),
    );
  }
}

class UnityViewPage extends StatefulWidget {
  [@override](/user/override)
  _UnityViewPageState createState() => _UnityViewPageState();
}

class _UnityViewPageState extends State<UnityViewPage> {
  UnityViewController? unityViewController;

  [@override](/user/override)
  void initState() {
    super.initState();
  }

  [@override](/user/override)
  void dispose() {
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Plugin example app'),
      ),
      body: UnityView(
        onCreated: onUnityViewCreated,
        onReattached: onUnityViewReattached,
        onMessage: onUnityViewMessage,
      ),
    );
  }

  void onUnityViewCreated(UnityViewController? controller) {
    print('onUnityViewCreated');

    unityViewController = controller;

    // 发送消息给Unity中的Cube对象，调用SetRotationSpeed方法，参数为30
    controller?.send(
      'Cube',
      'SetRotationSpeed',
      '30',
    );
  }

  void onUnityViewReattached(UnityViewController controller) {
    print('onUnityViewReattached');
  }

  void onUnityViewMessage(UnityViewController controller, String? message) {
    print('onUnityViewMessage');

    // 打印从Unity接收到的消息
    print(message);
  }
}