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

torus: add comment

Browse source
This commit is contained in:
Starbeamrainbowlabs 2021-05-15 02:18:41 +01:00
parent bf8c847dc1
commit 57ff577694
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
worldeditadditions/lib/torus.lua
View file

@ -4,7 +4,7 @@
--- Generates a torus shape at the given position with the given parameters. --- Generates a torus shape at the given position with the given parameters.
-- @param position Vector The position at which to generate the torus. -- @param position Vector The position at which to generate the torus.
-- @param major_radius number The major radius of the torus - i.e. the distance from the middle to the ring. -- @param major_radius number The major radius of the torus - i.e. the distance from the middle to the ring.
-- @param minor_radius number The minor radius of the torus - i.e. the radaius fo the ring itself. -- @param minor_radius number The minor radius of the torus - i.e. the radius fo the ring itself.
-- @param target_node string The name of the target node to generate the torus with. -- @param target_node string The name of the target node to generate the torus with.
-- @param axes=xz string|nil The axes upon which the torus should lay flat. -- @param axes=xz string|nil The axes upon which the torus should lay flat.
-- @param hollow=false boolean Whether the generated torus should be hollow or not. -- @param hollow=false boolean Whether the generated torus should be hollow or not.
@ -20,6 +20,7 @@ function worldeditadditions.torus(position, major_radius, minor_radius, target_n
-- Fetch the nodes in the specified area -- Fetch the nodes in the specified area
-- OPTIMIZE: We should be able to calculate a more efficient box-area here -- OPTIMIZE: We should be able to calculate a more efficient box-area here
-- This is complicated by the multiple possible axes though
local manip, area = worldedit.manip_helpers.init_radius(position, total_radius) local manip, area = worldedit.manip_helpers.init_radius(position, total_radius)
local data = manip:get_data() local data = manip:get_data()