Mirrorlandia_minetest/Minetest-WorldEditAdditions
1
0
Fork 0
mirror of https://github.com/sbrl/Minetest-WorldEditAdditions.git synced 2024-12-12 08:53:21 +01:00
Code Issues Projects Releases Wiki Activity

orientation: refactor a bit, docs

Browse Source
This commit is contained in:
Starbeamrainbowlabs 2024-09-17 23:23:09 +01:00
parent d49f6d2131
commit d29b037675
No known key found for this signature in database
GPG Key ID: 1BE5172E637709C2
1 changed files with 44 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
worldeditadditions_core/utils/orientation.lua
View File

@ -29,44 +29,53 @@ end
-- --
-- Ref <https://github.com/12Me21/screwdriver2/blob/master/init.lua#L75-L79> and <https://forum.minetest.net/viewtopic.php?p=73195&sid=1d2d2e4e76ce2ef9c84646481a4b84bc#p73195> -- Ref <https://github.com/12Me21/screwdriver2/blob/master/init.lua#L75-L79> and <https://forum.minetest.net/viewtopic.php?p=73195&sid=1d2d2e4e76ce2ef9c84646481a4b84bc#p73195>
-- @namespace worldeditadditions_core.orientation -- @namespace worldeditadditions_core.orientation
local orientation = {
--- Facedir: lower 5 bits used for direction, 0 - 23 --- Facedir: lower 5 bits used for direction, 0 - 23
-- @param param2 number `param2` value to rotate. -- @param param2 number `param2` value to rotate.
-- @param axis string The name of the axis to rotate around. Valid values: `x`, `y`, `z` -- @param axis string The name of the axis to rotate around. Valid values: `x`, `y`, `z`
-- @param amount The number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**! -- @param amount The number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**!
-- @returns number A new param2 value that is rotated the given number of degrees around the given `axis` -- @returns number A new param2 value that is rotated the given number of degrees around the given `axis`
facedir = function(param2, axis, amount_rad) function facedir(param2, axis, amount_rad)
local amount = convert_normalise_rad(amount_rad) local amount = convert_normalise_rad(amount_rad)
print("DEBUG:core/orientation:facedir AMOUNT rad "..tostring(amount_rad).." norm "..tostring(amount)) print("DEBUG:core/orientation:facedir AMOUNT rad "..tostring(amount_rad).." norm "..tostring(amount))
local facedir = param2 % 32 local facedir = param2 % 32
for _, cycle in ipairs(facedir_cycles[axis]) do for _, cycle in ipairs(facedir_cycles[axis]) do
-- Find the current facedir -- Find the current facedir
-- Minetest adds table.indexof, but I refuse to use it because it returns -1 rather than nil -- Minetest adds table.indexof, but I refuse to use it because it returns -1 rather than nil
for i, fd in ipairs(cycle) do for i, fd in ipairs(cycle) do
if fd == facedir then if fd == facedir then
return param2 - facedir + cycle[1 + (i - 1 + amount) % 4] -- If only Lua didn't use 1 indexing... return param2 - facedir + cycle[1 + (i - 1 + amount) % 4] -- If only Lua didn't use 1 indexing...
end
end end
end end
return param2
end,
-- Wallmounted: lower 3 bits used, 0 - 5
wallmounted = function(param2, axis, amount_rad)
local amount = convert_normalise_rad(amount_rad)
print("DEBUG:core/orientation:wallmounted AMOUNT rad " .. tostring(amount_rad) .. " norm " .. tostring(amount))
local wallmounted = param2 % 8
for i, wm in ipairs(wallmounted_cycles[axis]) do
if wm == wallmounted then
return param2 - wallmounted + wallmounted_cycles[axis][1 + (i - 1 + amount) % 4]
end
end
return param2
end end
return param2
end
--- Wallmounted: lower 3 bits used, 0 - 5
-- @param param2 number `param2` value to rotate.
-- @param axis string The name of the axis to rotate around. Valid values: `x`, `y`, `z`
-- @param amount The number of radians to rotate around the given `axis`. Only right angles are supported (i.e. 90° increments). Any value that isn't a 90° increment will be **rounded**!
-- @returns number A new param2 value that is rotated the given number of degrees around the given `axis`
function wallmounted(param2, axis, amount_rad)
local amount = convert_normalise_rad(amount_rad)
print("DEBUG:core/orientation:wallmounted AMOUNT rad " .. tostring(amount_rad) .. " norm " .. tostring(amount))
local wallmounted = param2 % 8
for i, wm in ipairs(wallmounted_cycles[axis]) do
if wm == wallmounted then
return param2 - wallmounted + wallmounted_cycles[axis][1 + (i - 1 + amount) % 4]
end
end
return param2
end
local orientation = {
facedir = facedir,
wallmounted = wallmounted,
-- From the original codebase (linked above):
--colorfacedir = facedir,
--colorwallmounted = wallmounted
-- ...we'll need to know this later
} }
-- From the original codebase (linked above):
--orientation.colorfacedir = orientation.facedir
--orientation.colorwallmounted = orientation.wallmounted
-- ...we'll need to know this later
return orientation return orientation