@quenty/camera 4.4.0 → 5.0.1-canary.238.2c4d310.0

package/src/Client/Effects/FadeBetween/FadeBetweenCamera.lua

@@ -1,5 +1,7 @@
---- Add another layer of effects that can be faded in/out
--- @classmod FadeBetweenCamera
+--[=[
+	Add another layer of effects that can be faded in/out
+	@class FadeBetweenCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -12,6 +14,11 @@ local CubicSplineUtils = require("CubicSplineUtils")
 local FadeBetweenCamera = {}
 FadeBetweenCamera.ClassName = "FadeBetweenCamera"
 
+--[=[
+	@param cameraA CameraLike
+	@param cameraB CameraLike
+	@return FadeBetweenCamera
+]=]
 function FadeBetweenCamera.new(cameraA, cameraB)
 	local self = setmetatable({
 		_spring = Spring.new(0);
@@ -47,6 +54,12 @@ function FadeBetweenCamera:__newindex(index, value)
 	end
 end
 
+--[=[
+	The current state.
+	@readonly
+	@prop CameraState CameraState
+	@within FadeBetweenCamera
+]=]
 function FadeBetweenCamera:__index(index)
 	if index == "CameraState" then
 		local _, t = SpringUtils.animating(self._spring)

package/src/Client/Effects/FadeBetween/FadeBetweenCamera2.lua

@@ -1,6 +1,6 @@
----
--- @classmod FadeBetweenCamera2
--- @author Quenty
+--[=[
+	@class FadeBetweenCamera2
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -11,6 +11,11 @@ local FadeBetweenCamera2 = {}
 FadeBetweenCamera2.ClassName = "FadeBetweenCamera2"
 FadeBetweenCamera2.__index = FadeBetweenCamera2
 
+--[=[
+	@param cameraA CameraLike
+	@param cameraB CameraLike
+	@return FadeBetweenCamera2
+]=]
 function FadeBetweenCamera2.new(cameraA, cameraB)
 	local self = setmetatable({
 		CameraA = cameraA or error("No cameraA");
@@ -61,6 +66,12 @@ function FadeBetweenCamera2:__newindex(index, value)
 	end
 end
 
+--[=[
+	The current state.
+	@readonly
+	@prop CameraState CameraState
+	@within FadeBetweenCamera2
+]=]
 function FadeBetweenCamera2:__index(index)
 	if index == "CameraState" then
 		local state, _ = self:_computeCameraState(self:_computeDoneProportion(os.clock()))

package/src/Client/Effects/FadeBetween/FadeBetweenCamera3.lua

@@ -1,5 +1,7 @@
---- Add another layer of effects that can be faded in/out
--- @classmod FadeBetweenCamera3
+--[=[
+	Add another layer of effects that can be faded in/out
+	@class FadeBetweenCamera3
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -15,6 +17,11 @@ local CubicSplineUtils = require("CubicSplineUtils")
 local FadeBetweenCamera3 = {}
 FadeBetweenCamera3.ClassName = "FadeBetweenCamera3"
 
+--[=[
+	@param cameraA CameraLike
+	@param cameraB CameraLike
+	@return FadeBetweenCamera3
+]=]
 function FadeBetweenCamera3.new(cameraA, cameraB)
 	local self = setmetatable({
 		_spring = Spring.new(0);
@@ -50,6 +57,12 @@ function FadeBetweenCamera3:__newindex(index, value)
 	end
 end
 
+--[=[
+	The current state.
+	@readonly
+	@prop CameraState CameraState
+	@within FadeBetweenCamera3
+]=]
 function FadeBetweenCamera3:__index(index)
 	if index == "CameraState" then
 		local _, t = SpringUtils.animating(self._spring)

package/src/Client/Effects/FadeBetween/FadeBetweenCamera4.lua

@@ -1,6 +1,6 @@
----
--- @classmod FadeBetweenCamera4
--- @author Quenty
+--[=[
+	@class FadeBetweenCamera4
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -13,6 +13,11 @@ local FadeBetweenCamera4 = {}
 FadeBetweenCamera4.ClassName = "FadeBetweenCamera4"
 FadeBetweenCamera4.__index = FadeBetweenCamera4
 
+--[=[
+	@param cameraA CameraLike
+	@param cameraB CameraLike
+	@return FadeBetweenCamera4
+]=]
 function FadeBetweenCamera4.new(cameraA, cameraB)
 	local self = setmetatable({
 		CameraA = cameraA or error("No cameraA");
@@ -57,6 +62,12 @@ function FadeBetweenCamera4:__newindex(index, value)
 	end
 end
 
+--[=[
+	The current state.
+	@readonly
+	@prop CameraState CameraState
+	@within FadeBetweenCamera4
+]=]
 function FadeBetweenCamera4:__index(index)
 	if index == "CameraState" then
 		local _, value = SpringUtils.animating(self._spring)

package/src/Client/Effects/FadingCamera.lua

@@ -1,5 +1,7 @@
---- Add another layer of effects that can be faded in/out
--- @classmod FadingCamera
+--[=[
+	Add another layer of effects that can be faded in/out
+	@class FadingCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -9,6 +11,9 @@ local SummedCamera = require("SummedCamera")
 local FadingCamera = {}
 FadingCamera.ClassName = "FadingCamera"
 
+--[=[
+	@param camera CameraEffect
+]=]
 function FadingCamera.new(camera)
 	local self = setmetatable({}, FadingCamera)
 
@@ -41,6 +46,12 @@ function FadingCamera:__newindex(index, value)
 	end
 end
 
+--[=[
+	The current state.
+	@readonly
+	@prop CameraState CameraState
+	@within FadingCamera
+]=]
 function FadingCamera:__index(index)
 	if index == "CameraState" then
 		return (self.Camera.CameraState or self.Camera) * self.Spring.Value

package/src/Client/Effects/HeartbeatCamera.lua

@@ -1,7 +1,10 @@
--- Update on heartbeat, must GC this camera state, unlike others. This
--- allows for camera effects to run on heartbeat and cache information once instead
--- of potentially going deeep into a tree and getting invoked multiple times
--- @classmod HeartbeatCamera
+--[=[
+	Update on heartbeat, must GC this camera state, unlike others. This
+	allows for camera effects to run on heartbeat and cache information once instead
+	of potentially going deeep into a tree and getting invoked multiple times
+
+	@class HeartbeatCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -38,6 +41,12 @@ function HeartbeatCamera:ForceUpdateCache()
 	self._currentStateCache = self._camera.CameraState
 end
 
+--[=[
+	The current state.
+	@readonly
+	@prop CameraState CameraState
+	@within DefaultCamera
+]=]
 function HeartbeatCamera:__index(index)
 	if index == "CameraState" then
 		return self._currentStateCache

package/src/Client/Effects/ImpulseCamera.lua

@@ -1,6 +1,9 @@
---- Add another layer of effects over any other camera by allowing an "impulse"
--- to be applied. Good for shockwaves, camera shake, and recoil
--- @classmod ImpulseCamera
+--[=[
+	Add another layer of effects over any other camera by allowing an "impulse"
+	to be applied. Good for shockwaves, camera shake, and recoil.
+
+	@class ImpulseCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -22,6 +25,10 @@ function ImpulseCamera.new()
 	return self
 end
 
+--[=[
+	Applies an impulse to the camera, shaking it!
+	@param velocity Vector3
+]=]
 function ImpulseCamera:Impulse(velocity)
 	assert(typeof(velocity) == "Vector3", "Bad velocity")
 
@@ -44,6 +51,12 @@ function ImpulseCamera:__newindex(index, value)
 	end
 end
 
+--[=[
+	The current state.
+	@readonly
+	@prop CameraState CameraState
+	@within DefaultCamera
+]=]
 function ImpulseCamera:__index(index)
 	if index == "CameraState" then
 		local newState = CameraState.new()

package/src/Client/Effects/InverseFader.lua

@@ -1,5 +1,7 @@
---- Be the inverse of a fading camera (makes scaling in cameras easy).
--- @classmod InverseFader
+--[=[
+	Be the inverse of a fading camera (makes scaling in cameras easy).
+	@class InverseFader
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Client/Effects/LagPointCamera.lua

@@ -1,5 +1,7 @@
---- Point a current element but lag behind for a smoother experience
--- @classmod LagPointCamera
+--[=[
+	Point a current element but lag behind for a smoother experience
+	@class LagPointCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -12,7 +14,7 @@ LagPointCamera.ClassName = "LagPointCamera"
 LagPointCamera._FocusCamera = nil
 LagPointCamera._OriginCamera = nil
 
----
+--
 -- @constructor
 -- @param originCamera A camera to use
 -- @param focusCamera The Camera to look at.

package/src/Client/Effects/PointCamera.lua

@@ -1,5 +1,7 @@
---- Point a current element
--- @classmod PointCamera
+--[=[
+	Point a current element
+	@class PointCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -9,10 +11,12 @@ local SummedCamera = require("SummedCamera")
 local PointCamera = {}
 PointCamera.ClassName = "PointCamera"
 
---- Initializes a new PointCamera
--- @constructor
--- @param originCamera A camera to use
--- @param focusCamera The Camera to look at.
+--[=[
+	Initializes a new PointCamera
+
+	@param originCamera Camera -- A camera to use
+	@param focusCamera Camera -- The Camera to look at.
+]=]
 function PointCamera.new(originCamera, focusCamera)
 	local self = setmetatable({}, PointCamera)
 

package/src/Client/Effects/PushCamera.lua

@@ -1,6 +1,9 @@
---- Like a rotated camera, except we end up pushing back to a default rotation.
--- This same behavior is seen in Roblox vehicle seats
--- @classmod PushCamera
+--[=[
+	Like a rotated camera, except we end up pushing back to a default rotation.
+	This same behavior is seen in Roblox vehicle seats
+
+	@class PushCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -22,6 +25,10 @@ PushCamera.DefaultAngleXZ0 = 0
 PushCamera._lastUpdateTime = -1
 PushCamera.PushBackAfter = 0.5
 
+--[=[
+	Constructs a new PushCamera
+	@return PushCamera
+]=]
 function PushCamera.new()
 	local self = setmetatable({}, PushCamera)
 
@@ -31,18 +38,24 @@ end
 function PushCamera:__add(other)
 	return SummedCamera.new(self, other)
 end
----
+
 -- @param xzrotVector Vector2, the delta rotation to apply
 function PushCamera:RotateXY(xzrotVector)
 	self.AngleX = self.AngleX + xzrotVector.x
 	self.AngleY = self.AngleY + xzrotVector.y
 end
 
+--[=[
+	Prevents the rotation back. You need to call this
+	every frame you want to prevent rotation.
+]=]
 function PushCamera:StopRotateBack()
 	self.CFrame = self.CFrame
 end
 
---- Resets to default position automatically
+--[=[
+	Resets to default position automatically
+]=]
 function PushCamera:Reset()
 	self.LastUpdateTime = 0
 end
@@ -82,6 +95,12 @@ function PushCamera:__newindex(index, value)
 	end
 end
 
+--[=[
+	The current state.
+	@readonly
+	@prop CameraState CameraState
+	@within PushCamera
+]=]
 function PushCamera:__index(index)
 	if index == "CameraState" then
 		local state = CameraState.new()

package/src/Client/Effects/RotatedCamera.lua

@@ -1,7 +1,10 @@
---- Allow freedom of movement around a current place, much like the classic script works now.
--- Not intended to be use with the current character script. This is the rotation component.
--- Intended to be used with a SummedCamera, relative.
--- @classmod RotatedCamera
+--[=[
+	Allow freedom of movement around a current place, much like the classic script works now.
+	Not intended to be use with the current character script. This is the rotation component.
+	Intended to be used with a SummedCamera, relative.
+
+	@class RotatedCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -18,6 +21,10 @@ RotatedCamera._minY = math.rad(-80)
 RotatedCamera._angleXZ = 0
 RotatedCamera._angleY = 0
 
+--[=[
+	Constructs a new RotatedCamera
+	@return RotatedCamera
+]=]
 function RotatedCamera.new()
 	local self = setmetatable({}, RotatedCamera)
 
@@ -28,7 +35,6 @@ function RotatedCamera:__add(other)
 	return SummedCamera.new(self, other)
 end
 
----
 -- @param xzrotvector Vector2, the delta rotation to apply
 function RotatedCamera:RotateXY(xzrotvector)
 	self.AngleX = self.AngleX + xzrotvector.x
@@ -61,6 +67,12 @@ function RotatedCamera:__newindex(index, value)
 	end
 end
 
+--[=[
+	The current state.
+	@readonly
+	@prop CameraState CameraState
+	@within RotatedCamera
+]=]
 function RotatedCamera:__index(index)
 	if index == "CameraState" then
 		local state = CameraState.new()

package/src/Client/Effects/SmoothPositionCamera.lua

@@ -1,5 +1,7 @@
---- Lags the camera smoothly behind the position maintaining other components
--- @classmod SmoothPositionCamera
+--[=[
+	Lags the camera smoothly behind the position maintaining other components
+	@class SmoothPositionCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Client/Effects/SmoothRotatedCamera.lua

@@ -1,7 +1,10 @@
---- Allow freedom of movement around a current place, much like the classic script works now.
--- Not intended to be use with the current character script. This is the rotation component.
--- Intended to be used with a SummedCamera, relative.
--- @classmod SmoothRotatedCamera
+--[=[
+	Allow freedom of movement around a current place, much like the classic script works now.
+	Not intended to be use with the current character script. This is the rotation component.
+	Intended to be used with a SummedCamera, relative.
+
+	@class SmoothRotatedCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -32,7 +35,6 @@ function SmoothRotatedCamera:__add(other)
 	return SummedCamera.new(self, other)
 end
 
----
 -- @param xyRotateVector Vector2, the delta rotation to apply
 function SmoothRotatedCamera:RotateXY(xyRotateVector)
 	self.AngleX = self.AngleX + xyRotateVector.x

package/src/Client/Effects/SmoothZoomedCamera.lua

@@ -1,7 +1,10 @@
---- Allow freedom of movement around a current place, much like the classic script works now.
--- Not intended to be use with the current character script
--- Intended to be used with a SummedCamera, relative.
--- @classmod SmoothZoomedCamera
+--[=[
+	Allow freedom of movement around a current place, much like the classic script works now.
+	Not intended to be use with the current character script
+	Intended to be used with a SummedCamera, relative.
+
+	@class SmoothZoomedCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Client/Effects/SummedCamera.lua

@@ -1,5 +1,7 @@
---- Add two cameras together
--- @classmod SummedCamera
+--[=[
+	Add two cameras together
+	@class SummedCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -10,10 +12,13 @@ local CameraFrame = require("CameraFrame")
 local SummedCamera = {}
 SummedCamera.ClassName = "SummedCamera"
 
---- Construct a new summed camera
--- @constructor
--- @param cameraA A CameraState or another CameraEffect to be used
--- @param cameraB A CameraState or another CameraEffect to be used
+--[=[
+	Construct a new summed camera
+
+	@param cameraA CameraEffect -- A CameraState or another CameraEffect to be used
+	@param cameraB CameraEffect -- A CameraState or another CameraEffect to be used
+	@return SummedCamera
+]=]
 function SummedCamera.new(cameraA, cameraB)
 	local self = setmetatable({}, SummedCamera)
 
@@ -24,10 +29,13 @@ function SummedCamera.new(cameraA, cameraB)
 	return self
 end
 
----
--- @param mode Mode to set
--- If "World", then it just adds positions.
--- If "Relative", then it moves position relative to cameraA's CFrame.
+--[=[
+	Sets the summation mode. If "World", then it just adds positions.
+	If "Relative", then it moves position relative to cameraA's CFrame.
+
+	@param mode "World" | "Relative" -- Mode to set
+	@return SummedCamera
+]=]
 function SummedCamera:SetMode(mode)
 	assert(mode == "World" or mode == "Relative", "Bad mode")
 	self._mode = mode

package/src/Client/Effects/TrackCamera.lua

@@ -1,5 +1,7 @@
---- Track a current part, whether it be a model or part
--- @classmod TrackCamera
+--[=[
+	Track a current part, whether it be a model or part
+	@class TrackCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -10,9 +12,12 @@ local TrackCamera = {}
 TrackCamera.ClassName = "TrackCamera"
 TrackCamera.FieldOfView = 0
 
---- Make new track camera
--- @constructor
--- @param[opt] cameraSubject The CameraSubject to look at. A Roblox part of Roblox model
+--[=[
+	Constructs a new TrackCamera
+
+	@param cameraSubject Instance? -- The CameraSubject to look at. A Roblox part of Roblox model
+	@return TrackCamera
+]=]
 function TrackCamera.new(cameraSubject)
 	local self = setmetatable({}, TrackCamera)
 
@@ -39,9 +44,25 @@ function TrackCamera:__newindex(index, value)
 	end
 end
 
+--[=[
+	The current state.
+	@readonly
+	@prop CameraState CameraState
+	@within TrackCamera
+]=]
+--[=[
+	The current field of view.
+	@prop FieldOfView number
+	@within TrackCamera
+]=]
+--[=[
+	The current field of view.
+	@prop CameraSubject Instance
+	@within TrackCamera
+]=]
+
 function TrackCamera:__index(index)
 	if index == "CameraState" then
-
 		local state = CameraState.new()
 		state.FieldOfView = self.FieldOfView
 

package/src/Client/Effects/XZPlaneLockCamera.lua

@@ -1,5 +1,7 @@
---- Lock camera to only XZPlane, preventing TrackerCameras from making players sick.
--- @classmod XZPlaneLockCamera
+--[=[
+	Lock camera to only XZPlane, preventing TrackerCameras from making players sick.
+	@class XZPlaneLockCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Client/Effects/ZoomedCamera.lua

@@ -1,13 +1,19 @@
---- Allow freedom of movement around a current place, much like the classic script works now.
--- Not intended to be use with the current character script
--- Intended to be used with a SummedCamera, relative.
--- @classmod ZoomedCamera
--- @usage
--- local Zoom = ZoomedCamera.new()
--- Zoom.Zoom = 30 -- Distance from original point
--- Zoom.MaxZoom = 100 -- max distance away
--- Zoom.MinZoom = 0.5 -- min distance away
--- Assigning .Zoom will automatically clamp
+--[=[
+	Allow freedom of movement around a current place, much like the classic script works now.
+	Not intended to be use with the current character script
+	Intended to be used with a SummedCamera, relative.
+
+	```lua
+	local zoom = ZoomedCamera.new()
+	zoom.Zoom = 30 -- Distance from original point
+	zoom.MaxZoom = 100 -- max distance away
+	zoom.MinZoom = 0.5 -- min distance away
+	```
+
+	Assigning .Zoom will automatically clamp
+
+	@class ZoomedCamera
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Client/Input/CameraInputUtils.lua

@@ -1,6 +1,6 @@
----
--- @module CameraInputUtils
--- @author Quenty
+--[=[
+	@class CameraInputUtils
+]=]
 
 local UserGameSettings = UserSettings():GetService("UserGameSettings")
 local Workspace = game:GetService("Workspace")

package/src/Client/Input/CameraTouchInputUtils.lua

@@ -1,6 +1,7 @@
----
--- @module CameraTouchInputUtils
--- @author Quenty
+--[=[
+	Utility methods involving touch input and cameras.
+	@class CameraTouchInputUtils
+]=]
 
 local CameraTouchInputUtils = {}
 
@@ -15,8 +16,15 @@ local TOUCH_ADJUST_AREA_DOWN = math.rad(-15)
 local TOUCH_SENSITIVTY_ADJUST_MAX_Y = 2.1
 local TOUCH_SENSITIVTY_ADJUST_MIN_Y = 0.5
 
---- Adjusts the camera Y touch Sensitivity when moving away from the center and in the TOUCH_SENSITIVTY_ADJUST_AREA
--- Straight from Roblox's code
+--[=[
+	Adjusts the camera Y touch Sensitivity when moving away from the center and in the TOUCH_SENSITIVTY_ADJUST_AREA
+	Straight from Roblox's code
+
+	@param currPitchAngle number
+	@param sensitivity Vector2
+	@param delta Vector2
+	Return Vector2
+]=]
 function CameraTouchInputUtils.adjustTouchSensitivity(currPitchAngle, sensitivity, delta)
 	local multiplierY = TOUCH_SENSITIVTY_ADJUST_MAX_Y
 	if currPitchAngle > TOUCH_ADJUST_AREA_UP and delta.Y < 0 then