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

package/src/Client/Effects/DefaultCamera.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Hack to maintain default camera control by binding before and after the camera update cycle
 	This allows other cameras to build off of the "default" camera while maintaining the same Roblox control scheme.
@@ -8,31 +9,44 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local HttpService = game:GetService("HttpService")
 local RunService = game:GetService("RunService")
 local Workspace = game:GetService("Workspace")
-local HttpService = game:GetService("HttpService")
 
-local CameraState = require("CameraState")
-local SummedCamera = require("SummedCamera")
-local Maid = require("Maid")
 local CFrameUtils = require("CFrameUtils")
+local CameraEffectUtils = require("CameraEffectUtils")
 local CameraFrame = require("CameraFrame")
+local CameraState = require("CameraState")
+local Maid = require("Maid")
+local Observable = require("Observable")
+local Rx = require("Rx")
+local SummedCamera = require("SummedCamera")
 local ValueObject = require("ValueObject")
-local _Rx = require("Rx")
-local _Observable = require("Observable")
 
 local EPSILON = 0.001
 
 local DefaultCamera = {}
 DefaultCamera.ClassName = "DefaultCamera"
 
+export type DefaultCamera = typeof(setmetatable(
+	{} :: {
+		CameraState: CameraState.CameraState,
+		_key: string,
+		_maid: Maid.Maid,
+		_isFirstPerson: ValueObject.ValueObject<boolean>,
+		_cameraState: CameraState.CameraState,
+		_lastCameraFrame: CameraFrame.CameraFrame?,
+	},
+	{} :: typeof({ __index = DefaultCamera })
+)) & CameraEffectUtils.CameraEffect
+
 --[=[
 	Constructs a new DefaultCamera
 
 	@return DefaultCamera
 ]=]
-function DefaultCamera.new()
-	local self = setmetatable({}, DefaultCamera)
+function DefaultCamera.new(): DefaultCamera
+	local self: DefaultCamera = setmetatable({} :: any, DefaultCamera)
 
 	self._key = HttpService:GenerateGUID(false)
 	self._maid = Maid.new()
@@ -43,7 +57,7 @@ function DefaultCamera.new()
 	return self
 end
 
-function DefaultCamera:__add(other)
+function DefaultCamera.__add(self: DefaultCamera, other: CameraEffectUtils.CameraEffect)
 	return SummedCamera.new(self, other)
 end
 
@@ -51,7 +65,7 @@ end
 	Overrides the global field of view in the cached camera state
 	@param fieldOfView number
 ]=]
-function DefaultCamera:SetRobloxFieldOfView(fieldOfView)
+function DefaultCamera.SetRobloxFieldOfView(self: DefaultCamera, fieldOfView: number)
 	self._cameraState.FieldOfView = fieldOfView
 end
 
@@ -63,7 +77,7 @@ DefaultCamera.OverrideGlobalFieldOfView = DefaultCamera.SetRobloxFieldOfView
 
 	@param cameraState CameraState
 ]=]
-function DefaultCamera:SetRobloxCameraState(cameraState)
+function DefaultCamera.SetRobloxCameraState(self: DefaultCamera, cameraState: CameraState.CameraState)
 	self._cameraState = cameraState or error("No CameraState")
 end
 
@@ -75,7 +89,7 @@ DefaultCamera.OverrideCameraState = DefaultCamera.SetRobloxCameraState
 
 	@param cframe CFrame
 ]=]
-function DefaultCamera:SetRobloxCFrame(cframe: CFrame)
+function DefaultCamera.SetRobloxCFrame(self: DefaultCamera, cframe: CFrame)
 	self._cameraState.CFrame = cframe
 end
 
@@ -84,7 +98,7 @@ end
 
 	@return CameraState
 ]=]
-function DefaultCamera:GetRobloxCameraState()
+function DefaultCamera.GetRobloxCameraState(self: DefaultCamera): CameraState.CameraState
 	return self._cameraState
 end
 
@@ -93,14 +107,14 @@ end
 
 	@param cameraFrame CameraState | nil
 ]=]
-function DefaultCamera:SetLastSetCameraFrame(cameraFrame: CameraFrame.CameraFrame)
+function DefaultCamera.SetLastSetCameraFrame(self: DefaultCamera, cameraFrame: CameraFrame.CameraFrame)
 	self._lastCameraFrame = CameraFrame.new(cameraFrame.QFrame, cameraFrame.FieldOfView)
 end
 
 --[=[
 	Gets whether the Roblox camera is in first person
 ]=]
-function DefaultCamera:IsFirstPerson(): boolean
+function DefaultCamera.IsFirstPerson(self: DefaultCamera): boolean
 	return self._isFirstPerson.Value
 end
 
@@ -109,7 +123,7 @@ end
 
 	@return Observable<boolean>
 ]=]
-function DefaultCamera:ObserveIsFirstPerson(): _Observable.Observable<boolean>
+function DefaultCamera.ObserveIsFirstPerson(self: DefaultCamera): Observable.Observable<boolean>
 	return self._isFirstPerson:Observe()
 end
 
@@ -119,8 +133,8 @@ end
 	@param predicate ((inFirstPerson: boolean) -> boolean)?
 	@return Observable<Brio<boolean>>
 ]=]
-function DefaultCamera:ObserveIsFirstPersonBrio(predicate: _Rx.Predicate<boolean>?)
-	return self._isFirstPerson:Observe(predicate)
+function DefaultCamera.ObserveIsFirstPersonBrio(self: DefaultCamera, predicate: Rx.Predicate<boolean>?)
+	return self._isFirstPerson:ObserveBrio(predicate)
 end
 
 --[=[
@@ -130,10 +144,10 @@ end
 	Be sure to call UnbindFromRenderStep when using this.
 	:::
 ]=]
-function DefaultCamera:BindToRenderStep()
+function DefaultCamera.BindToRenderStep(self: DefaultCamera): Maid.Maid
 	local maid = Maid.new()
 
-	RunService:BindToRenderStep("DefaultCamera_Preupdate" .. self._key, Enum.RenderPriority.Camera.Value-2, function()
+	RunService:BindToRenderStep("DefaultCamera_Preupdate" .. self._key, Enum.RenderPriority.Camera.Value - 2, function()
 		local camera = Workspace.CurrentCamera
 
 		if self._lastCameraFrame then
@@ -155,16 +169,20 @@ function DefaultCamera:BindToRenderStep()
 		self._cameraState:Set(camera)
 	end)
 
-	RunService:BindToRenderStep("DefaultCamera_PostUpdate" .. self._key, Enum.RenderPriority.Camera.Value+2, function()
-		local camera = Workspace.CurrentCamera
+	RunService:BindToRenderStep(
+		"DefaultCamera_PostUpdate" .. self._key,
+		Enum.RenderPriority.Camera.Value + 2,
+		function()
+			local camera = Workspace.CurrentCamera
 
-		-- Based upon Roblox's camera scripts
-		local distance = (camera.CFrame.Position - camera.Focus.Position).magnitude
-		self._isFirstPerson.Value = distance <= 0.75
+			-- Based upon Roblox's camera scripts
+			local distance = (camera.CFrame.Position - camera.Focus.Position).magnitude
+			self._isFirstPerson.Value = distance <= 0.75
 
-		-- Capture
-		self._cameraState = CameraState.new(camera)
-	end)
+			-- Capture
+			self._cameraState = CameraState.new(camera)
+		end
+	)
 
 	maid:GiveTask(function()
 		self._isFirstPerson.Value = false
@@ -182,14 +200,14 @@ end
 --[=[
 	Unbinds the camera from the RunService
 ]=]
-function DefaultCamera:UnbindFromRenderStep()
+function DefaultCamera.UnbindFromRenderStep(self: DefaultCamera)
 	self._maid._binding = nil
 end
 
 --[=[
 	Cleans up the binding
 ]=]
-function DefaultCamera:Destroy()
+function DefaultCamera.Destroy(self: DefaultCamera)
 	self._maid:DoCleaning()
 end
 
@@ -199,7 +217,7 @@ end
 	@prop CameraState CameraState
 	@within DefaultCamera
 ]=]
-function DefaultCamera:__index(index)
+function DefaultCamera.__index(self: DefaultCamera, index)
 	if index == "CameraState" then
 		return rawget(self, "_cameraState")
 	elseif index == "_maid" or index == "_lastCameraFrame" or index == "_key" then
@@ -209,4 +227,4 @@ function DefaultCamera:__index(index)
 	end
 end
 
-return DefaultCamera
+return DefaultCamera

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

@@ -5,11 +5,11 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local Spring = require("Spring")
-local SummedCamera = require("SummedCamera")
-local SpringUtils = require("SpringUtils")
 local CameraState = require("CameraState")
 local CubicSplineUtils = require("CubicSplineUtils")
+local Spring = require("Spring")
+local SpringUtils = require("SpringUtils")
+local SummedCamera = require("SummedCamera")
 
 local FadeBetweenCamera = {}
 FadeBetweenCamera.ClassName = "FadeBetweenCamera"
@@ -21,9 +21,9 @@ FadeBetweenCamera.ClassName = "FadeBetweenCamera"
 ]=]
 function FadeBetweenCamera.new(cameraA, cameraB)
 	local self = setmetatable({
-		_spring = Spring.new(0);
-		CameraA = cameraA or error("No cameraA");
-		CameraB = cameraB or error("No cameraB");
+		_spring = Spring.new(0),
+		CameraA = cameraA or error("No cameraA"),
+		CameraB = cameraB or error("No cameraB"),
 	}, FadeBetweenCamera)
 
 	self.Damper = 1
@@ -127,4 +127,4 @@ function FadeBetweenCamera:__index(index)
 	end
 end
 
-return FadeBetweenCamera
+return FadeBetweenCamera

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

@@ -4,8 +4,8 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local CubicSplineUtils = require("CubicSplineUtils")
 local CameraState = require("CameraState")
+local CubicSplineUtils = require("CubicSplineUtils")
 
 local FadeBetweenCamera2 = {}
 FadeBetweenCamera2.ClassName = "FadeBetweenCamera2"
@@ -18,13 +18,13 @@ FadeBetweenCamera2.__index = FadeBetweenCamera2
 ]=]
 function FadeBetweenCamera2.new(cameraA, cameraB)
 	local self = setmetatable({
-		CameraA = cameraA or error("No cameraA");
-		CameraB = cameraB or error("No cameraB");
-		_state0 = cameraA.CameraState;
-		_time0 = os.clock();
-		_target = 0;
-		_position0 = 0;
-		_speed = 15;
+		CameraA = cameraA or error("No cameraA"),
+		CameraB = cameraB or error("No cameraB"),
+		_state0 = cameraA.CameraState,
+		_time0 = os.clock(),
+		_target = 0,
+		_position0 = 0,
+		_speed = 15,
 	}, FadeBetweenCamera2)
 
 	return self
@@ -138,9 +138,9 @@ function FadeBetweenCamera2:_computeDoneProportion(now)
 		return 1
 	end
 
-	local SPEED_CONSTANT = 0.5/15 -- 0.5 seconds is 15 speed in the other system
+	local SPEED_CONSTANT = 0.5 / 15 -- 0.5 seconds is 15 speed in the other system
 
-	return math.clamp(self._speed*(now - self._time0)*SPEED_CONSTANT/dist_to_travel, 0, 1)
+	return math.clamp(self._speed * (now - self._time0) * SPEED_CONSTANT / dist_to_travel, 0, 1)
 end
 
-return FadeBetweenCamera2
+return FadeBetweenCamera2

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

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Add another layer of effects that can be faded in/out
 	@class FadeBetweenCamera3
@@ -5,29 +6,51 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local Spring = require("Spring")
-local SummedCamera = require("SummedCamera")
-local SpringUtils = require("SpringUtils")
-local QFrame = require("QFrame")
-local FieldOfViewUtils = require("FieldOfViewUtils")
-local CameraState = require("CameraState")
+local CameraEffectUtils = require("CameraEffectUtils")
 local CameraFrame = require("CameraFrame")
+local CameraState = require("CameraState")
 local CubicSplineUtils = require("CubicSplineUtils")
+local FieldOfViewUtils = require("FieldOfViewUtils")
+local QFrame = require("QFrame")
+local Spring = require("Spring")
+local SpringUtils = require("SpringUtils")
+local SummedCamera = require("SummedCamera")
 
 local FadeBetweenCamera3 = {}
 FadeBetweenCamera3.ClassName = "FadeBetweenCamera3"
 
+export type FadeBetweenCamera3 = typeof(setmetatable(
+	{} :: {
+		_spring: Spring.Spring<number>,
+		CameraA: CameraEffectUtils.CameraLike,
+		CameraB: CameraEffectUtils.CameraLike,
+		HasReachedTarget: boolean,
+		Damper: number,
+		Value: number,
+		Speed: number,
+		Velocity: number,
+		Target: number,
+	},
+	{} :: typeof({ __index = FadeBetweenCamera3 })
+)) & CameraEffectUtils.CameraEffect
+
 --[=[
 	@param cameraA CameraLike
 	@param cameraB CameraLike
 	@return FadeBetweenCamera3
 ]=]
-function FadeBetweenCamera3.new(cameraA, cameraB)
-	local self = setmetatable({
-		_spring = Spring.new(0);
-		CameraA = cameraA or error("No cameraA");
-		CameraB = cameraB or error("No cameraB");
-	}, FadeBetweenCamera3)
+function FadeBetweenCamera3.new(
+	cameraA: CameraEffectUtils.CameraLike,
+	cameraB: CameraEffectUtils.CameraLike
+): FadeBetweenCamera3
+	local self: FadeBetweenCamera3 = setmetatable(
+		{
+			_spring = Spring.new(0),
+			CameraA = cameraA or error("No cameraA"),
+			CameraB = cameraB or error("No cameraB"),
+		} :: any,
+		FadeBetweenCamera3
+	)
 
 	self.Damper = 1
 	self.Speed = 15
@@ -79,23 +102,36 @@ function FadeBetweenCamera3:__index(index)
 
 			local dist = (frameA.Position - frameB.Position).magnitude
 
-			local node0 = CubicSplineUtils.newSplineNode(0, frameA.Position,
-				stateA.CameraFrameDerivative.Position + frameA.CFrame.lookVector*dist*0.3)
-			local node1 = CubicSplineUtils.newSplineNode(1, frameB.Position,
-				stateB.CameraFrameDerivative.Position + frameB.CFrame.lookVector*dist*0.3)
+			local node0 = CubicSplineUtils.newSplineNode(
+				0,
+				frameA.Position,
+				stateA.CameraFrameDerivative.Position + frameA.CFrame.lookVector * dist * 0.3
+			)
+			local node1 = CubicSplineUtils.newSplineNode(
+				1,
+				frameB.Position,
+				stateB.CameraFrameDerivative.Position + frameB.CFrame.lookVector * dist * 0.3
+			)
 
 			-- We do the position this way because 0^-1 is undefined
 			--stateA.Position + (stateB.Position - stateA.Position)*t
 			local newNode = CubicSplineUtils.tweenSplineNodes(node0, node1, t)
-			local delta = (frameB*(frameA^-1))
+			local delta = (frameB * (frameA ^ -1))
 
 			local deltaQFrame = delta.QFrame
 			if deltaQFrame.W < 0 then
 				delta.QFrame = QFrame.new(
-					deltaQFrame.x, deltaQFrame.y, deltaQFrame.z, -deltaQFrame.W, -deltaQFrame.X, -deltaQFrame.Y, -deltaQFrame.Z)
+					deltaQFrame.x,
+					deltaQFrame.y,
+					deltaQFrame.z,
+					-deltaQFrame.W,
+					-deltaQFrame.X,
+					-deltaQFrame.Y,
+					-deltaQFrame.Z
+				)
 			end
 
-			local newState = delta^t*frameA
+			local newState = delta ^ t * frameA
 			newState.FieldOfView = FieldOfViewUtils.lerpInHeightSpace(frameA.FieldOfView, frameB.FieldOfView, t)
 			newState.Position = newNode.p
 
@@ -121,7 +157,7 @@ function FadeBetweenCamera3:__index(index)
 		if animating then
 			return self._spring.Velocity
 		else
-			return Vector3.zero
+			return 0
 		end
 	elseif index == "HasReachedTarget" then
 		local animating = SpringUtils.animating(self._spring)
@@ -135,4 +171,4 @@ function FadeBetweenCamera3:__index(index)
 	end
 end
 
-return FadeBetweenCamera3
+return FadeBetweenCamera3

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

@@ -4,8 +4,8 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local CubicSplineUtils = require("CubicSplineUtils")
 local CameraState = require("CameraState")
+local CubicSplineUtils = require("CubicSplineUtils")
 local Spring = require("Spring")
 local SpringUtils = require("SpringUtils")
 
@@ -20,11 +20,11 @@ FadeBetweenCamera4.__index = FadeBetweenCamera4
 ]=]
 function FadeBetweenCamera4.new(cameraA, cameraB)
 	local self = setmetatable({
-		CameraA = cameraA or error("No cameraA");
-		CameraB = cameraB or error("No cameraB");
-		_spring = Spring.new();
-		_position0 = 0;
-		_state0 = cameraA.CameraState;
+		CameraA = cameraA or error("No cameraA"),
+		CameraB = cameraB or error("No cameraB"),
+		_spring = Spring.new(),
+		_position0 = 0,
+		_state0 = cameraA.CameraState,
 	}, FadeBetweenCamera4)
 
 	self._spring.s = 15
@@ -122,11 +122,19 @@ function FadeBetweenCamera4:_computeCameraState(position)
 		local a = self:_computeTargetState(0)
 
 		node0 = CubicSplineUtils.newSplineNode(0, a.CameraFrame, a.CameraFrameDerivative)
-		node1 = CubicSplineUtils.newSplineNode(self._position0, self._state0.CameraFrame, self._state0.CameraFrameDerivative)
+		node1 = CubicSplineUtils.newSplineNode(
+			self._position0,
+			self._state0.CameraFrame,
+			self._state0.CameraFrameDerivative
+		)
 	else
 		local b = self:_computeTargetState(1)
 
-		node0 = CubicSplineUtils.newSplineNode(self._position0, self._state0.CameraFrame, self._state0.CameraFrameDerivative)
+		node0 = CubicSplineUtils.newSplineNode(
+			self._position0,
+			self._state0.CameraFrame,
+			self._state0.CameraFrameDerivative
+		)
 		node1 = CubicSplineUtils.newSplineNode(1, b.CameraFrame, b.CameraFrameDerivative)
 	end
 
@@ -136,4 +144,4 @@ function FadeBetweenCamera4:_computeCameraState(position)
 	return newState, position
 end
 
-return FadeBetweenCamera4
+return FadeBetweenCamera4

package/src/Client/Effects/FadingCamera.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Add another layer of effects that can be faded in/out
 	@class FadingCamera
@@ -5,17 +6,32 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local CameraEffectUtils = require("CameraEffectUtils")
+local CameraState = require("CameraState")
 local Spring = require("Spring")
 local SummedCamera = require("SummedCamera")
 
 local FadingCamera = {}
 FadingCamera.ClassName = "FadingCamera"
 
+export type FadingCamera = typeof(setmetatable(
+	{} :: {
+		CameraState: CameraState.CameraState,
+		Spring: Spring.Spring<number>,
+		Camera: CameraEffectUtils.CameraLike,
+		Damper: number,
+		Speed: number,
+		Target: number,
+		Value: number,
+	},
+	{} :: typeof({ __index = FadingCamera })
+)) & CameraEffectUtils.CameraEffect
+
 --[=[
 	@param camera CameraEffect
 ]=]
-function FadingCamera.new(camera)
-	local self = setmetatable({}, FadingCamera)
+function FadingCamera.new(camera: CameraEffectUtils.CameraLike): FadingCamera
+	local self: FadingCamera = setmetatable({} :: any, FadingCamera)
 
 	self.Spring = Spring.new(0)
 
@@ -33,7 +49,7 @@ end
 function FadingCamera:__newindex(index, value)
 	if index == "Damper" then
 		self.Spring.Damper = value
-	elseif index == "value" then
+	elseif index == "Value" then
 		self.Spring.Value = value
 	elseif index == "Speed" then
 		self.Spring.Speed = value
@@ -57,7 +73,7 @@ function FadingCamera:__index(index)
 		return (self.Camera.CameraState or self.Camera) * self.Spring.Value
 	elseif index == "Damper" then
 		return self.Spring.Damper
-	elseif index == "value" then
+	elseif index == "Value" then
 		return self.Spring.Value
 	elseif index == "Speed" then
 		return self.Spring.Speed
@@ -72,4 +88,4 @@ function FadingCamera:__index(index)
 	end
 end
 
-return FadingCamera
+return FadingCamera

package/src/Client/Effects/HeartbeatCamera.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Update on heartbeat, must GC this camera state, unlike others. This
 	allows for camera effects to run on heartbeat and cache information once instead
@@ -10,17 +11,29 @@ local require = require(script.Parent.loader).load(script)
 
 local RunService = game:GetService("RunService")
 
-local SummedCamera = require("SummedCamera")
+local CameraEffectUtils = require("CameraEffectUtils")
+local CameraState = require("CameraState")
 local Maid = require("Maid")
+local SummedCamera = require("SummedCamera")
 
 local HeartbeatCamera = {}
 HeartbeatCamera.ClassName = "HeartbeatCamera"
 HeartbeatCamera.ProfileName = "HeartbeatCamera"
 
-function HeartbeatCamera.new(camera)
-	local self = setmetatable({}, HeartbeatCamera)
+export type HeartbeatCamera = typeof(setmetatable(
+	{} :: {
+		CameraState: CameraState.CameraState,
+		_maid: Maid.Maid,
+		_camera: CameraEffectUtils.CameraEffect,
+		_currentStateCache: CameraState.CameraState,
+	},
+	{} :: typeof({ __index = HeartbeatCamera })
+)) & CameraEffectUtils.CameraEffect
+
+function HeartbeatCamera.new(camera: CameraEffectUtils.CameraEffect): HeartbeatCamera
+	local self: HeartbeatCamera = setmetatable({} :: any, HeartbeatCamera)
 
-	self._camera = camera or error("No camera")
+	self._camera = assert(camera, "No camera")
 	self._maid = Maid.new()
 
 	self._currentStateCache = self._camera.CameraState or error("Camera state returned null")
@@ -33,11 +46,11 @@ function HeartbeatCamera.new(camera)
 	return self
 end
 
-function HeartbeatCamera:__add(other)
+function HeartbeatCamera.__add(self: HeartbeatCamera, other: CameraEffectUtils.CameraEffect): SummedCamera.SummedCamera
 	return SummedCamera.new(self, other)
 end
 
-function HeartbeatCamera:ForceUpdateCache()
+function HeartbeatCamera.ForceUpdateCache(self: HeartbeatCamera): ()
 	self._currentStateCache = self._camera.CameraState
 end
 
@@ -47,7 +60,7 @@ end
 	@prop CameraState CameraState
 	@within HeartbeatCamera
 ]=]
-function HeartbeatCamera:__index(index)
+function HeartbeatCamera.__index(self: HeartbeatCamera, index)
 	if index == "CameraState" then
 		return self._currentStateCache
 	else
@@ -55,8 +68,8 @@ function HeartbeatCamera:__index(index)
 	end
 end
 
-function HeartbeatCamera:Destroy()
+function HeartbeatCamera.Destroy(self: HeartbeatCamera)
 	self._maid:DoCleaning()
 end
 
-return HeartbeatCamera
+return HeartbeatCamera