UnityNativeScripting 项目教程

1. 项目目录结构及介绍

UnityNativeScripting 项目的目录结构如下：

UnityNativeScripting/
├── Unity/
│   ├── Assets/
│   │   ├── CppSource/
│   │   │   ├── Game/
│   │   │   │   ├── Game.cpp
│   │   │   │   ├── Game.h
│   │   │   ├── iOS/
│   │   │   ├── macOS/
│   │   │   ├── Windows/
│   │   │   ├── Linux/
│   │   │   ├── Android/
│   │   ├── NativeScriptTypes.json
│   ├── README.md
├── LICENSE.txt
├── README.md

目录介绍

• Unity/: 包含 Unity 项目的主要文件。
  • Assets/: Unity 项目的资源文件夹。
    • CppSource/: 包含 C++ 源代码文件。
      • Game/: 包含游戏逻辑的 C++ 源文件（如 Game.cpp 和 Game.h）。
      • iOS/, macOS/, Windows/, Linux/, Android/: 包含不同平台的构建配置文件。
    • NativeScriptTypes.json: 配置文件，指定哪些 C# API 暴露给 C++。
  • README.md: Unity 项目的说明文件。
• LICENSE.txt: 项目的许可证文件。
• README.md: 项目的总体说明文件。

2. 项目的启动文件介绍

项目的启动文件主要是 Game.cpp 和 Game.h，它们位于 Unity/Assets/CppSource/Game/ 目录下。

Game.cpp

Game.cpp 是项目的核心逻辑文件，包含了游戏的初始化和更新逻辑。以下是一个简单的示例：

#include "Game.h"
#include <Unity/Debug.h>

void MyScript::Start() {
    String message("MyScript has started");
    Debug::Log(message);
}

void MyScript::Update() {
    // 游戏更新逻辑
}

Game.h

Game.h 是 Game.cpp 的头文件，定义了类的结构和函数声明：

#pragma once

class MyScript {
public:
    void Start();
    void Update();
};

3. 项目的配置文件介绍

项目的配置文件主要是 NativeScriptTypes.json，它位于 Unity/Assets/ 目录下。

NativeScriptTypes.json

NativeScriptTypes.json 文件用于配置哪些 C# API 暴露给 C++。以下是一个简单的示例：

{
    "Types": [
        {
            "Name": "UnityEngine.Debug",
            "Methods": [
                {
                    "Name": "Log",
                    "Parameters": [
                        {
                            "Type": "System.String"
                        }
                    ]
                }
            ]
        }
    ]
}

配置文件说明

• Types: 定义了要暴露的 C# 类型。
  • Name: 类型的名称。
  • Methods: 类型中要暴露的方法。
    • Name: 方法的名称。
    • Parameters: 方法的参数类型。

通过编辑 NativeScriptTypes.json 文件，可以指定哪些 C# API 暴露给 C++，从而实现 C++ 与 Unity 的无缝集成。