From 464ea53465444db9f26133ad9bc2a382cff0736c Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Sun, 2 Jul 2023 17:03:39 +0100 Subject: [PATCH] vector3: fix comments --- worldeditadditions_core/utils/vector3.lua | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/worldeditadditions_core/utils/vector3.lua b/worldeditadditions_core/utils/vector3.lua index be0c92f..6f69ce7 100644 --- a/worldeditadditions_core/utils/vector3.lua +++ b/worldeditadditions_core/utils/vector3.lua @@ -126,7 +126,6 @@ function Vector3.round(a) end --- Rounds the components of this vector to the specified number of decimal places. --- TODO: Document this. -- @param a Vector3 The vector to round. -- @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. @@ -419,13 +418,13 @@ end -- 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 -- @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 {Vector3} point 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 {Number} x 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 {Number} z Rotate this much around the Z axis (xy plane), in radians. --- @return {Vector3} The rotated point. +-- @param origin Vector3 The origin point to rotate around +-- @param point Vector3 The point to rotate. +-- @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 x number Rotate this much around the X axis (yz plane), in radians. +-- @param y number Rotate this much around the Y axis (xz plane), in radians. +-- @param z number Rotate this much around the Z axis (xy plane), in radians. +-- @return Vector3 The rotated point. function Vector3.rotate3d(origin, point, rotate) local point_norm = point - origin