@quenty/gamescalingutils 13.18.0 → 13.18.1

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [13.18.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/gamescalingutils@13.18.0...@quenty/gamescalingutils@13.18.1) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [13.18.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/gamescalingutils@13.17.2...@quenty/gamescalingutils@13.18.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/gamescalingutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/gamescalingutils",
-  "version": "13.18.0",
+  "version": "13.18.1",
   "description": "Scale ratios for the UI on different devices",
   "keywords": [
     "Roblox",
@@ -28,12 +28,12 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/blend": "^12.18.0",
-    "@quenty/instanceutils": "^13.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/baseobject": "^10.8.1",
+    "@quenty/blend": "^12.18.1",
+    "@quenty/instanceutils": "^13.17.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/rx": "^13.17.1",
+    "@quenty/valueobject": "^13.17.1"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Client/GameScalingHelper.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class GameScalingHelper
 ]=]
@@ -8,42 +9,61 @@ local BaseObject = require("BaseObject")
 local Rx = require("Rx")
 local RxInstanceUtils = require("RxInstanceUtils")
 local ValueObject = require("ValueObject")
+local _Maid = require("Maid")
+local _Observable = require("Observable")
 
 local GameScalingHelper = setmetatable({}, BaseObject)
 GameScalingHelper.ClassName = "GameScalingHelper"
 GameScalingHelper.__index = GameScalingHelper
 
-function GameScalingHelper.new(screenGui)
-	local self = setmetatable(BaseObject.new(), GameScalingHelper)
+export type GameScalingHelper = typeof(setmetatable(
+	{} :: {
+		_maid: _Maid.Maid,
+		_absoluteSize: ValueObject.ValueObject<Vector2>,
+		_isVertical: ValueObject.ValueObject<boolean>,
+		_isSmall: ValueObject.ValueObject<boolean>,
+		_screenGui: ScreenGui?,
+	},
+	{ __index = GameScalingHelper }
+))
+
+function GameScalingHelper.new(screenGui: ScreenGui): GameScalingHelper
+	local self = setmetatable(BaseObject.new() :: any, GameScalingHelper)
 
 	self._absoluteSize = self._maid:Add(ValueObject.new(Vector2.zero, "Vector2"))
 	self._isVertical = self._maid:Add(ValueObject.new(false, "boolean"))
 	self._isSmall = self._maid:Add(ValueObject.new(false, "boolean"))
 
-	self._maid:GiveTask(self._absoluteSize:Observe():Pipe({
-		Rx.map(function(size)
-			if size.x <= 0 or size.y <= 0 then
-				return false
-			end
-
-			return size.x/size.y <= 1
-		end);
-		Rx.distinct()
-	}):Subscribe(function(isVertical)
-		self._isVertical.Value = isVertical
-	end))
-
-	self._maid:GiveTask(self._absoluteSize:Observe():Pipe({
-		Rx.map(function(size)
-			if size.x > 0 and size.y > 0 and math.min(size.x, size.y) < 500 then
-				return true
-			else
-				return false
-			end
-		end);
-	}):Subscribe(function(isSmall)
-		self._isSmall.Value = isSmall
-	end))
+	self._maid:GiveTask(self._absoluteSize
+		:Observe()
+		:Pipe({
+			Rx.map(function(size)
+				if size.x <= 0 or size.y <= 0 then
+					return false
+				end
+
+				return size.x / size.y <= 1
+			end),
+			Rx.distinct() :: any,
+		})
+		:Subscribe(function(isVertical)
+			self._isVertical.Value = isVertical
+		end))
+
+	self._maid:GiveTask(self._absoluteSize
+		:Observe()
+		:Pipe({
+			Rx.map(function(size)
+				if size.x > 0 and size.y > 0 and math.min(size.x, size.y) < 500 then
+					return true
+				else
+					return false
+				end
+			end),
+		})
+		:Subscribe(function(isSmall)
+			self._isSmall.Value = isSmall
+		end))
 
 	if screenGui then
 		self:SetScreenGui(screenGui)
@@ -52,26 +72,36 @@ function GameScalingHelper.new(screenGui)
 	return self
 end
 
-function GameScalingHelper:ObserveIsSmall()
+function GameScalingHelper.ObserveIsSmall(self: GameScalingHelper): _Observable.Observable<boolean>
 	return self._isSmall:Observe()
 end
 
-function GameScalingHelper:ObserveIsVertical()
+function GameScalingHelper.ObserveIsVertical(self: GameScalingHelper): _Observable.Observable<boolean>
 	return self._isVertical:Observe()
 end
 
-function GameScalingHelper:GetAbsoluteSizeSetter()
-	return function(absoluteSize)
+function GameScalingHelper.GetAbsoluteSizeSetter(self: GameScalingHelper): (absoluteSize: Vector2) -> ()
+	return function(absoluteSize: Vector2)
 		self:SetAbsoluteSize(absoluteSize)
 	end
 end
 
-function GameScalingHelper:SetAbsoluteSize(absoluteSize)
-	self._absoluteSize:Mount(absoluteSize)
+--[=[
+	Sets the absolute size of the screen
+]=]
+function GameScalingHelper.SetAbsoluteSize(
+	self: GameScalingHelper,
+	absoluteSize: Vector2 | _Observable.Observable<Vector2>
+): () -> ()
+	return self._absoluteSize:Mount(absoluteSize)
 end
 
-function GameScalingHelper:SetScreenGui(screenGui)
-	self:SetAbsoluteSize(RxInstanceUtils.observeProperty(screenGui, "AbsoluteSize"))
+--[=[
+	Sets the screenGui to observe the absolute size from
+	@param screenGui ScreenGui
+]=]
+function GameScalingHelper.SetScreenGui(self: GameScalingHelper, screenGui: ScreenGui): () -> ()
+	return self:SetAbsoluteSize(RxInstanceUtils.observeProperty(screenGui, "AbsoluteSize"))
 end
 
 return GameScalingHelper

package/src/Client/GameScalingUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Scale ratios for the UI on different devices
 	@class GameScalingUtils
@@ -10,9 +11,15 @@ local GuiService = game:GetService("GuiService")
 local Blend = require("Blend")
 local Rx = require("Rx")
 local RxInstanceUtils = require("RxInstanceUtils")
+local _Observable = require("Observable")
 
 local GameScalingUtils = {}
 
+export type Props = {
+	Parent: Instance?,
+	ScreenGui: ScreenGui,
+}
+
 --[=[
 	Given an screenAbsoluteSize, get a good UI scale to use for fixed offset
 	assuming general UI scales built for 720p monitors.
@@ -20,10 +27,10 @@ local GameScalingUtils = {}
 	@param screenAbsoluteSize Vector2
 	@return number
 ]=]
-function GameScalingUtils.getUIScale(screenAbsoluteSize)
+function GameScalingUtils.getUIScale(screenAbsoluteSize: Vector2): number
 	assert(typeof(screenAbsoluteSize) == "Vector2", "Bad screenAbsoluteSize")
-	local smallestAxis = math.min(screenAbsoluteSize.x, screenAbsoluteSize.y)
-	local height = screenAbsoluteSize.y
+	local smallestAxis = math.min(screenAbsoluteSize.X, screenAbsoluteSize.Y)
+	local height = screenAbsoluteSize.Y
 
 	if GuiService:IsTenFootInterface() then
 		return 2
@@ -45,11 +52,13 @@ end
 	@param screenGui ScreenGui
 	@return Observable<number>
 ]=]
-function GameScalingUtils.observeUIScale(screenGui)
-	return Blend.Spring(RxInstanceUtils.observeProperty(screenGui, "AbsoluteSize")
-		:Pipe({
-			Rx.map(GameScalingUtils.getUIScale)
-		}), 30)
+function GameScalingUtils.observeUIScale(screenGui: ScreenGui): _Observable.Observable<number>
+	return Blend.Spring(
+		RxInstanceUtils.observeProperty(screenGui, "AbsoluteSize"):Pipe({
+			Rx.map(GameScalingUtils.getUIScale) :: any,
+		}),
+		30
+	)
 end
 
 --[=[
@@ -57,16 +66,16 @@ end
 	@param child Instance
 	@return Observable<number>
 ]=]
-function GameScalingUtils.observeUIScaleForChild(child)
+function GameScalingUtils.observeUIScaleForChild(child: Instance): _Observable.Observable<number>
 	return RxInstanceUtils.observeFirstAncestor(child, "ScreenGui"):Pipe({
-		Rx.switchMap(function(screenGui)
+		Rx.switchMap(function(screenGui: ScreenGui?): any
 			if screenGui then
 				return GameScalingUtils.observeUIScale(screenGui)
 			else
 				return Rx.EMPTY
 			end
-		end)
-	})
+		end) :: any,
+	}) :: any
 end
 
 --[=[
@@ -75,47 +84,49 @@ end
 	@param props { Parent: Instance?, ScreenGui: ScreenGui }
 	@return Observable<number>
 ]=]
-function GameScalingUtils.renderUIScale(props)
+function GameScalingUtils.renderUIScale(props: Props): _Observable.Observable<number>
 	assert(props.ScreenGui, "No screenGui")
 
-	return Blend.New "UIScale" {
-		Parent = props.Parent;
-		Scale = GameScalingUtils.observeUIScale(props.ScreenGui)
-	}
+	return Blend.New("UIScale")({
+		Parent = props.Parent,
+		Scale = GameScalingUtils.observeUIScale(props.ScreenGui),
+	})
 end
 
 --[=[
 	Blend equivalent of rendering the dialog padding
 
 	@param props { Parent: Instance?, ScreenGui: ScreenGui }
-	@return Observable<number>
+	@return Observable<UIPadding>
 ]=]
-function GameScalingUtils.renderDialogPadding(props)
+function GameScalingUtils.renderDialogPadding(props: Props): _Observable.Observable<UIPadding>
 	assert(props.ScreenGui, "No screenGui")
 
-	return Blend.New "UIPadding" {
-		Parent = props.Parent;
-		PaddingTop = GameScalingUtils.observeDialogPadding(props.ScreenGui);
-		PaddingBottom = GameScalingUtils.observeDialogPadding(props.ScreenGui);
-		PaddingLeft = GameScalingUtils.observeDialogPadding(props.ScreenGui);
-		PaddingRight = GameScalingUtils.observeDialogPadding(props.ScreenGui);
-	}
+	return Blend.New("UIPadding")({
+		Parent = props.Parent,
+		PaddingTop = GameScalingUtils.observeDialogPadding(props.ScreenGui),
+		PaddingBottom = GameScalingUtils.observeDialogPadding(props.ScreenGui),
+		PaddingLeft = GameScalingUtils.observeDialogPadding(props.ScreenGui),
+		PaddingRight = GameScalingUtils.observeDialogPadding(props.ScreenGui),
+	})
 end
 
 --[=[
 	Observes a smoothed out UI scale for a given screenGui
 	@param screenGui ScreenGui
-	@return Observable<number>
+	@return Observable<UDim>
 ]=]
-function GameScalingUtils.observeDialogPadding(screenGui)
-	return Blend.Spring(RxInstanceUtils.observeProperty(screenGui, "AbsoluteSize")
-		:Pipe({
-			Rx.map(GameScalingUtils.getDialogPadding)
-		}), 30):Pipe({
-			Rx.map(function(padding)
-				return UDim.new(0, padding)
-			end);
-		})
+function GameScalingUtils.observeDialogPadding(screenGui: ScreenGui): _Observable.Observable<UDim>
+	return Blend.Spring(
+		RxInstanceUtils.observeProperty(screenGui, "AbsoluteSize"):Pipe({
+			Rx.map(GameScalingUtils.getDialogPadding) :: any,
+		}),
+		30
+	):Pipe({
+		Rx.map(function(padding)
+			return UDim.new(0, padding)
+		end),
+	})
 end
 
 --[=[
@@ -123,9 +134,9 @@ end
 	@param screenAbsoluteSize Vector2
 	@return number
 ]=]
-function GameScalingUtils.getDialogPadding(screenAbsoluteSize)
+function GameScalingUtils.getDialogPadding(screenAbsoluteSize: Vector2): number
 	assert(typeof(screenAbsoluteSize) == "Vector2", "Bad screenAbsoluteSize")
-	local smallestAxis = math.min(screenAbsoluteSize.x, screenAbsoluteSize.y)
+	local smallestAxis = math.min(screenAbsoluteSize.X, screenAbsoluteSize.Y)
 
 	if smallestAxis <= 300 then
 		return 5