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

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [14.20.4-canary.11a5dcf.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camera@14.20.3...@quenty/camera@14.20.4-canary.11a5dcf.0) (2025-05-10)
+
+
+### Bug Fixes
+
+* Additional type checking updates ([05ba29a](https://github.com/Quenty/NevermoreEngine/commit/05ba29a03efc9f3feed74b34f1d9dfb237496214))
+
+
+### Features
+
+* Add even more types ([b31717d](https://github.com/Quenty/NevermoreEngine/commit/b31717d8c9f7620c457f5018a2affa760a65334a))
+
+
+
+
+
 ## [14.20.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camera@14.20.2...@quenty/camera@14.20.3) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/camera

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/camera",
-  "version": "14.20.3",
+  "version": "14.20.4-canary.11a5dcf.0",
   "description": "Quenty's camera system for Roblox",
   "keywords": [
     "Roblox",
@@ -25,26 +25,26 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/acceltween": "^2.5.3",
-    "@quenty/baseobject": "^10.8.3",
-    "@quenty/cframeutils": "^5.5.3",
-    "@quenty/cubicspline": "^10.8.3",
-    "@quenty/ducktype": "^5.8.4",
-    "@quenty/inputobjectutils": "^4.18.3",
-    "@quenty/loader": "^10.8.3",
-    "@quenty/maid": "^3.4.3",
-    "@quenty/math": "^2.7.3",
-    "@quenty/qframe": "^10.10.4",
-    "@quenty/servicebag": "^11.11.4",
-    "@quenty/spring": "^10.8.4",
-    "@quenty/valueobject": "^13.17.3",
-    "@quenty/vector3utils": "^10.8.4"
+    "@quenty/acceltween": "2.5.3",
+    "@quenty/baseobject": "10.8.4-canary.11a5dcf.0",
+    "@quenty/cframeutils": "5.5.3",
+    "@quenty/cubicspline": "10.8.4-canary.11a5dcf.0",
+    "@quenty/ducktype": "5.8.5-canary.11a5dcf.0",
+    "@quenty/inputobjectutils": "4.18.4-canary.11a5dcf.0",
+    "@quenty/loader": "10.8.4-canary.11a5dcf.0",
+    "@quenty/maid": "3.4.4-canary.11a5dcf.0",
+    "@quenty/math": "2.7.3",
+    "@quenty/qframe": "10.10.5-canary.11a5dcf.0",
+    "@quenty/servicebag": "11.11.5-canary.11a5dcf.0",
+    "@quenty/spring": "10.8.5-canary.11a5dcf.0",
+    "@quenty/valueobject": "13.17.4-canary.11a5dcf.0",
+    "@quenty/vector3utils": "10.8.5-canary.11a5dcf.0"
   },
   "devDependencies": {
-    "@quenty/camerastoryutils": "^10.10.4"
+    "@quenty/camerastoryutils": "10.10.5-canary.11a5dcf.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
+  "gitHead": "11a5dcf7d4c7a0bfbf3337e97d30e8346ea09d3f"
 }

package/src/Client/CameraStack.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class CameraStack
 ]=]
@@ -7,9 +8,10 @@ local require = require(script.Parent.loader).load(script)
 local HttpService = game:GetService("HttpService")
 
 local BaseObject = require("BaseObject")
+local CameraEffectUtils = require("CameraEffectUtils")
+local CameraState = require("CameraState")
 local CustomCameraEffect = require("CustomCameraEffect")
 local DuckTypeUtils = require("DuckTypeUtils")
-local _Maid = require("Maid")
 
 local CameraStack = setmetatable({}, BaseObject)
 CameraStack.ClassName = "CameraStack"
@@ -17,7 +19,7 @@ CameraStack.__index = CameraStack
 
 export type CameraStack = typeof(setmetatable(
 	{} :: {
-		_stack: { any },
+		_stack: { CameraEffectUtils.CameraLike },
 		_disabledSet: { [string]: boolean },
 	},
 	{} :: typeof({ __index = CameraStack })
@@ -29,7 +31,7 @@ export type CameraStack = typeof(setmetatable(
 	@return CameraStack
 ]=]
 function CameraStack.new(): CameraStack
-	local self: CameraStack = setmetatable(BaseObject.new(), CameraStack)
+	local self: CameraStack = setmetatable(BaseObject.new() :: any, CameraStack)
 
 	self._stack = {}
 	self._disabledSet = {}
@@ -49,7 +51,7 @@ end
 	Pushes a disable state onto the camera stack
 	@return function -- Function to cancel disable
 ]=]
-function CameraStack:PushDisable(): () -> ()
+function CameraStack.PushDisable(self: CameraStack): () -> ()
 	assert(self._stack, "Not initialized")
 
 	local disabledKey = HttpService:GenerateGUID(false)
@@ -63,11 +65,11 @@ end
 --[=[
 	Outputs the camera stack. Intended for diagnostics.
 ]=]
-function CameraStack:PrintCameraStack(): ()
+function CameraStack.PrintCameraStack(self: CameraStack): ()
 	assert(self._stack, "Stack is not initialized yet")
 
 	for _, value in self._stack do
-		print(tostring(type(value) == "table" and value.ClassName or tostring(value)))
+		print(tostring(type(value) == "table" and (value :: any).ClassName or tostring(value)))
 	end
 end
 
@@ -75,7 +77,7 @@ end
 	Gets the camera current on the top of the stack
 	@return CameraEffect
 ]=]
-function CameraStack:GetTopCamera()
+function CameraStack.GetTopCamera(self: CameraStack): CameraEffectUtils.CameraLike
 	assert(self._stack, "Not initialized")
 
 	return self._stack[#self._stack]
@@ -85,7 +87,7 @@ end
 	Retrieves the top state off the stack at this time
 	@return CameraState?
 ]=]
-function CameraStack:GetTopState()
+function CameraStack.GetTopState(self: CameraStack): CameraState.CameraState?
 	assert(self._stack, "Stack is not initialized yet")
 
 	if next(self._disabledSet) then
@@ -95,7 +97,7 @@ function CameraStack:GetTopState()
 	if #self._stack > 10 then
 		warn(string.format("[CameraStack] - Stack is bigger than 10 in CameraStack (%d)", #self._stack))
 	end
-	local topState = self._stack[#self._stack]
+	local topState: any = self._stack[#self._stack]
 
 	if type(topState) == "table" then
 		local state = topState.CameraState or topState
@@ -119,7 +121,7 @@ end
 	@return CustomCameraEffect -- Effect below
 	@return (CameraState) -> () -- Function to set the state
 ]=]
-function CameraStack:GetNewStateBelow()
+function CameraStack.GetNewStateBelow(self: CameraStack)
 	assert(self._stack, "Stack is not initialized yet")
 
 	local _stateToUse = nil
@@ -127,16 +129,16 @@ function CameraStack:GetNewStateBelow()
 	return CustomCameraEffect.new(function()
 		local index = self:GetIndex(_stateToUse)
 		if index then
-			local below = self._stack[index - 1]
+			local below: any = self._stack[index - 1]
 			if below then
 				return below.CameraState or below
 			else
 				warn("[CameraStack] - Could not get state below, found current state. Returning default.")
-				return self._stack[1].CameraState
+				return self:_getDefaultState()
 			end
 		else
 			warn(string.format("[CameraStack] - Could not get state from %q, returning default", tostring(_stateToUse)))
-			return self._stack[1].CameraState
+			return self:_getDefaultState()
 		end
 	end),
 		function(newStateToUse)
@@ -144,13 +146,17 @@ function CameraStack:GetNewStateBelow()
 		end
 end
 
+function CameraStack:_getDefaultState(): CameraState.CameraState
+	return self._stack[1].CameraState or self._stack[1]
+end
+
 --[=[
 	Retrieves the index of a state
 	@param state CameraEffect
 	@return number? -- index
 
 ]=]
-function CameraStack:GetIndex(state): number?
+function CameraStack.GetIndex(self: CameraStack, state: CameraEffectUtils.CameraLike): number?
 	assert(self._stack, "Stack is not initialized yet")
 
 	for index, value in self._stack do
@@ -169,9 +175,9 @@ end
 	Do not modify this stack, this is the raw memory of the stack
 	:::
 
-	@return { CameraState<T> }
+	@return { CameraLike }
 ]=]
-function CameraStack:GetStack()
+function CameraStack.GetStack(self: CameraStack): { CameraEffectUtils.CameraLike }
 	assert(self._stack, "Not initialized")
 
 	return self._stack
@@ -179,9 +185,9 @@ end
 
 --[=[
 	Removes the state from the stack
-	@param state CameraState
+	@param state CameraLike
 ]=]
-function CameraStack:Remove(state)
+function CameraStack.Remove(self: CameraStack, state: CameraEffectUtils.CameraLike)
 	assert(self._stack, "Stack is not initialized yet")
 
 	local index = self:GetIndex(state)
@@ -194,8 +200,9 @@ end
 --[=[
 	Adds the state from the stack
 	@param state CameraState
+	@return () -> () -- Cleanup function
 ]=]
-function CameraStack:Add(state)
+function CameraStack.Add(self: CameraStack, state: CameraEffectUtils.CameraLike): () -> ()
 	assert(self._stack, "Stack is not initialized yet")
 
 	table.insert(self._stack, state)
@@ -207,4 +214,4 @@ function CameraStack:Add(state)
 	end
 end
 
-return CameraStack
+return CameraStack

package/src/Client/CameraStackService.lua

@@ -7,26 +7,40 @@
 
 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 CameraEffectUtils = require("CameraEffectUtils")
 local CameraStack = require("CameraStack")
+local CameraState = require("CameraState")
 local DefaultCamera = require("DefaultCamera")
 local ImpulseCamera = require("ImpulseCamera")
 local Maid = require("Maid")
 local ServiceBag = require("ServiceBag")
 
-assert(RunService:IsClient(), "[CameraStackService] - Only require CameraStackService on client")
-
 local CameraStackService = {}
 CameraStackService.ServiceName = "CameraStackService"
 
+export type CameraStackService = typeof(setmetatable(
+	{} :: {
+		_maid: Maid.Maid,
+		_cameraStack: CameraStack.CameraStack,
+		_rawDefaultCamera: DefaultCamera.DefaultCamera,
+		_impulseCamera: ImpulseCamera.ImpulseCamera,
+		_defaultCamera: CameraEffectUtils.CameraEffect,
+		_key: string,
+		_serviceBag: ServiceBag.ServiceBag,
+		_started: boolean,
+		_doNotUseDefaultCamera: boolean,
+	},
+	{} :: typeof({ __index = CameraStackService })
+))
 --[=[
 	Initializes a new camera stack. Should be done via the ServiceBag.
 	@param serviceBag ServiceBag
 ]=]
-function CameraStackService:Init(serviceBag: ServiceBag.ServiceBag)
+function CameraStackService.Init(self: CameraStackService, serviceBag: ServiceBag.ServiceBag)
 	assert(ServiceBag.isServiceBag(serviceBag), "Not a valid service bag")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 
@@ -39,17 +53,17 @@ function CameraStackService:Init(serviceBag: ServiceBag.ServiceBag)
 	self._rawDefaultCamera = self._maid:Add(DefaultCamera.new())
 
 	self._impulseCamera = ImpulseCamera.new()
-	self._defaultCamera = (self._rawDefaultCamera + self._impulseCamera):SetMode("Relative")
+	self._defaultCamera = ((self :: any)._rawDefaultCamera + (self :: any)._impulseCamera):SetMode("Relative")
 
 	-- Add camera to stack
 	self:Add(self._defaultCamera)
 end
 
-function CameraStackService:GetRenderPriority()
+function CameraStackService.GetRenderPriority(_self: CameraStackService): number
 	return Enum.RenderPriority.Camera.Value + 75
 end
 
-function CameraStackService:Start()
+function CameraStackService.Start(self: CameraStackService): ()
 	RunService:BindToRenderStep("CameraStackUpdateInternal" .. self._key, self:GetRenderPriority(), function()
 		debug.profilebegin("camerastackservice")
 
@@ -61,7 +75,6 @@ function CameraStackService:Start()
 			state:Set(Workspace.CurrentCamera)
 		end
 
-
 		debug.profileend()
 	end)
 
@@ -88,7 +101,7 @@ end
 	Prevents the default camera from being used
 	@param doNotUseDefaultCamera boolean
 ]=]
-function CameraStackService:SetDoNotUseDefaultCamera(doNotUseDefaultCamera)
+function CameraStackService.SetDoNotUseDefaultCamera(self: CameraStackService, doNotUseDefaultCamera: boolean): ()
 	assert(not self._started, "Already started")
 
 	self._doNotUseDefaultCamera = doNotUseDefaultCamera
@@ -98,8 +111,8 @@ end
 	Pushes a disable state onto the camera stack
 	@return function -- Function to cancel disable
 ]=]
-function CameraStackService:PushDisable()
-	assert(self._cameraStack, "Not initialized")
+function CameraStackService.PushDisable(self: CameraStackService): () -> ()
+	self:_ensureInitOrError()
 
 	return self._cameraStack:PushDisable()
 end
@@ -107,8 +120,8 @@ end
 --[=[
 	Outputs the camera stack. Intended for diagnostics.
 ]=]
-function CameraStackService:PrintCameraStack()
-	assert(self._cameraStack, "Not initialized")
+function CameraStackService.PrintCameraStack(self: CameraStackService): ()
+	self:_ensureInitOrError()
 
 	return self._cameraStack:PrintCameraStack()
 end
@@ -117,7 +130,7 @@ end
 	Returns the default camera
 	@return SummedCamera -- DefaultCamera + ImpulseCamera
 ]=]
-function CameraStackService:GetDefaultCamera()
+function CameraStackService.GetDefaultCamera(self: CameraStackService): CameraEffectUtils.CameraEffect
 	assert(self._defaultCamera, "Not initialized")
 
 	return self._defaultCamera
@@ -142,7 +155,7 @@ end
 
 	@return ImpulseCamera
 ]=]
-function CameraStackService:GetImpulseCamera()
+function CameraStackService.GetImpulseCamera(self: CameraStackService): ImpulseCamera.ImpulseCamera
 	assert(self._impulseCamera, "Not initialized")
 
 	return self._impulseCamera
@@ -152,7 +165,7 @@ end
 	Returns the default camera without any impulse cameras
 	@return DefaultCamera
 ]=]
-function CameraStackService:GetRawDefaultCamera()
+function CameraStackService.GetRawDefaultCamera(self: CameraStackService): DefaultCamera.DefaultCamera
 	assert(self._rawDefaultCamera, "Not initialized")
 
 	return self._rawDefaultCamera
@@ -162,8 +175,8 @@ end
 	Gets the camera current on the top of the stack
 	@return CameraEffect
 ]=]
-function CameraStackService:GetTopCamera()
-	assert(self._cameraStack, "Not initialized")
+function CameraStackService.GetTopCamera(self: CameraStackService): CameraEffectUtils.CameraLike
+	self:_ensureInitOrError()
 
 	return self._cameraStack:GetTopCamera()
 end
@@ -172,8 +185,8 @@ end
 	Retrieves the top state off the stack at this time
 	@return CameraState?
 ]=]
-function CameraStackService:GetTopState()
-	assert(self._cameraStack, "Not initialized")
+function CameraStackService.GetTopState(self: CameraStackService): CameraState.CameraState?
+	self:_ensureInitOrError()
 
 	return self._cameraStack:GetTopState()
 end
@@ -184,8 +197,8 @@ end
 	@return CustomCameraEffect -- Effect below
 	@return (CameraState) -> () -- Function to set the state
 ]=]
-function CameraStackService:GetNewStateBelow()
-	assert(self._cameraStack, "Not initialized")
+function CameraStackService.GetNewStateBelow(self: CameraStackService)
+	self:_ensureInitOrError()
 
 	return self._cameraStack:GetNewStateBelow()
 end
@@ -196,8 +209,8 @@ end
 	@return number? -- index
 
 ]=]
-function CameraStackService:GetIndex(state)
-	assert(self._cameraStack, "Not initialized")
+function CameraStackService.GetIndex(self: CameraStackService, state: CameraEffectUtils.CameraEffect): number?
+	self:_ensureInitOrError()
 
 	return self._cameraStack:GetIndex(state)
 end
@@ -211,10 +224,10 @@ end
 
 	@return { CameraState<T> }
 ]=]
-function CameraStackService:GetRawStack()
-	assert(self._cameraStack, "Not initialized")
+function CameraStackService.GetRawStack(self: CameraStackService): { CameraEffectUtils.CameraLike }
+	self:_ensureInitOrError()
 
-	return self._cameraStack:GetRawStack()
+	return self._cameraStack:GetStack()
 end
 
 --[=[
@@ -222,8 +235,8 @@ end
 
 	@return CameraStack
 ]=]
-function CameraStackService:GetCameraStack()
-	assert(self._cameraStack, "Not initialized")
+function CameraStackService.GetCameraStack(self: CameraStackService): CameraStack.CameraStack
+	self:_ensureInitOrError()
 
 	return self._cameraStack
 end
@@ -232,8 +245,8 @@ end
 	Removes the state from the stack
 	@param state CameraState
 ]=]
-function CameraStackService:Remove(state)
-	assert(self._cameraStack, "Not initialized")
+function CameraStackService.Remove(self: CameraStackService, state: CameraEffectUtils.CameraEffect)
+	self:_ensureInitOrError()
 
 	return self._cameraStack:Remove(state)
 end
@@ -241,15 +254,20 @@ end
 --[=[
 	Adds the state from the stack
 	@param state CameraState
+	@return () -> () -- Cleanup function
 ]=]
-function CameraStackService:Add(state)
-	assert(self._cameraStack, "Not initialized")
+function CameraStackService.Add(self: CameraStackService, state: CameraEffectUtils.CameraEffect): () -> ()
+	self:_ensureInitOrError()
 
 	return self._cameraStack:Add(state)
 end
 
-function CameraStackService:Destroy()
+function CameraStackService._ensureInitOrError(self: CameraStackService)
+	assert(self._cameraStack, "Not initialized. Initialize via ServiceBag")
+end
+
+function CameraStackService.Destroy(self: CameraStackService)
 	self._maid:DoCleaning()
 end
 
-return CameraStackService
+return CameraStackService

package/src/Client/CameraState.lua

@@ -6,9 +6,9 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local QFrame = require("QFrame")
 local CameraFrame = require("CameraFrame")
 local DuckTypeUtils = require("DuckTypeUtils")
+local QFrame = require("QFrame")
 
 local CameraState = {}
 CameraState.ClassName = "CameraState"
@@ -69,15 +69,15 @@ end
 	@prop cframe CFrame
 	@within CameraState
 ]=]
-function CameraState:__index(index)
+function CameraState.__index(self: CameraState, index)
 	if index == "CFrame" then
 		return self.CameraFrame.CFrame
 	elseif index == "Position" then
 		return self.CameraFrame.Position
 	elseif index == "CameraFrame" then
-		return rawget(self, "CameraFrame")
+		return rawget(self :: any, "CameraFrame")
 	elseif index == "CameraFrameDerivative" then
-		return rawget(self, "CameraFrameDerivative")
+		return rawget(self :: any, "CameraFrameDerivative")
 	elseif index == "Velocity" then
 		return self.CameraFrameDerivative.Position
 	elseif index == "FieldOfView" then
@@ -87,7 +87,7 @@ function CameraState:__index(index)
 	end
 end
 
-function CameraState:__newindex(index, value)
+function CameraState.__newindex(self: CameraState, index, value)
 	if index == "CFrame" then
 		self.CameraFrame.CFrame = value
 	elseif index == "Position" then
@@ -97,7 +97,7 @@ function CameraState:__newindex(index, value)
 	elseif index == "FieldOfView" then
 		self.CameraFrame.FieldOfView = value
 	elseif index == "CameraFrame" or index == "CameraFrameDerivative" then
-		rawset(self, index, value)
+		rawset(self :: any, index, value)
 	else
 		error(string.format("'%s' is not a valid index of CameraState", tostring(index)))
 	end
@@ -107,9 +107,9 @@ end
 	Set another camera state. Typically used to set Workspace.CurrentCamera's state to match this camera's state
 	@param camera Camera -- A CameraState to set, also accepts a Roblox Camera
 ]=]
-function CameraState:Set(camera: Camera)
+function CameraState.Set(self: CameraState, camera: Camera)
 	camera.FieldOfView = self.FieldOfView
 	camera.CFrame = self.CFrame
 end
 
-return CameraState
+return CameraState

package/src/Client/CameraUtils.lua

@@ -81,4 +81,4 @@ function CameraUtils.isOnScreen(camera: Camera, position: Vector3): boolean
 	return onScreen
 end
 
-return CameraUtils
+return CameraUtils

package/src/Client/CameraUtils.story.lua

@@ -2,7 +2,8 @@
 	@class CameraUtils.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 Maid = require("Maid")
 
@@ -25,7 +26,7 @@ return function(target: Instance)
 
 	local ball: Part = maid:Add(Instance.new("Part"))
 	ball.Color = Color3.new(1, 0.5, 0.5)
-	ball.Size = Vector3.new(2*radius, 2*radius, 2*radius)
+	ball.Size = Vector3.new(2 * radius, 2 * radius, 2 * radius)
 	ball.Shape = Enum.PartType.Ball
 	ball.CFrame = CFrame.new()
 	ball.Anchored = true
@@ -34,7 +35,7 @@ return function(target: Instance)
 	local function update()
 		local absSize = viewportFrame.AbsoluteSize
 		if absSize.x > 0 and absSize.y > 0 then
-			local aspectRatio = absSize.x/absSize.y
+			local aspectRatio = absSize.x / absSize.y
 			local dist = CameraUtils.fitSphereToCamera(radius, camera.FieldOfView, aspectRatio)
 			camera.CFrame = CFrame.new(0, 0, dist)
 		end
@@ -48,4 +49,4 @@ return function(target: Instance)
 	return function()
 		maid:DoCleaning()
 	end
-end
+end