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

package/src/Client/Input/CameraInputUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class CameraInputUtils
 ]=]
@@ -7,7 +8,14 @@ local Workspace = game:GetService("Workspace")
 
 local CameraInputUtils = {}
 
-function CameraInputUtils.getPanBy(panDelta, sensivity)
+--[=[
+	Computes the pan delta based on the given pan delta and sensitivity.
+
+	@param panDelta Vector2
+	@param sensivity Vector2
+	@return Vector2
+]=]
+function CameraInputUtils.getPanBy(panDelta: Vector2, sensivity: Vector2): Vector2
 	local viewportSize = Workspace.CurrentCamera.ViewportSize
 	local aspectRatio = CameraInputUtils.getCappedAspectRatio(viewportSize)
 	local inversionVector = CameraInputUtils.getInversionVector(UserGameSettings)
@@ -16,22 +24,45 @@ function CameraInputUtils.getPanBy(panDelta, sensivity)
 		sensivity = CameraInputUtils.invertSensitivity(sensivity)
 	end
 
-	return inversionVector*sensivity*panDelta
+	return inversionVector * sensivity * panDelta
 end
 
-function CameraInputUtils.convertToPanDelta(vector3)
-	return Vector2.new(vector3.x, vector3.y)
+--[=[
+	Converts a Vector3 to a Vector2 for camera panning
+
+	@param vector3 Vector3
+	@return Vector2
+]=]
+function CameraInputUtils.convertToPanDelta(vector3: Vector3): Vector2
+	return Vector2.new(vector3.X, vector3.Y)
 end
 
-function CameraInputUtils.getInversionVector(userGameSettings)
+--[=[
+	Returns the inversion vector based on the user game settings.
+
+	@param userGameSettings UserGameSettings
+	@return Vector2
+]=]
+function CameraInputUtils.getInversionVector(userGameSettings: UserGameSettings): Vector2
 	return Vector2.new(1, userGameSettings:GetCameraYInvertValue())
 end
 
-function CameraInputUtils.invertSensitivity(sensivity)
-	return Vector2.new(sensivity.y, sensivity.x)
+--[=[
+	Inverts the sensitivity vector.
+
+	@param sensivity Vector2
+	@return Vector2
+]=]
+function CameraInputUtils.invertSensitivity(sensivity: Vector2): Vector2
+	return Vector2.new(sensivity.Y, sensivity.X)
 end
 
-function CameraInputUtils.isPortraitMode(aspectRatio)
+--[=[
+	Returns true if in portrait mode, false otherwise.
+	@param aspectRatio number
+	@return boolean
+]=]
+function CameraInputUtils.isPortraitMode(aspectRatio: number): boolean
 	if aspectRatio < 1 then
 		return true
 	end
@@ -39,10 +70,15 @@ function CameraInputUtils.isPortraitMode(aspectRatio)
 	return false
 end
 
-function CameraInputUtils.getCappedAspectRatio(viewportSize)
-	local x = math.clamp(viewportSize.x, 0, 1920)
-	local y = math.clamp(viewportSize.y, 0, 1080)
-	return x/y
+--[=[
+	Computes a capped aspect ratio based on the viewport size.
+	@param viewportSize Vector2
+	@return number
+]=]
+function CameraInputUtils.getCappedAspectRatio(viewportSize: Vector2): number
+	local x = math.clamp(viewportSize.X, 0, 1920)
+	local y = math.clamp(viewportSize.Y, 0, 1080)
+	return x / y
 end
 
-return CameraInputUtils
+return CameraInputUtils

package/src/Client/Input/CameraTouchInputUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility methods involving touch input and cameras.
 	@class CameraTouchInputUtils
@@ -23,27 +24,27 @@ local TOUCH_SENSITIVTY_ADJUST_MIN_Y = 0.5
 	@param currPitchAngle number
 	@param sensitivity Vector2
 	@param delta Vector2
-	Return Vector2
+	@return Vector2
 ]=]
-function CameraTouchInputUtils.adjustTouchSensitivity(currPitchAngle, sensitivity, delta)
+function CameraTouchInputUtils.adjustTouchSensitivity(
+	currPitchAngle: number,
+	sensitivity: Vector2,
+	delta: Vector2
+): Vector2
 	local multiplierY = TOUCH_SENSITIVTY_ADJUST_MAX_Y
 	if currPitchAngle > TOUCH_ADJUST_AREA_UP and delta.Y < 0 then
-		local fractionAdjust = (currPitchAngle - TOUCH_ADJUST_AREA_UP)/(MAX_Y - TOUCH_ADJUST_AREA_UP)
-		fractionAdjust = 1 - (1 - fractionAdjust)^3
-		multiplierY = TOUCH_SENSITIVTY_ADJUST_MAX_Y - fractionAdjust * (
-			TOUCH_SENSITIVTY_ADJUST_MAX_Y - TOUCH_SENSITIVTY_ADJUST_MIN_Y)
+		local fractionAdjust = (currPitchAngle - TOUCH_ADJUST_AREA_UP) / (MAX_Y - TOUCH_ADJUST_AREA_UP)
+		fractionAdjust = 1 - (1 - fractionAdjust) ^ 3
+		multiplierY = TOUCH_SENSITIVTY_ADJUST_MAX_Y
+			- fractionAdjust * (TOUCH_SENSITIVTY_ADJUST_MAX_Y - TOUCH_SENSITIVTY_ADJUST_MIN_Y)
 	elseif currPitchAngle < TOUCH_ADJUST_AREA_DOWN and delta.Y > 0 then
-		local fractionAdjust = (currPitchAngle - TOUCH_ADJUST_AREA_DOWN)/(MIN_Y - TOUCH_ADJUST_AREA_DOWN)
-		fractionAdjust = 1 - (1 - fractionAdjust)^3
-		multiplierY = TOUCH_SENSITIVTY_ADJUST_MAX_Y - fractionAdjust * (
-			TOUCH_SENSITIVTY_ADJUST_MAX_Y - TOUCH_SENSITIVTY_ADJUST_MIN_Y)
+		local fractionAdjust = (currPitchAngle - TOUCH_ADJUST_AREA_DOWN) / (MIN_Y - TOUCH_ADJUST_AREA_DOWN)
+		fractionAdjust = 1 - (1 - fractionAdjust) ^ 3
+		multiplierY = TOUCH_SENSITIVTY_ADJUST_MAX_Y
+			- fractionAdjust * (TOUCH_SENSITIVTY_ADJUST_MAX_Y - TOUCH_SENSITIVTY_ADJUST_MIN_Y)
 	end
 
-	return Vector2.new(
-		sensitivity.X,
-		sensitivity.Y * multiplierY
-	)
+	return Vector2.new(sensitivity.X, sensitivity.Y * multiplierY)
 end
 
-
-return CameraTouchInputUtils
+return CameraTouchInputUtils

package/src/Client/Utility/CameraFrame.lua

@@ -6,8 +6,8 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local QFrame = require("QFrame")
 local DuckTypeUtils = require("DuckTypeUtils")
+local QFrame = require("QFrame")
 
 local CameraFrame = {}
 CameraFrame.ClassName = "CameraFrame"
@@ -197,4 +197,4 @@ function CameraFrame.__eq(a: CameraFrame, b: CameraFrame): boolean
 	return a.QFrame == b.QFrame and a.FieldOfView == b.FieldOfView
 end
 
-return CameraFrame
+return CameraFrame

package/src/Client/Utility/CameraFrame.story.lua

@@ -2,7 +2,8 @@
 	@class CameraFrame.story
 ]]
 
-local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
+local require =
+	require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
 
 local CameraFrame = require("CameraFrame")
 local CameraStoryUtils = require("CameraStoryUtils")
@@ -16,13 +17,21 @@ return function(target)
 	local viewportFrame = CameraStoryUtils.setupViewportFrame(maid, target)
 
 	local cameraCFrame = workspace.CurrentCamera.CFrame
-	local a = CameraFrame.new(QFrame.fromCFrameClosestTo(
-		CFrame.new(cameraCFrame.Position + cameraCFrame.lookVector*25 - 20*cameraCFrame.RightVector),
-		QFrame.new()), 70)
-	local b = CameraFrame.new(QFrame.fromCFrameClosestTo(
-		CFrame.new(cameraCFrame.Position + cameraCFrame.lookVector*30 + 20*cameraCFrame.RightVector)
-			 * CFrame.Angles(math.pi/3, 2*math.pi/3, 0),
-		QFrame.new()), 70)
+	local a = CameraFrame.new(
+		QFrame.fromCFrameClosestTo(
+			CFrame.new(cameraCFrame.Position + cameraCFrame.lookVector * 25 - 20 * cameraCFrame.RightVector),
+			QFrame.new()
+		),
+		70
+	)
+	local b = CameraFrame.new(
+		QFrame.fromCFrameClosestTo(
+			CFrame.new(cameraCFrame.Position + cameraCFrame.lookVector * 30 + 20 * cameraCFrame.RightVector)
+				* CFrame.Angles(math.pi / 3, 2 * math.pi / 3, 0),
+			QFrame.new()
+		),
+		70
+	)
 
 	local setup = CameraStoryUtils.getInterpolationFactory(maid, viewportFrame, -0.1, 1.1, 4, function(cameraFrame)
 		return cameraFrame.CFrame
@@ -37,12 +46,12 @@ return function(target)
 	end, Color3.new(0.5, 1, 0.5))
 
 	setup(function(t)
-		return CameraFrame.new((1 - t)*a.QFrame + t*b.QFrame, a.FieldOfView + (b.FieldOfView - a.FieldOfView)*t)
+		return CameraFrame.new((1 - t) * a.QFrame + t * b.QFrame, a.FieldOfView + (b.FieldOfView - a.FieldOfView) * t)
 	end, Color3.new(0.25, 0.25, 0.25), "Linear", Vector2.new(80, 0))
 
 	setup(function(t)
-		local result = ((b.QFrame*(a.QFrame^-1))^t)*a.QFrame
-		return CameraFrame.new(result, a.FieldOfView + (b.FieldOfView - a.FieldOfView)*t)
+		local result = ((b.QFrame * (a.QFrame ^ -1)) ^ t) * a.QFrame
+		return CameraFrame.new(result, a.FieldOfView + (b.FieldOfView - a.FieldOfView) * t)
 	end, Color3.new(0.5, 0.5, 1), "Quaternion", Vector2.new(0, -80))
 
 	setup(function(t)
@@ -61,4 +70,4 @@ return function(target)
 	return function()
 		maid:DoCleaning()
 	end
-end
+end

package/src/Client/Utility/CameraStateTweener.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Makes transitions between states easier. Uses the `CameraStackService` to tween in and
 	out a new camera state Call `:Show()` and `:Hide()` to do so, and make sure to
@@ -8,16 +9,27 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local BaseObject = require("BaseObject")
+local CameraEffectUtils = require("CameraEffectUtils")
+local CameraStack = require("CameraStack")
 local CameraStackService = require("CameraStackService")
 local FadeBetweenCamera3 = require("FadeBetweenCamera3")
 local ServiceBag = require("ServiceBag")
-local BaseObject = require("BaseObject")
-local CameraStack = require("CameraStack")
 
 local CameraStateTweener = setmetatable({}, BaseObject)
 CameraStateTweener.ClassName = "CameraStateTweener"
 CameraStateTweener.__index = CameraStateTweener
 
+export type CameraStateTweener = typeof(setmetatable(
+	{} :: {
+		_cameraStack: CameraStack.CameraStack,
+		_cameraEffect: any,
+		_cameraBelow: any,
+		_fadeBetween: FadeBetweenCamera3.FadeBetweenCamera3,
+	},
+	{} :: typeof({ __index = CameraStateTweener })
+)) & BaseObject.BaseObject
+
 --[=[
 	Constructs a new camera state tweener
 
@@ -26,15 +38,19 @@ CameraStateTweener.__index = CameraStateTweener
 	@param speed number? -- Speed that the camera tweener tweens at. Defaults to 20
 	@return CameraStateTweener
 ]=]
-function CameraStateTweener.new(serviceBagOrCameraStack, cameraEffect, speed: number?)
-	local self = setmetatable(BaseObject.new(), CameraStateTweener)
+function CameraStateTweener.new(
+	serviceBagOrCameraStack: ServiceBag.ServiceBag | CameraStack.CameraStack,
+	cameraEffect,
+	speed: number?
+): CameraStateTweener
+	local self: CameraStateTweener = setmetatable(BaseObject.new() :: any, CameraStateTweener)
 
 	assert(cameraEffect, "No cameraEffect")
 
 	if ServiceBag.isServiceBag(serviceBagOrCameraStack) then
-		self._cameraStack = serviceBagOrCameraStack:GetService(CameraStackService):GetCameraStack()
+		self._cameraStack = (serviceBagOrCameraStack :: any):GetService(CameraStackService):GetCameraStack()
 	elseif CameraStack.isCameraStack(serviceBagOrCameraStack) then
-		self._cameraStack = serviceBagOrCameraStack
+		self._cameraStack = serviceBagOrCameraStack :: any
 	else
 		error("Bad serviceBagOrCameraStack")
 	end
@@ -65,7 +81,7 @@ end
 	Returns percent visible, from 0 to 1.
 	@return number
 ]=]
-function CameraStateTweener:GetPercentVisible(): number
+function CameraStateTweener.GetPercentVisible(self: CameraStateTweener): number
 	return self._fadeBetween.Value
 end
 
@@ -73,7 +89,7 @@ end
 	Shows the camera to fade in.
 	@param doNotAnimate? boolean -- Optional, defaults to animating
 ]=]
-function CameraStateTweener:Show(doNotAnimate: boolean?)
+function CameraStateTweener.Show(self: CameraStateTweener, doNotAnimate: boolean?)
 	self:SetTarget(1, doNotAnimate)
 end
 
@@ -81,7 +97,7 @@ end
 	Hides the camera to fade in.
 	@param doNotAnimate? boolean -- Optional, defaults to animating
 ]=]
-function CameraStateTweener:Hide(doNotAnimate: boolean?)
+function CameraStateTweener.Hide(self: CameraStateTweener, doNotAnimate: boolean?)
 	self:SetTarget(0, doNotAnimate)
 end
 
@@ -89,7 +105,7 @@ end
 	Returns true if we're done hiding
 	@return boolean
 ]=]
-function CameraStateTweener:IsFinishedHiding(): boolean
+function CameraStateTweener.IsFinishedHiding(self: CameraStateTweener): boolean
 	return self._fadeBetween.HasReachedTarget and self._fadeBetween.Target == 0
 end
 
@@ -97,7 +113,7 @@ end
 	Returns true if we're done showing
 	@return boolean
 ]=]
-function CameraStateTweener:IsFinishedShowing(): boolean
+function CameraStateTweener.IsFinishedShowing(self: CameraStateTweener): boolean
 	return self._fadeBetween.HasReachedTarget and self._fadeBetween.Target == 1
 end
 
@@ -107,7 +123,7 @@ end
 	@param doNotAnimate boolean? -- Optional, defaults to animating
 	@param callback function
 ]=]
-function CameraStateTweener:Finish(doNotAnimate: boolean?, callback: () -> ())
+function CameraStateTweener.Finish(self: CameraStateTweener, doNotAnimate: boolean?, callback: () -> ())
 	assert(type(callback) == "function", "Bad callback")
 
 	self:Hide(doNotAnimate)
@@ -128,7 +144,7 @@ end
 	Gets the current effect we're tweening
 	@return CameraEffect
 ]=]
-function CameraStateTweener:GetCameraEffect()
+function CameraStateTweener.GetCameraEffect(self: CameraStateTweener): CameraEffectUtils.CameraEffect
 	return self._cameraEffect
 end
 
@@ -136,7 +152,7 @@ end
 	Gets the camera below this camera on the camera stack
 	@return CameraEffect
 ]=]
-function CameraStateTweener:GetCameraBelow()
+function CameraStateTweener.GetCameraBelow(self: CameraStateTweener): CameraEffectUtils.CameraEffect
 	return self._cameraBelow
 end
 
@@ -146,7 +162,11 @@ end
 	@param doNotAnimate boolean? -- Optional, defaults to animating
 	@return CameraStateTweener -- self
 ]=]
-function CameraStateTweener:SetTarget(target: number, doNotAnimate: boolean?)
+function CameraStateTweener.SetTarget(
+	self: CameraStateTweener,
+	target: number,
+	doNotAnimate: boolean?
+): CameraStateTweener
 	self._fadeBetween.Target = target or error("No target")
 	if doNotAnimate then
 		self._fadeBetween.Value = self._fadeBetween.Target
@@ -160,7 +180,7 @@ end
 	@param speed number
 	@return CameraStateTweener -- self
 ]=]
-function CameraStateTweener:SetSpeed(speed: number)
+function CameraStateTweener.SetSpeed(self: CameraStateTweener, speed: number): CameraStateTweener
 	assert(type(speed) == "number", "Bad speed")
 
 	self._fadeBetween.Speed = speed
@@ -173,7 +193,7 @@ end
 	@param isVisible boolean
 	@param doNotAnimate boolean? -- Optional, defaults to animating
 ]=]
-function CameraStateTweener:SetVisible(isVisible: number, doNotAnimate: boolean?)
+function CameraStateTweener.SetVisible(self: CameraStateTweener, isVisible: number, doNotAnimate: boolean?): ()
 	if isVisible then
 		self:Show(doNotAnimate)
 	else
@@ -185,8 +205,8 @@ end
 	Retrieves the fading camera being used to interpolate.
 	@return CameraEffect
 ]=]
-function CameraStateTweener:GetFader()
+function CameraStateTweener.GetFader(self: CameraStateTweener): CameraEffectUtils.CameraEffect
 	return self._fadeBetween
 end
 
-return CameraStateTweener
+return CameraStateTweener

package/src/Client/Utility/FieldOfViewUtils.lua

@@ -81,4 +81,4 @@ function FieldOfViewUtils.lerpInHeightSpace(fov0: number, fov1: number, percent:
 	return FieldOfViewUtils.heightToFov(FieldOfViewUtils.safeExp(newLogHeight, linearAt))
 end
 
-return FieldOfViewUtils
+return FieldOfViewUtils

package/test/scripts/Client/ClientMain.client.lua

@@ -8,4 +8,4 @@ local serviceBag = require("ServiceBag").new()
 serviceBag:GetService(require("CameraStackService"))
 
 serviceBag:Init()
-serviceBag:Start()
+serviceBag:Start()

package/test/scripts/Server/ServerMain.server.lua

@@ -5,4 +5,4 @@
 local ServerScriptService = game:GetService("ServerScriptService")
 
 local loader = ServerScriptService:FindFirstChild("LoaderUtils", true).Parent
-require(loader).bootstrapGame(ServerScriptService.camera)
+require(loader).bootstrapGame(ServerScriptService.camera)