文档说明

关于只读

本文档中只读属性会使用右下角带锁的图标表示，如
同时只读属性/常量的颜色是#448AFF，一般属性/变量的颜色是#00B0FF
部分只读属性是隐藏API，会使用和隐藏属性一样的图标，要根据字体颜色判断

图标

快捷复制

文档内部分内容可以右键（或者触屏长按）快速复制其内容，例如这个和这个，其图标和字体颜色不用管
你可以拿左边的目录试试，不过注意不要左键，左键会跳转页面

图标链接

文档内部分图标是链接，表现为鼠标移到上面会显示一条蓝色下划线，就像这个
你可以点击跳转到对应页面
如果是文档内页面，则会直接在当前标签页打开；如果是外部链接，则会在新标签页打开

如何读定义声明（1）
在这篇文档里，所有的参数和返回值的表达全部使用typescript代码，对不认识typescript的人来说难以理解
不过，这篇文档的typescript代码还是非常容易理解的
我们以set函数为例：
set(x: number, y: number, z: number): Box3Vector3
其中，括号前面的是函数名，括号里面的内容是参数（英文逗号分隔），括号后面的是返回类型
例如，“set”是函数名，“x: number”是参数，Box3Vector3是返回类型
在参数中，“:”前面是参数名，后面是类型
例如：
x: number

其中“x”是参数，“number”是类型
回到开始，set函数的参数和返回值就是：
输入：

参数名 类型
x number
y number
z number

输出： Box3Vector3类型

如何读定义声明（2）

这是关于该文档中方法定义出现默认值的情况，以.interactRadius / .interactRadius为例：
interactRadius: = 16
其中，interactRadius的类型为，默认值为16

很多地方并没有标默认值，有时候是因为此处默认值无意义（地图运行会立刻修改/不同环境默认值不一样/无默认值），有时候是因为文档编写工作繁忙，不过无需在意，一般不需理会这些默认值

如何读定义声明（3）

这是关于该文档中旧版API和新版API在一起声明的情况
分为两种，一种是类似于 / 页面的，另一种是类似于页面的

  • 第一种
    Box3Vector3 (x: number, y: number, z: number): Box3Vector3
    GameVector3 (x: number, y: number, z: number): GameVector3
    两种编辑器分两行分开定义，第一行为旧版编辑器，第二行为Arena 编辑器
    有时只有一行，那是因为两种编辑器定义完全一样，故合并成一行
    一般这种在Box3 通用属性中出现
  • 第二种 fogColor : /
    两种编辑器的不同定义用“/”分开，“/”之前是旧版编辑器定义，之后是新版编辑器定义
    “/”两边应看作一个整体
选填参数

要是参数/属性后面带了个问号?，代表该参数/属性选填

如何看参数表格（1）

下面以( / ).teleport为例

参数 类型 说明
mapId 必填，目标频道id
players [] 必填，需要传送的玩家

该方法有mapId和players两个参数，mapId的类型为，players的类型为[]

如何看参数表格（2）

下面以( / ).sound为例

参数 类型 说明
spec 声音路径
spec 声音播放参数
sample 声音路径
gain = 1 音量增益。正常为 1，数值越大，声音越大
pitch = 1 音高增益。正常为 1，大于 1，音调越高

该方法有spec 一 个参数，类型可以是，也可以是一个（此处类似于接口，但没有明确定义，一般表格里不写）
若填入的类型为，则表示声音路径
若填入的类型为，则其中的sample参数表示声音路径；gain参数表示音量增益，默认值为1；pitch参数表示音高增益，默认值为1；

评论区