From 9fccf6cd2cd91a3cfdef01b388a7932371105ee2 Mon Sep 17 00:00:00 2001 From: Lars Mueller Date: Sun, 2 Jan 2022 19:31:52 +0100 Subject: [PATCH] Mention defaults --- doc/VoxelArea.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/VoxelArea.adoc b/doc/VoxelArea.adoc index 18470a6..e7e00f8 100644 --- a/doc/VoxelArea.adoc +++ b/doc/VoxelArea.adoc @@ -9,8 +9,8 @@ The `VoxelArea` metatable provides an OOP-like utility for dealing with LuaVoxel Sets `self.__index` to `self` and `self` as the metatable of `o`, which can have the following fields: -* `MinEdge`: Minimum position of the area, inclusive -* `MaxEdge`: Maximum position of the area, inclusive +* `MinEdge`: Minimum position of the area, inclusive. Defaults to `vector.new(1, 1, 1)` if `nil`. +* `MaxEdge`: Maximum position of the area, inclusive. Defaults to `vector.new(0, 0, 0)` if `nil`. Both positions should be `vector`s of integer numbers; each component of `MinEdge` should be smaller than the respective component of `MaxEdge` if the `VoxelArea` is to be non-empty. You can use `minp, maxp = vector.sort(minp, maxp)` to achieve this.