@quenty/camera 14.20.3 → 14.20.4-canary.11a5dcf.0

package/src/Client/Effects/SmoothPositionCamera.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Lags the camera smoothly behind the position maintaining other components
 	@class SmoothPositionCamera
@@ -5,17 +6,28 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local CameraState = require("CameraState")
-local SummedCamera = require("SummedCamera")
-local Spring = require("Spring")
+local CameraEffectUtils = require("CameraEffectUtils")
 local CameraFrame = require("CameraFrame")
+local CameraState = require("CameraState")
 local QFrame = require("QFrame")
+local Spring = require("Spring")
+local SummedCamera = require("SummedCamera")
 
 local SmoothPositionCamera = {}
 SmoothPositionCamera.ClassName = "SmoothPositionCamera"
 
-function SmoothPositionCamera.new(baseCamera)
-	local self = setmetatable({}, SmoothPositionCamera)
+export type SmoothPositionCamera = typeof(setmetatable(
+	{} :: {
+		CameraState: CameraState.CameraState,
+		Spring: Spring.Spring<Vector3>,
+		BaseCamera: CameraEffectUtils.CameraEffect,
+		Speed: number,
+	},
+	{} :: typeof({ __index = SmoothPositionCamera })
+)) & CameraEffectUtils.CameraEffect
+
+function SmoothPositionCamera.new(baseCamera): SmoothPositionCamera
+	local self: SmoothPositionCamera = setmetatable({} :: any, SmoothPositionCamera)
 
 	self.Spring = Spring.new(Vector3.zero)
 	self.BaseCamera = baseCamera or error("Must have BaseCamera")
@@ -50,12 +62,12 @@ function SmoothPositionCamera:__index(index)
 		local baseCameraFrame = baseCameraState.CameraFrame
 		local baseCameraFrameDerivative = baseCameraState.CameraFrameDerivative
 
-		local cameraFrame = CameraFrame.new(
-			QFrame.fromVector3(self.Position, baseCameraFrame.QFrame),
-			baseCameraFrame.FieldOfView)
+		local cameraFrame =
+			CameraFrame.new(QFrame.fromVector3(self.Position, baseCameraFrame.QFrame), baseCameraFrame.FieldOfView)
 		local cameraFrameDerivative = CameraFrame.new(
 			QFrame.fromVector3(self.Velocity, baseCameraFrameDerivative.QFrame),
-			baseCameraFrameDerivative.FieldOfView)
+			baseCameraFrameDerivative.FieldOfView
+		)
 
 		return CameraState.new(cameraFrame, cameraFrameDerivative)
 	elseif index == "Position" then
@@ -86,4 +98,4 @@ function SmoothPositionCamera:_internalUpdate()
 	end
 end
 
-return SmoothPositionCamera
+return SmoothPositionCamera

package/src/Client/Effects/SmoothRotatedCamera.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	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.
@@ -8,21 +9,48 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local CameraEffectUtils = require("CameraEffectUtils")
 local CameraState = require("CameraState")
-local getRotationInXZPlane = require("getRotationInXZPlane")
 local Spring = require("Spring")
 local SummedCamera = require("SummedCamera")
+local getRotationInXZPlane = require("getRotationInXZPlane")
 
 local SmoothRotatedCamera = {}
 SmoothRotatedCamera.ClassName = "SmoothRotatedCamera"
 
+export type SmoothRotatedCamera = typeof(setmetatable(
+	{} :: {
+		AngleX: number,
+		AngleXZ: number,
+		RenderAngleXZ: number,
+		AngleY: number,
+		CFrame: CFrame,
+		RenderAngleY: number,
+		CameraState: CameraState.CameraState,
+		MaxY: number,
+		MinY: number,
+		Rotation: CFrame,
+		Speed: number,
+		ZoomGiveY: number,
+		SpeedAngleX: number,
+		SpeedAngleY: number,
+		SpringX: Spring.Spring<number>,
+		SpringY: Spring.Spring<number>,
+		TargetAngleX: number,
+		TargetAngleXZ: number,
+		TargetAngleY: number,
+		TargetXZ: number,
+	},
+	{} :: typeof({ __index = SmoothRotatedCamera })
+)) & CameraEffectUtils.CameraEffect
+
 -- Max/Min aim up and down
 SmoothRotatedCamera._maxY = math.rad(80)
 SmoothRotatedCamera._minY = math.rad(-80)
 SmoothRotatedCamera._zoomGiveY = math.rad(5) -- Only on th
 
-function SmoothRotatedCamera.new()
-	local self = setmetatable({}, SmoothRotatedCamera)
+function SmoothRotatedCamera.new(): SmoothRotatedCamera
+	local self: SmoothRotatedCamera = setmetatable({} :: any, SmoothRotatedCamera)
 
 	self.SpringX = Spring.new(0)
 	self.SpringY = Spring.new(0)
@@ -31,37 +59,37 @@ function SmoothRotatedCamera.new()
 	return self
 end
 
-function SmoothRotatedCamera:__add(other)
+function SmoothRotatedCamera.__add(self: SmoothRotatedCamera, 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
-	self.AngleY = self.AngleY + xyRotateVector.y
+function SmoothRotatedCamera.RotateXY(self: SmoothRotatedCamera, xyRotateVector: Vector2)
+	self.AngleX = self.AngleX + xyRotateVector.X
+	self.AngleY = self.AngleY + xyRotateVector.Y
 	self.TargetAngleX = self.AngleX
 	self.TargetAngleY = self.AngleY
 end
 
-function SmoothRotatedCamera:__newindex(index, value)
+function SmoothRotatedCamera.__newindex(self: SmoothRotatedCamera, index, value)
 	if index == "CFrame" then
 		local xzrot = getRotationInXZPlane(value)
-		self.AngleXZ = math.atan2(xzrot.lookVector.x, xzrot.lookVector.z) + math.pi
+		self.AngleXZ = math.atan2(xzrot.LookVector.X, xzrot.LookVector.Z) + math.pi
 
-		local yrot = xzrot:toObjectSpace(value).lookVector.y
+		local yrot = xzrot:ToObjectSpace(value).LookVector.Y
 		self.AngleY = math.asin(yrot)
 	elseif index == "TargetCFrame" then
 		local xzrot = getRotationInXZPlane(value)
-		self.TargetAngleXZ = math.atan2(xzrot.lookVector.x, xzrot.lookVector.z) + math.pi
+		self.TargetAngleXZ = math.atan2(xzrot.LookVector.X, xzrot.LookVector.Z) + math.pi
 
-		local yrot = xzrot:toObjectSpace(value).lookVector.y
+		local yrot = xzrot:ToObjectSpace(value).LookVector.Y
 		self.TargetAngleY = math.asin(yrot)
 	elseif index == "AngleY" then
-		self.SpringY.Value = value
+		self.SpringY.Position = value
 	elseif index == "AngleX" or index == "AngleXZ" then
-		self.SpringX.Value = value
+		self.SpringX.Position = value
 	elseif index == "TargetAngleY" then
 		self.SpringY.Target = value
 	elseif index == "TargetAngleX" or index == "TargetAngleXZ" then
@@ -84,15 +112,15 @@ function SmoothRotatedCamera:__newindex(index, value)
 	elseif SmoothRotatedCamera[index] ~= nil or index == "SpringX" or index == "SpringY" then
 		rawset(self, index, value)
 	else
-		error(index .. " is not a valid member or SmoothRotatedCamera")
+		error(tostring(index) .. " is not a valid member or SmoothRotatedCamera")
 	end
 end
 
-function SmoothRotatedCamera:SnapIntoBounds()
+function SmoothRotatedCamera.SnapIntoBounds(self: SmoothRotatedCamera)
 	self.TargetAngleY = math.clamp(self.TargetAngleY, self.MinY, self.MaxY)
 end
 
-function SmoothRotatedCamera:GetPastBounds(angle)
+function SmoothRotatedCamera.GetPastBounds(self: SmoothRotatedCamera, angle)
 	if angle < self.MinY then
 		return angle - self.MinY
 	elseif angle > self.MaxY then
@@ -102,13 +130,13 @@ function SmoothRotatedCamera:GetPastBounds(angle)
 	end
 end
 
-function SmoothRotatedCamera:__index(index)
+function SmoothRotatedCamera.__index(self: SmoothRotatedCamera, index)
 	if index == "CameraState" then
 		local state = CameraState.new()
 		state.CFrame = self.CFrame
 		return state
 	elseif index == "LookVector" then
-		return self.Rotation.lookVector
+		return self.Rotation.LookVector
 	elseif index == "CFrame" then
 		return CFrame.Angles(0, self.RenderAngleXZ, 0) * CFrame.Angles(self.RenderAngleY, 0, 0)
 	elseif index == "TargetCFrame" then
@@ -121,18 +149,18 @@ function SmoothRotatedCamera:__index(index)
 		local scale = (1 - 0.25 ^ math.abs(timesOverBounds))
 
 		if past < 0 then
-			return self.MinY - self.ZoomGiveY*scale
+			return self.MinY - self.ZoomGiveY * scale
 		elseif past > 0 then
-			return self.MaxY + self.ZoomGiveY*scale
+			return self.MaxY + self.ZoomGiveY * scale
 		else
 			return angle
 		end
 	elseif index == "RenderAngleX" or index == "RenderAngleXZ" then
 		return self.AngleX
 	elseif index == "AngleY" then
-		return self.SpringY.Value
+		return self.SpringY.Position
 	elseif index == "AngleX" or index == "AngleXZ" then
-		return self.SpringX.Value
+		return self.SpringX.Position
 	elseif index == "TargetAngleY" then
 		return self.SpringY.Target
 	elseif index == "TargetAngleX" or index == "TargetAngleXZ" then
@@ -150,4 +178,4 @@ function SmoothRotatedCamera:__index(index)
 	end
 end
 
-return SmoothRotatedCamera
+return SmoothRotatedCamera

package/src/Client/Effects/SmoothZoomedCamera.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	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
@@ -8,9 +9,10 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local CameraEffectUtils = require("CameraEffectUtils")
 local CameraState = require("CameraState")
-local SummedCamera = require("SummedCamera")
 local Spring = require("Spring")
+local SummedCamera = require("SummedCamera")
 
 local SmoothZoomedCamera = {}
 SmoothZoomedCamera.ClassName = "SmoothZoomedCamera"
@@ -18,8 +20,25 @@ SmoothZoomedCamera._maxZoom = 100
 SmoothZoomedCamera._minZoom = 0.5
 SmoothZoomedCamera.BounceAtEnd = true
 
-function SmoothZoomedCamera.new()
-	local self = setmetatable({}, SmoothZoomedCamera)
+export type SmoothZoomedCamera = typeof(setmetatable(
+	{} :: {
+		CameraState: CameraState.CameraState,
+		Zoom: number,
+		Speed: number,
+		Range: number,
+		MaxZoom: number,
+		MinZoom: number,
+		Target: number,
+		Value: number,
+		Velocity: number,
+		TargetZoom: number,
+		Spring: Spring.Spring<number>,
+	},
+	{} :: typeof({ __index = SmoothZoomedCamera })
+)) & CameraEffectUtils.CameraEffect
+
+function SmoothZoomedCamera.new(): SmoothZoomedCamera
+	local self: SmoothZoomedCamera = setmetatable({} :: any, SmoothZoomedCamera)
 
 	self.Spring = Spring.new(0)
 	self.Speed = 15
@@ -27,11 +46,11 @@ function SmoothZoomedCamera.new()
 	return self
 end
 
-function SmoothZoomedCamera:__add(other)
+function SmoothZoomedCamera.__add(self: SmoothZoomedCamera, other)
 	return SummedCamera.new(self, other)
 end
 
-function SmoothZoomedCamera:ZoomIn(value, min, max)
+function SmoothZoomedCamera.ZoomIn(self: SmoothZoomedCamera, value: number, min: number?, max: number?)
 	if min or max then
 		self.Zoom = self.Zoom - math.clamp(value, min or -math.huge, max or math.huge)
 	else
@@ -39,11 +58,11 @@ function SmoothZoomedCamera:ZoomIn(value, min, max)
 	end
 end
 
-function SmoothZoomedCamera:Impulse(value)
+function SmoothZoomedCamera.Impulse(self: SmoothZoomedCamera, value)
 	self.Spring:Impulse(value)
 end
 
-function SmoothZoomedCamera:__newindex(index, value)
+function SmoothZoomedCamera.__newindex(self: SmoothZoomedCamera, index, value)
 	if index == "TargetZoom" or index == "Target" then
 		local target = math.clamp(value, self.MinZoom, self.MaxZoom)
 		self.Spring.Target = target
@@ -56,9 +75,9 @@ function SmoothZoomedCamera:__newindex(index, value)
 			end
 		end
 	elseif index == "TargetPercentZoom" then
-		self.Target = self.MinZoom + self.Range*value
+		self.Target = self.MinZoom + self.Range * value
 	elseif index == "PercentZoom" then
-		self.Zoom = self.MinZoom + self.Range*value
+		self.Zoom = self.MinZoom + self.Range * value
 	elseif index == "Damper" then
 		self.Spring.Damper = value
 	elseif index == "Value" or index == "Zoom" then
@@ -78,13 +97,13 @@ function SmoothZoomedCamera:__newindex(index, value)
 	end
 end
 
-function SmoothZoomedCamera:__index(index)
+function SmoothZoomedCamera.__index(self: SmoothZoomedCamera, index)
 	if index == "CameraState" then
 		local state = CameraState.new()
 		state.Position = Vector3.new(0, 0, self.Zoom)
 		return state
 	elseif index == "Zoom" or index == "value" then
-		return self.Spring.Value
+		return self.Spring.Position
 	elseif index == "TargetPercentZoom" then
 		return (self.Target - self.MinZoom) / self.Range
 	elseif index == "PercentZoom" then
@@ -110,4 +129,4 @@ function SmoothZoomedCamera:__index(index)
 	end
 end
 
-return SmoothZoomedCamera
+return SmoothZoomedCamera

package/src/Client/Effects/SummedCamera.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Add two cameras together
 	@class SummedCamera
@@ -5,13 +6,28 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local QFrame = require("QFrame")
-local CameraState = require("CameraState")
+local CameraEffectUtils = require("CameraEffectUtils")
 local CameraFrame = require("CameraFrame")
+local CameraState = require("CameraState")
+local QFrame = require("QFrame")
 
 local SummedCamera = {}
 SummedCamera.ClassName = "SummedCamera"
 
+export type SummedCameraMode = "World" | "Relative"
+
+export type SummedCamera = typeof(setmetatable(
+	{} :: {
+		CameraState: CameraState.CameraState,
+		CameraAState: CameraState.CameraState,
+		CameraBState: CameraState.CameraState,
+		_cameraA: CameraEffectUtils.CameraEffect,
+		_cameraB: CameraEffectUtils.CameraEffect,
+		_mode: SummedCameraMode,
+	},
+	{} :: typeof({ __index = SummedCamera })
+)) & CameraEffectUtils.CameraEffect
+
 --[=[
 	Construct a new summed camera
 
@@ -19,8 +35,11 @@ SummedCamera.ClassName = "SummedCamera"
 	@param cameraB CameraEffect -- A CameraState or another CameraEffect to be used
 	@return SummedCamera
 ]=]
-function SummedCamera.new(cameraA, cameraB)
-	local self = setmetatable({}, SummedCamera)
+function SummedCamera.new(
+	cameraA: CameraEffectUtils.CameraEffect,
+	cameraB: CameraEffectUtils.CameraEffect
+): SummedCamera
+	local self: SummedCamera = setmetatable({} :: any, SummedCamera)
 
 	self._mode = "World"
 	self._cameraA = cameraA or error("No cameraA")
@@ -36,32 +55,32 @@ end
 	@param mode "World" | "Relative" -- Mode to set
 	@return SummedCamera
 ]=]
-function SummedCamera:SetMode(mode)
+function SummedCamera.SetMode(self: SummedCamera, mode: SummedCameraMode): SummedCamera
 	assert(mode == "World" or mode == "Relative", "Bad mode")
 	self._mode = mode
 
 	return self
 end
 
-function SummedCamera:__addClass(other)
+function SummedCamera.__addClass(self: SummedCamera, other: CameraEffectUtils.CameraEffect)
 	return SummedCamera.new(self, other)
 end
 
-function SummedCamera:__add(other)
+function SummedCamera.__add(self: SummedCamera, other: CameraEffectUtils.CameraEffect)
 	return SummedCamera.new(self, other):SetMode(self._mode)
 end
 
-function SummedCamera:__sub(camera)
+function SummedCamera.__sub(self: SummedCamera, camera: CameraEffectUtils.CameraEffect): CameraEffectUtils.CameraEffect
 	if self._cameraA == camera then
 		return self._cameraA
 	elseif self._cameraB == camera then
 		return self._cameraB
 	else
-		error("Unable to subtract successfully");
+		error("Unable to subtract successfully")
 	end
 end
 
-function SummedCamera:__index(index)
+function SummedCamera.__index(self: SummedCamera, index)
 	if index == "CameraState" then
 		if self._mode == "World" then
 			-- TODO: fix this
@@ -71,15 +90,18 @@ function SummedCamera:__index(index)
 			local a = self.CameraAState
 			local b = self.CameraBState
 
-			local newQFrame = QFrame.fromCFrameClosestTo(a.CFrame*b.CFrame, a.CameraFrame.QFrame)
+			local newQFrame = QFrame.fromCFrameClosestTo(a.CFrame * b.CFrame, a.CameraFrame.QFrame)
 			local cameraFrame = CameraFrame.new(newQFrame, a.FieldOfView + b.FieldOfView)
 
 			-- TODO: compute derivative velocity more correctly of this non-linear thing
 			local newQFrameVelocity = QFrame.fromCFrameClosestTo(
-				a.CameraFrameDerivative.CFrame*b.CameraFrameDerivative.CFrame,
-				a.CameraFrameDerivative.QFrame)
-			local cameraFrameVelocity = CameraFrame.new(newQFrameVelocity,
-				a.CameraFrameDerivative.FieldOfView + b.CameraFrameDerivative.FieldOfView)
+				a.CameraFrameDerivative.CFrame * b.CameraFrameDerivative.CFrame,
+				a.CameraFrameDerivative.QFrame
+			)
+			local cameraFrameVelocity = CameraFrame.new(
+				newQFrameVelocity,
+				a.CameraFrameDerivative.FieldOfView + b.CameraFrameDerivative.FieldOfView
+			)
 
 			local result = CameraState.new(cameraFrame, cameraFrameVelocity)
 			-- result.CFrame =
@@ -97,4 +119,4 @@ function SummedCamera:__index(index)
 	end
 end
 
-return SummedCamera
+return SummedCamera

package/src/Client/Effects/TrackCamera.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Track a current part, whether it be a model or part
 	@class TrackCamera
@@ -5,6 +6,7 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local CameraEffectUtils = require("CameraEffectUtils")
 local CameraState = require("CameraState")
 local SummedCamera = require("SummedCamera")
 
@@ -12,29 +14,40 @@ local TrackCamera = {}
 TrackCamera.ClassName = "TrackCamera"
 TrackCamera.FieldOfView = 0
 
+export type TrackCamera = typeof(setmetatable(
+	{} :: {
+		CameraState: CameraState.CameraState,
+		CameraSubject: Instance?,
+	},
+	{} :: typeof({ __index = TrackCamera })
+)) & CameraEffectUtils.CameraEffect
+
 --[=[
+
 	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)
+function TrackCamera.new(cameraSubject: Instance?): TrackCamera
+	local self: TrackCamera = setmetatable({} :: any, TrackCamera)
 
 	self.CameraSubject = cameraSubject
 
 	return self
 end
 
-function TrackCamera:__add(other)
+function TrackCamera.__add(self: TrackCamera, other): SummedCamera.SummedCamera
 	return SummedCamera.new(self, other)
 end
 
-function TrackCamera:__newindex(index, value)
+function TrackCamera.__newindex(self: TrackCamera, index, value)
 	if index == "CameraSubject" then
-		assert(typeof(value) == "Instance" and
-			(value:IsA("BasePart") or value:IsA("Model") or value:IsA("Attachment") or value:IsA("Humanoid")),
-			"CameraSubject must be a Roblox Model, Roblox Part, Attachment, Humanoid, or nil")
+		assert(
+			typeof(value) == "Instance"
+				and (value:IsA("BasePart") or value:IsA("Model") or value:IsA("Attachment") or value:IsA("Humanoid")),
+			"CameraSubject must be a Roblox Model, Roblox Part, Attachment, Humanoid, or nil"
+		)
 
 		rawset(self, index, value)
 	elseif index == "FieldOfView" then
@@ -61,7 +74,7 @@ end
 	@within TrackCamera
 ]=]
 
-function TrackCamera:__index(index)
+function TrackCamera.__index(self: TrackCamera, index)
 	if index == "CameraState" then
 		local state = CameraState.new()
 		state.FieldOfView = self.FieldOfView
@@ -69,7 +82,7 @@ function TrackCamera:__index(index)
 		local cameraSubject = self.CameraSubject
 		if cameraSubject then
 			if cameraSubject:IsA("Model") then
-				state.CFrame = cameraSubject:GetPrimaryPartCFrame()
+				state.CFrame = (cameraSubject :: any):GetPrimaryPartCFrame()
 			elseif cameraSubject:IsA("BasePart") then
 				state.CFrame = cameraSubject.CFrame
 			elseif cameraSubject:IsA("Attachment") then
@@ -78,7 +91,7 @@ function TrackCamera:__index(index)
 				if cameraSubject.RootPart then
 					state.CFrame = cameraSubject.RootPart.CFrame
 				elseif cameraSubject.Parent and cameraSubject.Parent:IsA("Model") then
-					state.CFrame = cameraSubject:GetPrimaryPartCFrame()
+					state.CFrame = (cameraSubject :: any):GetPrimaryPartCFrame()
 				end
 			else
 				error("Bad cameraSubject")
@@ -91,4 +104,4 @@ function TrackCamera:__index(index)
 	end
 end
 
-return TrackCamera
+return TrackCamera

package/src/Client/Effects/XZPlaneLockCamera.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Lock camera to only XZPlane, preventing TrackerCameras from making players sick.
 	@class XZPlaneLockCamera
@@ -5,6 +6,7 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local CameraEffectUtils = require("CameraEffectUtils")
 local CameraState = require("CameraState")
 local SummedCamera = require("SummedCamera")
 local getRotationInXZPlane = require("getRotationInXZPlane")
@@ -12,23 +14,34 @@ local getRotationInXZPlane = require("getRotationInXZPlane")
 local XZPlaneLockCamera = {}
 XZPlaneLockCamera.ClassName = "XZPlaneLockCamera"
 
-function XZPlaneLockCamera.new(camera)
-	local self = setmetatable({}, XZPlaneLockCamera)
+export type XZPlaneLockCamera = typeof(setmetatable(
+	{} :: {
+		CameraState: CameraState.CameraState,
+		_camera: CameraEffectUtils.CameraLike,
+	},
+	{} :: typeof({ __index = XZPlaneLockCamera })
+)) & CameraEffectUtils.CameraEffect
 
-	self._camera = camera or error("No camera")
+function XZPlaneLockCamera.new(camera: CameraEffectUtils.CameraLike): XZPlaneLockCamera
+	local self: XZPlaneLockCamera = setmetatable({} :: any, XZPlaneLockCamera)
+
+	self._camera = assert(camera, "No camera")
 
 	return self
 end
 
-function XZPlaneLockCamera:__add(other)
+function XZPlaneLockCamera.__add(
+	self: XZPlaneLockCamera,
+	other: CameraEffectUtils.CameraEffect
+): SummedCamera.SummedCamera
 	return SummedCamera.new(self, other)
 end
 
-function XZPlaneLockCamera:__index(index)
+function XZPlaneLockCamera.__index(self: XZPlaneLockCamera, index)
 	if index == "CameraState" then
-		local state = self._camera.CameraState or self._camera
-		local xzrot = getRotationInXZPlane(state.CFrame)
+		local state: CameraState.CameraState = (self._camera :: any).CameraState or self._camera
 
+		local xzrot = getRotationInXZPlane(state.CFrame)
 		local newState = CameraState.new()
 		newState.CFrame = xzrot
 		newState.FieldOfView = state.FieldOfView
@@ -39,4 +52,4 @@ function XZPlaneLockCamera:__index(index)
 	end
 end
 
-return XZPlaneLockCamera
+return XZPlaneLockCamera

package/src/Client/Effects/ZoomedCamera.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	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
@@ -17,6 +18,7 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local CameraEffectUtils = require("CameraEffectUtils")
 local CameraState = require("CameraState")
 local SummedCamera = require("SummedCamera")
 
@@ -26,17 +28,32 @@ ZoomedCamera._maxZoom = 100
 ZoomedCamera._minZoom = 0.5
 ZoomedCamera._zoom = 10
 
-function ZoomedCamera.new()
-	local self = setmetatable({}, ZoomedCamera)
+export type ZoomedCamera = typeof(setmetatable(
+	{} :: {
+		CameraState: CameraState.CameraState,
+		Zoom: number,
+		MaxZoom: number,
+		MinZoom: number,
+
+		-- Private
+		_zoom: number,
+		_maxZoom: number,
+		_minZoom: number,
+	},
+	{} :: typeof({ __index = ZoomedCamera })
+)) & CameraEffectUtils.CameraEffect
+
+function ZoomedCamera.new(): ZoomedCamera
+	local self: ZoomedCamera = setmetatable({} :: any, ZoomedCamera)
 
 	return self
 end
 
-function ZoomedCamera:__add(other)
+function ZoomedCamera.__add(self: ZoomedCamera, other: CameraEffectUtils.CameraEffect): SummedCamera.SummedCamera
 	return SummedCamera.new(self, other)
 end
 
-function ZoomedCamera:ZoomIn(value, min, max)
+function ZoomedCamera.ZoomIn(self: ZoomedCamera, value: number, min: number?, max: number?)
 	if min or max then
 		self.Zoom = self.Zoom - math.clamp(value, min or -math.huge, max or math.huge)
 	else
@@ -44,7 +61,7 @@ function ZoomedCamera:ZoomIn(value, min, max)
 	end
 end
 
-function ZoomedCamera:__newindex(index, value)
+function ZoomedCamera.__newindex(self: ZoomedCamera, index, value)
 	if index == "Zoom" or index == "TargetZoom" then
 		self._zoom = math.clamp(value, self.MinZoom, self.MaxZoom)
 	elseif index == "MaxZoom" then
@@ -62,7 +79,7 @@ function ZoomedCamera:__newindex(index, value)
 	end
 end
 
-function ZoomedCamera:__index(index)
+function ZoomedCamera.__index(self: ZoomedCamera, index)
 	if index == "CameraState" then
 		local state = CameraState.new()
 		state.Position = Vector3.new(0, 0, self.Zoom)
@@ -78,4 +95,4 @@ function ZoomedCamera:__index(index)
 	end
 end
 
-return ZoomedCamera
+return ZoomedCamera