@quenty/camera 9.5.0 → 9.6.0

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.
 
+# [9.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camera@9.5.0...@quenty/camera@9.6.0) (2022-12-06)
+
+
+### Features
+
+* Add :SetAcceleration(acceleration) on GamepadRotateModel to allow for a more linear control of the camera ([3aec535](https://github.com/Quenty/NevermoreEngine/commit/3aec535dc88ed97ff4762e4b50d6e46d4c6c6ecb))
+
+
+
+
+
 # [9.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camera@9.4.0...@quenty/camera@9.5.0) (2022-11-19)
 
 **Note:** Version bump only for package @quenty/camera

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/camera",
-  "version": "9.5.0",
+  "version": "9.6.0",
   "description": "Quenty's camera system for Roblox",
   "keywords": [
     "Roblox",
@@ -27,14 +27,14 @@
   "dependencies": {
     "@quenty/acceltween": "^2.2.1",
     "@quenty/baseobject": "^6.0.1",
-    "@quenty/cframeutils": "^5.0.0",
+    "@quenty/cframeutils": "^5.1.0",
     "@quenty/cubicspline": "^6.0.1",
     "@quenty/inputobjectutils": "^4.0.0",
     "@quenty/loader": "^6.0.1",
     "@quenty/maid": "^2.4.0",
     "@quenty/math": "^2.2.0",
     "@quenty/qframe": "^6.1.1",
-    "@quenty/servicebag": "^6.3.0",
+    "@quenty/servicebag": "^6.4.0",
     "@quenty/spring": "^6.0.1"
   },
   "devDependencies": {
@@ -43,5 +43,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2114f42ae399a4417a3ebd4d35bf481690ca7923"
+  "gitHead": "d9b0d10faa443cc42a6c2ac966f2f56d124bbde5"
 }

package/src/Client/Controls/CameraControls.lua

@@ -66,6 +66,16 @@ function CameraControls.new(zoomCamera, rotatedCamera)
 	return self
 end
 
+--[=[
+	Sets the gamepad rotation acceleration
+	@param acceleration number
+]=]
+function CameraControls:SetGamepadRotationAcceleration(acceleration)
+	assert(type(acceleration) == "number", "Bad acceleration")
+
+	self._gamepadRotateModel:SetAcceleration(acceleration)
+end
+
 function CameraControls:GetKey()
 	return self._key
 end
@@ -74,6 +84,9 @@ function CameraControls:IsEnabled()
 	return self._enabled
 end
 
+--[=[
+	Enables the control.
+]=]
 function CameraControls:Enable()
 	if self._enabled then
 		return
@@ -119,6 +132,9 @@ function CameraControls:Enable()
 	end)
 end
 
+--[=[
+	Disables the control.
+]=]
 function CameraControls:Disable()
 	if not self._enabled then
 		return

package/src/Client/Controls/GamepadRotateModel.lua

@@ -1,5 +1,6 @@
 --[=[
-	Rotation model for gamepad controls
+	Rotation model for gamepad controls that uses Roblox's curve smoothing and other components.
+
 	@class GamepadRotateModel
 ]=]
 
@@ -13,6 +14,10 @@ local GamepadRotateModel = setmetatable({}, BaseObject)
 GamepadRotateModel.__index = GamepadRotateModel
 GamepadRotateModel.ClassName = "GamepadRotateModel"
 
+--[=[
+	Constructs a new GamepadRotateModel.
+	@return GamepadRotateModel
+]=]
 function GamepadRotateModel.new()
 	local self = setmetatable(BaseObject.new(), GamepadRotateModel)
 
@@ -26,6 +31,27 @@ function GamepadRotateModel.new()
 	return self
 end
 
+--[=[
+	Sets the acceleration for the game rotate model. The higher the acceleration
+	the more linear the gamepad rotate model feels.
+
+	:::tip
+	Set this to something high, like 2500, for an FPS. This makes control feel a lot better.
+	:::
+
+	@param acceleration number
+]=]
+function GamepadRotateModel:SetAcceleration(acceleration)
+	assert(type(acceleration) == "number", "Bad acceleration")
+
+	self._rampVelocityX.a = acceleration
+	self._rampVelocityY.a = acceleration
+end
+
+--[=[
+	Gets the delta for the thumbstick
+	@return Vector2
+]=]
 function GamepadRotateModel:GetThumbstickDeltaAngle()
 	if not self._lastInputObject then
 		return Vector2.new()
@@ -34,6 +60,9 @@ function GamepadRotateModel:GetThumbstickDeltaAngle()
 	return Vector2.new(self._rampVelocityX.p, self._rampVelocityY.p)
 end
 
+--[=[
+	Stops rotation
+]=]
 function GamepadRotateModel:StopRotate()
 	self._lastInputObject = nil
 	self._rampVelocityX.t = 0
@@ -45,6 +74,12 @@ function GamepadRotateModel:StopRotate()
 	self.IsRotating.Value = false
 end
 
+--[=[
+	Converts the thumbstick input into a smoothed delta based upon deadzone and other
+	components.
+
+	@param inputObject InputObject
+]=]
 function GamepadRotateModel:HandleThumbstickInput(inputObject)
 	if CameraGamepadInputUtils.outOfDeadZone(inputObject) then
 		self._lastInputObject = inputObject