@quenty/viewport 11.21.3-canary.550.afa1b3b.0 → 11.21.4-canary.11a5dcf.0

package/CHANGELOG.md

@@ -3,7 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [11.21.3-canary.550.afa1b3b.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/viewport@11.21.2...@quenty/viewport@11.21.3-canary.550.afa1b3b.0) (2025-04-10)
+## [11.21.4-canary.11a5dcf.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/viewport@11.21.3...@quenty/viewport@11.21.4-canary.11a5dcf.0) (2025-05-10)
+
+
+### Bug Fixes
+
+* Additional type checking updates ([05ba29a](https://github.com/Quenty/NevermoreEngine/commit/05ba29a03efc9f3feed74b34f1d9dfb237496214))
+
+
+
+
+
+## [11.21.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/viewport@11.21.2...@quenty/viewport@11.21.3) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/viewport
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/viewport",
-  "version": "11.21.3-canary.550.afa1b3b.0",
+  "version": "11.21.4-canary.11a5dcf.0",
   "description": "Rendering functionality for viewportFrames",
   "keywords": [
     "Roblox",
@@ -25,25 +25,25 @@
   ],
   "dependencies": {
     "@quenty/adorneeutils": "3.3.3",
-    "@quenty/baseobject": "10.8.3-canary.550.afa1b3b.0",
-    "@quenty/basicpane": "13.17.3-canary.550.afa1b3b.0",
-    "@quenty/blend": "12.18.3-canary.550.afa1b3b.0",
-    "@quenty/camera": "14.20.3-canary.550.afa1b3b.0",
-    "@quenty/geometryutils": "6.8.4-canary.550.afa1b3b.0",
-    "@quenty/inputobjectutils": "4.18.3-canary.550.afa1b3b.0",
-    "@quenty/loader": "10.8.3-canary.550.afa1b3b.0",
-    "@quenty/maid": "3.4.3-canary.550.afa1b3b.0",
+    "@quenty/baseobject": "10.8.4-canary.11a5dcf.0",
+    "@quenty/basicpane": "13.17.4-canary.11a5dcf.0",
+    "@quenty/blend": "12.18.4-canary.11a5dcf.0",
+    "@quenty/camera": "14.20.4-canary.11a5dcf.0",
+    "@quenty/geometryutils": "6.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/rx": "13.17.3-canary.550.afa1b3b.0",
-    "@quenty/signal": "7.10.3-canary.550.afa1b3b.0",
-    "@quenty/spring": "10.8.4-canary.550.afa1b3b.0",
-    "@quenty/valueobject": "13.17.3-canary.550.afa1b3b.0"
+    "@quenty/rx": "13.17.4-canary.11a5dcf.0",
+    "@quenty/signal": "7.10.4-canary.11a5dcf.0",
+    "@quenty/spring": "10.8.5-canary.11a5dcf.0",
+    "@quenty/valueobject": "13.17.4-canary.11a5dcf.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "devDependencies": {
-    "@quenty/insertserviceutils": "10.10.4-canary.550.afa1b3b.0"
+    "@quenty/insertserviceutils": "10.10.5-canary.11a5dcf.0"
   },
-  "gitHead": "afa1b3b99b862698c3ab46009497bd507150867c"
+  "gitHead": "11a5dcf7d4c7a0bfbf3337e97d30e8346ea09d3f"
 }

package/src/Client/Viewport.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Creates a ViewportFrame with size fitting and drag controls. This means that the
 	viewport will center the camera around the given instance, and allow the user
@@ -25,28 +26,42 @@ local CircleUtils = require("CircleUtils")
 local Maid = require("Maid")
 local Math = require("Math")
 local Observable = require("Observable")
+local Rx = require("Rx")
+local Signal = require("Signal")
 local SpringObject = require("SpringObject")
 local ValueObject = require("ValueObject")
 local ViewportControls = require("ViewportControls")
-local Signal = require("Signal")
-local Rx = require("Rx")
 
-local MAX_PITCH = math.pi/3
-local MIN_PITCH = -math.pi/3
-local TAU = math.pi*2
+local MAX_PITCH = math.pi / 3
+local MIN_PITCH = -math.pi / 3
+local TAU = math.pi * 2
 
 local Viewport = setmetatable({}, BasicPane)
 Viewport.ClassName = "Viewport"
 Viewport.__index = Viewport
 
+export type Viewport = typeof(setmetatable(
+	{} :: {
+		_current: ValueObject.ValueObject<Instance?>,
+		_transparency: ValueObject.ValueObject<number>,
+		_absoluteSize: ValueObject.ValueObject<Vector2>,
+		_fieldOfView: ValueObject.ValueObject<number>,
+		_controlsEnabled: ValueObject.ValueObject<boolean>,
+		_rotationYawSpring: SpringObject.SpringObject<number>,
+		_rotationPitchSpring: SpringObject.SpringObject<number>,
+		_notifyInstanceSizeChanged: Signal.Signal<()>,
+	},
+	{} :: typeof({ __index = Viewport })
+)) & BasicPane.BasicPane
+
 --[=[
 	Constructs a new viewport. Unlike a normal [BasicPane] this will not render anything
 	immediately. See [Viewport.Render] for details.
 
 	@return Viewport
 ]=]
-function Viewport.new()
-	local self = setmetatable(BasicPane.new(), Viewport)
+function Viewport.new(): Viewport
+	local self: Viewport = setmetatable(BasicPane.new() :: any, Viewport)
 
 	self._current = self._maid:Add(ValueObject.new(nil))
 	self._transparency = self._maid:Add(ValueObject.new(0, "number"))
@@ -103,7 +118,7 @@ function Viewport.blend(props)
 	end)
 end
 
-function Viewport:ObserveTransparency(): Observable.Observable<number>
+function Viewport.ObserveTransparency(self: Viewport): Observable.Observable<number>
 	return self._transparency:Observe()
 end
 
@@ -112,7 +127,7 @@ end
 
 	@param enabled boolean
 ]=]
-function Viewport:SetControlsEnabled(enabled: boolean)
+function Viewport.SetControlsEnabled(self: Viewport, enabled: boolean)
 	assert(type(enabled) == "boolean", "Bad enabled")
 
 	self._controlsEnabled.Value = enabled
@@ -123,7 +138,7 @@ end
 
 	@param transparency number
 ]=]
-function Viewport:SetTransparency(transparency: number)
+function Viewport.SetTransparency(self: Viewport, transparency: number)
 	return self._transparency:Mount(transparency or 0)
 end
 
@@ -132,7 +147,7 @@ end
 
 	@param fieldOfView number
 ]=]
-function Viewport:SetFieldOfView(fieldOfView: number)
+function Viewport.SetFieldOfView(self: Viewport, fieldOfView: number)
 	return self._fieldOfView:Mount(fieldOfView or 20)
 end
 
@@ -148,7 +163,7 @@ end
 
 	@param instance Instance?
 ]=]
-function Viewport:SetInstance(instance: Instance?): () -> ()
+function Viewport.SetInstance(self: Viewport, instance: Instance?): () -> ()
 	self._current:Mount(instance)
 
 	return function()
@@ -162,11 +177,11 @@ end
 	Notifies the viewport of the instance size changing. We don't connect to
 	any events here because the instance can be anything.
 ]=]
-function Viewport:NotifyInstanceSizeChanged()
+function Viewport.NotifyInstanceSizeChanged(self: Viewport)
 	self._notifyInstanceSizeChanged:Fire()
 end
 
-function Viewport:SetYaw(yaw: number, doNotAnimate: boolean?)
+function Viewport.SetYaw(self: Viewport, yaw: number, doNotAnimate: boolean?)
 	yaw = yaw % TAU
 
 	self._rotationYawSpring.Position =
@@ -178,14 +193,14 @@ function Viewport:SetYaw(yaw: number, doNotAnimate: boolean?)
 	end
 end
 
-function Viewport:SetPitch(pitch: number, doNotAnimate: boolean?)
+function Viewport.SetPitch(self: Viewport, pitch: number, doNotAnimate: boolean?)
 	self._rotationPitchSpring.Target = math.clamp(pitch, MIN_PITCH, MAX_PITCH)
 	if doNotAnimate then
 		self._rotationPitchSpring.Position = self._rotationPitchSpring.Target
 	end
 end
 
-function Viewport:RotateBy(deltaV2: Vector2, doNotAnimate: boolean?)
+function Viewport.RotateBy(self: Viewport, deltaV2: Vector2, doNotAnimate: boolean?)
 	self:SetYaw(self._rotationYawSpring.Value + deltaV2.X, doNotAnimate)
 	self:SetPitch(self._rotationPitchSpring.Value + deltaV2.Y, doNotAnimate)
 end
@@ -211,7 +226,7 @@ end
 	@param props { any }
 	@return Observable<ViewportFrame>
 ]=]
-function Viewport:Render(props)
+function Viewport.Render(self: Viewport, props)
 	local currentCamera = ValueObject.new()
 	self._maid:GiveTask(currentCamera)
 
@@ -231,7 +246,7 @@ function Viewport:Render(props)
 		CurrentCamera = currentCamera,
 		-- selene:allow(roblox_incorrect_color3_new_bounds)
 		LightColor = props.LightColor or Color3.new(brightness, brightness, brightness + 0.15),
-		LightDirection = props.LightDirection or lightDirectionCFrame:vectorToWorldSpace(Vector3.new(0, 0, -1)),
+		LightDirection = props.LightDirection or lightDirectionCFrame:VectorToWorldSpace(Vector3.new(0, 0, -1)),
 		Ambient = props.Ambient or Color3.new(ambientBrightness, ambientBrightness, ambientBrightness + 0.15),
 		ImageTransparency = Blend.Computed(
 			props.Transparency or 0,
@@ -294,16 +309,16 @@ function Viewport:Render(props)
 					self._rotationYawSpring:ObserveRenderStepped(),
 					self._rotationPitchSpring:ObserveRenderStepped(),
 					Rx.fromSignal(self._notifyInstanceSizeChanged):Pipe({
-						Rx.defaultsToNil,
+						Rx.defaultsToNil :: any,
 					}),
-					function(inst, absSize, fov, rotationYaw, rotationPitch)
+					function(inst: Instance, absSize: Vector2, fov: number, rotationYaw: number, rotationPitch: number)
 						if typeof(inst) ~= "Instance" then
 							return CFrame.new()
 						end
 
-						local aspectRatio = absSize.x / absSize.y
+						local aspectRatio = absSize.X / absSize.Y
 						local bbCFrame, bbSize = AdorneeUtils.getBoundingBox(inst)
-						if not bbCFrame then
+						if not (bbCFrame and bbSize) then
 							return CFrame.new()
 						end
 

package/src/Client/Viewport.story.lua

@@ -2,10 +2,11 @@
 	@class Viewport.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")
 local InsertServiceUtils = require("InsertServiceUtils")
+local Maid = require("Maid")
 
 local Viewport = require("Viewport")
 
@@ -15,14 +16,17 @@ return function(target)
 	local viewport = Viewport.new()
 	maid:GiveTask(viewport)
 
-	maid:GivePromise(InsertServiceUtils.promiseAsset(182451181)) --The account must own the asset in order to insert it.
+	maid
+		:GivePromise(InsertServiceUtils.promiseAsset(182451181)) --The account must own the asset in order to insert it.
 		:Then(function(crate)
 			viewport:SetInstance(crate)
 		end)
 
-	maid:GiveTask(viewport:Render({
-		Parent = target;
-	}):Subscribe())
+	maid:GiveTask(viewport
+		:Render({
+			Parent = target,
+		})
+		:Subscribe())
 
 	return function()
 		maid:DoCleaning()

package/src/Client/ViewportControls.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Controls for [Viewport]
 	@class ViewportControls
@@ -6,8 +7,8 @@
 local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
-local Maid = require("Maid")
 local InputObjectUtils = require("InputObjectUtils")
+local Maid = require("Maid")
 local ValueObject = require("ValueObject")
 
 local SENSITIVITY = Vector2.new(8, 4)
@@ -16,14 +17,23 @@ local ViewportControls = setmetatable({}, BaseObject)
 ViewportControls.ClassName = "ViewportControls"
 ViewportControls.__index = ViewportControls
 
+export type ViewportControls = typeof(setmetatable(
+	{} :: {
+		_obj: ViewportFrame,
+		_viewportModel: any,
+		_enabled: ValueObject.ValueObject<boolean>,
+	},
+	{} :: typeof({ __index = ViewportControls })
+)) & BaseObject.BaseObject
+
 --[=[
     Create the controls for dragging.
     @param viewport Instance
     @param viewportModel Viewport
     @return BaseObject
 ]=]
-function ViewportControls.new(viewport: ViewportFrame, viewportModel)
-	local self = setmetatable(BaseObject.new(viewport), ViewportControls)
+function ViewportControls.new(viewport: ViewportFrame, viewportModel: any): ViewportControls
+	local self: ViewportControls = setmetatable(BaseObject.new(viewport) :: any, ViewportControls)
 
 	self._viewportModel = assert(viewportModel, "No rotationYaw")
 	self._enabled = self._maid:Add(ValueObject.new(true, "boolean"))
@@ -48,13 +58,13 @@ end
 
 	@param enabled boolean
 ]=]
-function ViewportControls:SetEnabled(enabled: boolean)
+function ViewportControls.SetEnabled(self: ViewportControls, enabled: boolean)
 	assert(type(enabled) == "boolean", "Bad enabled")
 
 	self._enabled.Value = enabled
 end
 
-function ViewportControls:_startDrag(startInputObject: InputObject)
+function ViewportControls._startDrag(self: ViewportControls, startInputObject: InputObject)
 	if self._maid._dragging then
 		return
 	end
@@ -71,13 +81,16 @@ function ViewportControls:_startDrag(startInputObject: InputObject)
 
 	local lastDelta
 	maid:GiveTask(self._obj.InputChanged:Connect(function(inputObject)
-		if InputObjectUtils.isSameInputObject(inputObject, startInputObject) or inputObject.UserInputType == Enum.UserInputType.MouseMovement then
+		if
+			InputObjectUtils.isSameInputObject(inputObject, startInputObject)
+			or inputObject.UserInputType == Enum.UserInputType.MouseMovement
+		then
 			local position = inputObject.Position
 			local delta = lastPosition - position
 			lastPosition = position
 
 			local absSize = self._obj.AbsoluteSize
-			local deltaV2 = Vector2.new(delta.x, delta.y)/absSize * SENSITIVITY
+			local deltaV2 = Vector2.new(delta.X, delta.Y) / absSize * SENSITIVITY
 			lastDelta = deltaV2
 
 			self._viewportModel:RotateBy(deltaV2, true)
@@ -104,7 +117,7 @@ function ViewportControls:_startDrag(startInputObject: InputObject)
 	self._maid._dragging = maid
 end
 
-function ViewportControls:_stopDrag()
+function ViewportControls._stopDrag(self: ViewportControls)
 	self._maid._dragging = nil
 end