@quenty/vector3utils 3.1.2-canary.c50dead.0 → 3.2.1

package/CHANGELOG.md

@@ -3,12 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [3.1.2-canary.c50dead.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/vector3utils@3.1.1...@quenty/vector3utils@3.1.2-canary.c50dead.0) (2021-11-20)
+## [3.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/vector3utils@3.2.0...@quenty/vector3utils@3.2.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/vector3utils
+
+
+
+
+
+# [3.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/vector3utils@3.1.1...@quenty/vector3utils@3.2.0) (2021-11-20)
 
 
 ### Bug Fixes
 
-* Support MacOS syncing ([c50dead](https://github.com/Quenty/NevermoreEngine/commit/c50deadbe5ebe479aded04e1619441a08ff0e9a8))
+* Support MacOS syncing ([#225](https://github.com/Quenty/NevermoreEngine/issues/225)) ([03f9183](https://github.com/Quenty/NevermoreEngine/commit/03f918392c6a5bdd33f8a17c38de371d1e06c67a))
 
 
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 Quenty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,10 +1,10 @@
 ## Vector3Utils
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
@@ -13,6 +13,8 @@
 
 Utilities involving Vector3 objects in Roblox
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/Vector3Utils">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/vector3utils --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/vector3utils",
-  "version": "3.1.2-canary.c50dead.0",
+  "version": "3.2.1",
   "description": "Utilities involving Vector3 objects in Roblox",
   "keywords": [
     "Roblox",
@@ -25,11 +25,11 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "3.1.1",
-    "@quenty/math": "2.0.0"
+    "@quenty/loader": "^3.1.2",
+    "@quenty/math": "^2.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c50deadbe5ebe479aded04e1619441a08ff0e9a8"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Shared/RandomVector3Utils.lua

@@ -1,10 +1,14 @@
----
--- @module RandomVector3Utils
--- @author Quenty
+--[=[
+	Utility functions involving RandomVector3Utils
+	@class RandomVector3Utils
+]=]
 
 local RandomVector3Utils = {}
 
---- Equal distribution unit vectors around a sphere
+--[=[
+	Equal distribution unit vectors around a sphere
+	@return Vector3
+]=]
 function RandomVector3Utils.getRandomUnitVector()
 	local s = 2*(math.random()-0.5)
 	local t = 6.2831853071796*math.random()
@@ -12,7 +16,7 @@ function RandomVector3Utils.getRandomUnitVector()
 	local m = (1-s*s)^0.5
 	local ry = m*math.cos(t)
 	local rz = m*math.sin(t)
-	return Vector3.new(rx,ry,rz)
+	return Vector3.new(rx, ry, rz)
 end
 
 return RandomVector3Utils

package/src/Shared/Vector3Utils.lua

@@ -1,5 +1,7 @@
---- Utilities involving Vector3 objects in Roblox
--- @module Vector3Utils
+--[=[
+	Utilities involving Vector3 objects in Roblox
+	@class Vector3Utils
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -7,14 +9,30 @@ local Math = require("Math")
 
 local Vector3Utils = {}
 
+--[=[
+	Creates a Vector3 from a Vector2 in the XY plane
+	@param vector2 Vector2
+	@return Vector3
+]=]
 function Vector3Utils.fromVector2XY(vector2)
 	return Vector3.new(vector2.x, vector2.y, 0)
 end
 
+--[=[
+	Creates a Vector3 from a Vector2 in the XZ plane
+	@param vector2 Vector2
+	@return Vector3
+]=]
 function Vector3Utils.fromVector2XZ(vector2)
 	return Vector3.new(vector2.x, 0, vector2.y)
 end
 
+--[=[
+	Computes the angle between 2 vectors in radians
+	@param a Vector3
+	@param b Vector3
+	@return number?
+]=]
 function Vector3Utils.getAngleRad(a, b)
 	if a.magnitude == 0 then
 		return nil
@@ -23,12 +41,24 @@ function Vector3Utils.getAngleRad(a, b)
 	return math.acos(a:Dot(b))
 end
 
+--[=[
+	Computes the angle between 2 vectors
+	@param a Vector3
+	@param b Vector3
+	@return number
+]=]
 function Vector3Utils.angleBetweenVectors(a, b)
 	local u = b.magnitude*a
 	local v = a.magnitude*b
 	return 2*math.atan2((v - u).magnitude, (u + v).magnitude)
 end
 
+--[=[
+	Rounds the vector to the nearest number
+	@param vector3 Vector3
+	@param amount number
+	@return Vector3
+]=]
 function Vector3Utils.round(vector3, amount)
 	return Vector3.new(Math.round(vector3.x, amount), Math.round(vector3.y, amount), Math.round(vector3.z, amount))
 end