voxels & Box3Voxels / GameVoxels 方块模块

查阅官方文档
查阅官方文档（Arena）
查阅社区文档（Arena）

Box3Voxels / GameVoxels无法（很难）被实例化，但在全局存在一个单例对象voxels
可以通过voxels对象控制世界的地形变化，利用循环语法批量生成/销毁方块，获取某个方块的类型、名称、旋转角度等。

属性¶

shape: /

地图尺寸，决定了能放置方块区域的最大尺寸
这一属性在地图创建之初就以确定，无法修改

提示与技巧

在该空间之外无法放置方块，但实体不受影响
你可以通过使用实体代替方块的方法来创建理论无限大空间的地图
注意以下三点：

1. 一是玩家的活动范围
2. 二是类型精度问题
3. 实体数量上限问题

Bug

若是创建一个中等大小（6412864）的地图，在控制台输入时该属性正常，在代码文件中shape会变成{ x:32, y:32, z:32 }
经2024/8/19测试，超大地图（25664256）也有此问题
可以通过voxels.shape.set(...)修复

VoxelTypes: []

一个包含所有方块 名称 的数组。

注意

这个属性的命名方法和其他属性不同，第一个字母大写。注意不要写成voxelTypes

方法¶

id(name: ):

将方块名称转换为方块id

示例

voxels.id('air')   //<~ 0
voxels.id('dirt')  //<~ 125
voxels.id('stone') //<~ 129

name(id: ):

将方块id转换为方块名称

示例

voxels.name(0)   //<~ 'air'
voxels.name(125) //<~ 'dirt'
voxels.name(129) //<~ 'stone'

setVoxel(x: , y: , z: , voxel: | , rotation: | ):

使用方块名称或无旋转码的id，在指定的坐标位置放置一个方块。
若填写的方块无效，则放置空气（'air': 0）

属性	类型	说明
x		必填，放置位置的x坐标
y		必填，放置位置的y坐标
z		必填，放置位置的z坐标
voxel	|	必填，方块名称或id
rotation?	|	选填，方块的旋转码，可以填的值为0, 1, 2, 3、'0', '1', '2', '3'

返回值	类型	说明
		新的方块id

提示

rotation参数也可以填写字符串，但是似乎没人这么写，因为这么写除了多了个引号就没有别的用途了

!!! warning "此方法不适用于复制/保存地形 voxel参数中包含的方块旋转码无效，实际旋转码只和rotation有关"

setVoxelId(x: , y: , z: , voxel: ):

使用方块id，直接在指定的坐标位置放置方块。
执行效率比setVoxel更快。
若voxel不带旋转码，则方块面向北方（-z方向）
若填写的方块无效，则放置空气（'air': 0）

属性	类型	说明
x		必填，放置位置的x坐标
y		必填，放置位置的y坐标
z		必填，放置位置的z坐标
voxel		必填，方块id

返回值	类型	说明
		新的方块id

提示

voxel参数包含的方块旋转码有效
通过此可以在没有rotation参数的情况下修改方块旋转码

getVoxel(x: , y: , z: ):

获取指定地方的方块id

属性	类型	说明
x		必填，获取的方块的x坐标
y		必填，获取的方块的y坐标
z		必填，获取的方块的z坐标

返回值	类型	说明
		获取的方块id

提示与技巧

由于其不带旋转码的特性，可以直接用此方法判断方块的id来判断的种类，而不是用name方法转换成方块名称后再比较

此方法不适用于复制/保存地形

用此方法获取的id不带旋转码

getVoxelId(x: , y: , z: ):

直接获取指定地方的方块id
用此方法获取的id带方块旋转码
执行效率比getVoxel更快。

属性	类型	说明
x		必填，获取的方块的x坐标
y		必填，获取的方块的y坐标
z		必填，获取的方块的z坐标

返回值	类型	说明
		获取的方块id

用此方法获取的id带旋转码

getVoxelRotation(x: , y: , z: ):

获取某个坐标位置的方块旋转码

属性	类型	说明
x		必填，获取的方块的x坐标
y		必填，获取的方块的y坐标
z		必填，获取的方块的z坐标

返回值	类型	说明
		获取的方块旋转码

方块速查表¶

评论区