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

vector3: fix comments

Browse source
This commit is contained in:
Starbeamrainbowlabs 2023-07-02 17:03:39 +01:00
parent e9c3d51863
commit 464ea53465
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
1 changed files with 7 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
worldeditadditions_core/utils/vector3.lua
View file

@ -126,7 +126,6 @@ function Vector3.round(a)
end end
--- Rounds the components of this vector to the specified number of decimal places. --- Rounds the components of this vector to the specified number of decimal places.
-- TODO: Document this.
-- @param a Vector3 The vector to round. -- @param a Vector3 The vector to round.
-- @param dp number The number of decimal places to round to. -- @param dp number The number of decimal places to round to.
-- @returns Vector3 A new instance with the components rounded to the specified number of decimal places. -- @returns Vector3 A new instance with the components rounded to the specified number of decimal places.
@ -419,13 +418,13 @@ end
-- function. Either that, or Blender 3 (https://blender.org/) is quite useful to visualise what's going on. -- function. Either that, or Blender 3 (https://blender.org/) is quite useful to visualise what's going on.
-- @source GitHub Copilot, generated 2023-01-17 -- @source GitHub Copilot, generated 2023-01-17
-- @warning Not completely tested! Pending a thorough evaluation. Seems to basically work, after some tweaks to the fluff around the edges? -- @warning Not completely tested! Pending a thorough evaluation. Seems to basically work, after some tweaks to the fluff around the edges?
-- @param {Vector3} origin The origin point to rotate around -- @param origin Vector3 The origin point to rotate around
-- @param {Vector3} point The point to rotate. -- @param point Vector3 The point to rotate.
-- @param {Vector3} rotate Rotate this much around the 3 different axes, x, y, and z. Axial rotations are handled in this order: X→Y→Z. -- @param rotate Vector3 Rotate this much around the 3 different axes, x, y, and z. Axial rotations are handled in this order: X→Y→Z.
-- @param {Number} x Rotate this much around the X axis (yz plane), in radians. -- @param x number Rotate this much around the X axis (yz plane), in radians.
-- @param {Number} y Rotate this much around the Y axis (xz plane), in radians. -- @param y number Rotate this much around the Y axis (xz plane), in radians.
-- @param {Number} z Rotate this much around the Z axis (xy plane), in radians. -- @param z number Rotate this much around the Z axis (xy plane), in radians.
-- @return {Vector3} The rotated point. -- @return Vector3 The rotated point.
function Vector3.rotate3d(origin, point, rotate) function Vector3.rotate3d(origin, point, rotate)
local point_norm = point - origin local point_norm = point - origin