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

maze2d: add comment

Browse source
This commit is contained in:
Starbeamrainbowlabs 2023-07-07 00:53:02 +01:00
parent 74cc6669c0
commit 20935d8379
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
worldeditadditions/lib/maze2d.lua
View file

@ -1,10 +1,6 @@
local wea_c = worldeditadditions_core
local Vector3 = wea_c.Vector3
--- Generates a maze.
-- Algorithm origin: https://starbeamrainbowlabs.com/blog/article.php?article=posts/070-Language-Review-Lua.html
-- @module worldeditadditions.maze
----------------------------------
-- function to print out the world
@ -119,6 +115,15 @@ end
-- local world = maze(os.time(), width, height)
--- Generates a 2D maze.
-- **Algorithm origin:** https://starbeamrainbowlabs.com/blog/article.php?article=posts/070-Language-Review-Lua.html
-- @param pos1 Vector3 pos1 of the defined region to draw the 2D maze in in.
-- @param pos2 Vector3 pos2 of the defined region to draw the 2D maze in in.
-- @param target_node string The (normalised) node name to draw the maze in.
-- @param path_length=2 number Step this many nodes forwards at once when generating the maze. Higher values create long thin corridors.
-- @param path_width=1 number Make all corridors this number of nodes wide when generating the maze. Higher values result in wider corridors.
-- **Caution:** Make sure this value is not higher than `path_length - 1`, otherwise the maze algorithm won't work right!
-- @returns number The number of nodes replaced (i.e. the volume fo the region defined by pos1 and pos2).
function worldeditadditions.maze2d(pos1, pos2, target_node, seed, path_length, path_width)
pos1, pos2 = Vector3.sort(pos1, pos2)
-- pos2 will always have the highest co-ordinates now