sbrl-github/Minetest-WorldEditAdditions
1
0
Fork 0
mirror of https://github.com/sbrl/Minetest-WorldEditAdditions.git synced 2024-11-26 09:03:01 +00:00
Code Issues Releases Wiki Activity

ellipsoid: add comment

Browse source
This commit is contained in:
Starbeamrainbowlabs 2021-10-13 22:50:37 +01:00
parent 5bdd8ddb5e
commit 91d5b9abc2
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
worldeditadditions/lib/ellipsoid.lua
View file

@ -4,6 +4,14 @@
-- ██ ██ ██ ██ ██ ██ ██ -- ██ ██ ██ ██ ██ ██ ██
-- ███████ ███████ ███████ ██ ██ ███████ ███████ -- ███████ ███████ ███████ ██ ██ ███████ ███████
--- Fills an ellipsoidal area around the given position with the target node.
-- The resulting ellipsoid may optionally be hollow (in which case
-- nodes inside the ellipsoid are left untouched).
-- @param position Vector3 The centre position of the ellipsoid.
-- @param radius Vector3 The radius of the ellipsoid in all 3 dimensions.
-- @param target_node string The name of the node to use to fill the ellipsoid.
-- @param hollow bool Whether the ellipsoid should be hollow or not.
-- @returns number The number of nodes filled to create the (optionally hollow) ellipsoid. This number will be lower with hollow ellipsoids, since the internals of an ellipsoid aren't altered.
function worldeditadditions.ellipsoid(position, radius, target_node, hollow) function worldeditadditions.ellipsoid(position, radius, target_node, hollow)
-- position = { x, y, z } -- position = { x, y, z }
local hollow_inner_radius = { local hollow_inner_radius = {