如何在 YAHAHA Studio 调用 Unity API
概述
Unity API 按类型(类、结构体或枚举)组织,每个类成员分为三类:字段与属性(Fields and Properties)、构造函数(Constructors)和方法(Methods)。本文介绍如何在 YAHAHA Studio 中用 Lua 访问和使用这些成员。
字段与属性
Unity API 的字段和属性有两种格式:
- 静态成员:
<字段类型> <类型>.<字段名> - 实例成员:
<字段类型> <字段名>
示例(来自 UnityEngine.Rect):
(static) UnityEngine.Rect UnityEngine.Rect.zero
UnityEngine.Vector2 position
在 YAHAHA Studio 的 Lua 脚本中,字段和属性访问方式如下:
- 实例成员:
对象实例.字段名 - 静态成员:
类型名.字段名
Lua 用法:
-- 访问静态属性
local rect = UnityEngine.Rect.zero
-- 访问实例属性
local pos = rect.position
构造函数
在 YAHAHA Studio,构造函数格式为:<类型>.New(<参数>)
示例(来自 UnityEngine.Rect):
UnityEngine.Rect.New(float, float, float, float)
UnityEngine.Rect 类型有 4 个参数的构造函数,Lua 调用如下:
Lua 用法:
local rect = UnityEngine.Rect.New(1, 2, 3, 4)
方法
Unity API 的方法有两种格式:
- 实例方法:
<返回类型> <方法名>(<参数>) - 静态方法:
<返回类型> <类型>.<方法名>(<参数>)
示例(来自 UnityEngine.Rect):
void Set(float, float, float, float)
(static) UnityEngine.Rect UnityEngine.Rect.MinMaxRect(float, float, float, float)
在 YAHAHA Studio 的 Lua 脚本中,方法调用方式如下:
- 实例方法:用冒号
:语法调用,如对象实例:方法名(参数) - 静态方法:用点
.语法调用,如类型名.方法名(参数)
Lua 用法:
-- 实例方法
rect:Set(1, 2, 3, 4)
-- 静态方法
local rect2 = UnityEngine.Rect.MinMaxRect(5, 4, 3, 2)