@quenty/trajectory 2.0.0 → 2.0.1

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/trajectory@2.0.0...@quenty/trajectory@2.0.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/trajectory
+
+
+
+
+
 # [2.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/trajectory@1.2.0...@quenty/trajectory@2.0.0) (2021-09-05)
 
 

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 @@
 ## trajectory
 <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 @@
 
 Utility function for estimating low and high arcs of projectiles. Solves for bullet drop given. Returns two possible paths from origin to target where the magnitude of the initial velocity is initialVelocity.
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/trajectory">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/trajectory --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/trajectory",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Utility function for estimating low and high arcs of projectiles. Solves for bullet drop given",
   "keywords": [
     "Roblox",
@@ -28,5 +28,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c06170ec47b0d4520c587ce2e6404d14b5dbb851"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Shared/MinEntranceVelocityUtils.lua

@@ -1,12 +1,20 @@
----
--- @module MinEntranceVelocityUtils
--- @author Quenty, AxisAngle
+--[=[
+	Class of functions that can be used to minimize entrance velocity of a projectile.
+	@class MinEntranceVelocityUtils
+]=]
 
 local MinEntranceVelocityUtils = {}
 
 local SQRT_2 = math.sqrt(2)
 
---- Determines the starting velocity to minimize the velocity at the target for a parabula
+--[=[
+	Determines the starting velocity to minimize the velocity at the target for a parabula
+
+	@param origin Vector3
+	@param target Vector3
+	@param accel Vector3
+	@return number
+]=]
 function MinEntranceVelocityUtils.minimizeEntranceVelocity(origin, target, accel)
 	local offset = target - origin
 	local accelDist = accel.magnitude
@@ -20,13 +28,37 @@ function MinEntranceVelocityUtils.minimizeEntranceVelocity(origin, target, accel
 	return (accelDist*offset - accel*offsetDist) / lowerTerm
 end
 
--- NOTE: This may only works for a minimizeEntranceVelocity
+--[=[
+	Computes the velocity the target will enter the target
+
+	:::note
+	This may only works for a minimizeEntranceVelocity
+	:::
+
+	@param velocity Vector3
+	@param origin Vector3
+	@param target Vector3
+	@param accel Vector3
+	@return Vector3
+]=]
 function MinEntranceVelocityUtils.computeEntranceVelocity(velocity, origin, target, accel)
 	local entranceTime = MinEntranceVelocityUtils.computeEntranceTime(velocity, origin, target, accel)
 	return accel*entranceTime + velocity
 end
 
--- NOTE: This may only works for a minimizeEntranceVelocity
+--[=[
+	Computes the time stamp the project enters the target
+
+	:::note
+	This may only works for a minimizeEntranceVelocity
+	:::
+
+	@param velocity Vector3
+	@param origin Vector3
+	@param target Vector3
+	@param accel Vector3
+	@return number
+]=]
 function MinEntranceVelocityUtils.computeEntranceTime(velocity, origin, target, accel)
 	local offset = target - origin
 	local aa = accel:Dot(accel)

package/src/Shared/trajectory.lua

@@ -1,14 +1,22 @@
---- Utility function for estimating low and high arcs of projectiles. Solves for bullet
--- drop given
+--[=[
+	Utility function for estimating low and high arcs of projectiles. Solves for bullet
+	drop given
+	@class trajectory
+]=]
 
---- Returns two possible paths from origin to target where the magnitude of the initial velocity is initialVelocity
--- @tparam Vector3 origin Origin the the bullet
--- @tparam Vector3 target Target for the bullet
--- @tparam number initialVelocity Magnitude of the initial velocity
--- @tparam number gravityForce Force of the gravity
--- @treturn[opt] vector3 lowTrajectory Initial velocity for a low trajectory arc
--- @treturn[opt] vector3 highTrajectory Initial velocity for a high trajectory arc
--- @treturn[opt] vector3 fallbackTrajectory Trajectory directly at target as afallback
+--[=[
+	Returns two possible paths from origin to target where the magnitude of the initial velocity is initialVelocity
+
+	@function trajectory
+	@within trajectory
+	@param origin Vector3 -- Origin the the bullet
+	@param target Vector3 -- Target for the bullet
+	@param initialVelocity number -- Magnitude of the initial velocity
+	@param gravityForce number -- Force of the gravity
+	@return Vector3? -- lowTrajectory Initial velocity for a low trajectory arc
+	@return Vector3? -- highTrajectory Initial velocity for a high trajectory arc
+	@return Vector3? -- fallbackTrajectory Trajectory directly at target as afallback
+]=]
 return function(origin, target, initialVelocity, gravityForce)
 	local g = -gravityForce
 	local ox,oy,oz=origin.x,origin.y,origin.z