@quenty/acceltween 2.5.0 → 2.5.1

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/acceltween@2.5.0...@quenty/acceltween@2.5.1) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [2.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/acceltween@2.4.0...@quenty/acceltween@2.5.0) (2024-09-12)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/acceltween",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "description": "AccelTween implementation for Roblox",
   "keywords": [
     "Roblox",
@@ -28,5 +28,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "fb172906f3ee725269ec1e5f4daf9dca227e729d"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/AccelTween.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Provides a means to, with both a continuous position and velocity,
 	accelerate from its current position to a target position in minimum time
@@ -9,6 +10,63 @@
 
 local AccelTween = {}
 
+export type AccelTween = typeof(setmetatable(
+	{} :: {
+		--[=[
+			Gets and sets the current position of the AccelTween
+			@prop p number
+			@within AccelTween
+		]=]
+		p: number,
+
+		--[=[
+			Gets and sets the current velocity of the AccelTween
+			@prop v number
+			@within AccelTween
+		]=]
+		v: number,
+
+		--[=[
+			Gets and sets the maximum acceleration.
+			@prop a number
+			@within AccelTween
+		]=]
+		a: number,
+
+		--[=[
+			Gets and sets the target position.
+			@prop t number
+			@within AccelTween
+		]=]
+		t: number,
+
+		--[=[
+			Returns the remaining time before the AccelTween attains the target.
+			@readonly
+			@prop rtime number
+			@within AccelTween
+		]=]
+		rtime: number,
+
+		--[=[
+			Sets the current and target position, and sets the velocity to 0.
+			@prop pt number
+			@within AccelTween
+		]=]
+		pt: number,
+
+		-- Internal
+		_accel: number,
+		_t0: number,
+		_y0: number,
+		_a0: number,
+		_t1: number,
+		_y1: number,
+		_a1: number,
+	},
+	{ __index = AccelTween }
+))
+
 --[=[
 	Constructs a new AccelTween.
 
@@ -27,57 +85,20 @@ local AccelTween = {}
 	@param maxaccel number? -- The maximum acceleration applied to reach its target. Defaults to 1
 	@return AccelTween
 ]=]
-function AccelTween.new(maxaccel)
+function AccelTween.new(maxaccel: number?): AccelTween
 	local self = setmetatable({
-		_accel = maxaccel or 1;
-		_t0 = 0;
-		_y0 = 0;
-		_a0 = 0;
-		_t1 = 0;
-		_y1 = 0;
-		_a1 = 0;
+		_accel = maxaccel or 1,
+		_t0 = 0,
+		_y0 = 0,
+		_a0 = 0,
+		_t1 = 0,
+		_y1 = 0,
+		_a1 = 0,
 	}, AccelTween)
 
-	return self
+	return self :: any
 end
 
---[=[
-	Gets and sets the current position of the AccelTween
-	@prop p number
-	@within AccelTween
-]=]
-
---[=[
-	Gets and sets the current velocity of the AccelTween
-	@prop v number
-	@within AccelTween
-]=]
-
---[=[
-	Gets and sets the maximum acceleration.
-	@prop a number
-	@within AccelTween
-]=]
-
---[=[
-	Gets and sets the target position.
-	@prop t number
-	@within AccelTween
-]=]
-
---[=[
-	Returns the remaining time before the AccelTween attains the target.
-	@readonly
-	@prop rtime number
-	@within AccelTween
-]=]
-
---[=[
-	Sets the current and target position, and sets the velocity to 0.
-	@prop pt number
-	@within AccelTween
-]=]
-
 function AccelTween:__index(index)
 	if AccelTween[index] then
 		return AccelTween[index]
@@ -116,12 +137,12 @@ function AccelTween:__newindex(index, value)
 end
 
 function AccelTween:_getstate(time)
-	if time < (self._t0 + self._t1)/2 then
+	if time < (self._t0 + self._t1) / 2 then
 		local t = time - self._t0
-		return self._y0 + t*t/2*self._a0, t*self._a0
+		return self._y0 + t * t / 2 * self._a0, t * self._a0
 	elseif time < self._t1 then
 		local t = time - self._t1
-		return self._y1 + t*t/2*self._a1, t*self._a1
+		return self._y1 + t * t / 2 * self._a1, t * self._a1
 	else
 		return self._y1, 0
 	end
@@ -135,26 +156,26 @@ function AccelTween:_setstate(newpos, newvel, newaccel, newtarg)
 	self._accel = newaccel or self._accel
 	local targ = newtarg or self._y1
 
-	if self._accel*self._accel < 1e-8 then
+	if self._accel * self._accel < 1e-8 then
 		self._t0, self._y0, self._a0 = 0, pos, 0
 		self._t1, self._y1, self._a1 = math.huge, targ, 0
 	else
 		local conda = targ < pos
 		local condb = vel < 0
-		local condc = pos - vel*vel/(2*self._accel) < targ
-		local condd = pos + vel*vel/(2*self._accel) < targ
+		local condc = pos - vel * vel / (2 * self._accel) < targ
+		local condd = pos + vel * vel / (2 * self._accel) < targ
 		if conda and condb and condc or not conda and (condb or not condb and condd) then
 			self._a0 = self._accel
-			self._t1 = time + ((2*vel*vel + 4*self._accel*(targ - pos))^0.5 - vel)/self._accel
+			self._t1 = time + ((2 * vel * vel + 4 * self._accel * (targ - pos)) ^ 0.5 - vel) / self._accel
 		else
 			self._a0 = -self._accel
-			self._t1 = time + ((2*vel*vel - 4*self._accel*(targ - pos))^0.5 + vel)/self._accel
+			self._t1 = time + ((2 * vel * vel - 4 * self._accel * (targ - pos)) ^ 0.5 + vel) / self._accel
 		end
-		self._t0 = time - vel/self._a0
-		self._y0 = pos - vel*vel/(2*self._a0)
+		self._t0 = time - vel / self._a0
+		self._y0 = pos - vel * vel / (2 * self._a0)
 		self._y1 = targ
 		self._a1 = -self._a0
 	end
 end
 
-return AccelTween
+return AccelTween