@quenty/uiobjectutils 6.15.0 → 6.15.1

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [6.15.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/uiobjectutils@6.15.0...@quenty/uiobjectutils@6.15.1) (2025-03-21)
+
+**Note:** Version bump only for package @quenty/uiobjectutils
+
+
+
+
+
 # [6.15.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/uiobjectutils@6.14.0...@quenty/uiobjectutils@6.15.0) (2025-02-18)
 
 **Note:** Version bump only for package @quenty/uiobjectutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/uiobjectutils",
-  "version": "6.15.0",
+  "version": "6.15.1",
   "description": "UI object utils library for Roblox",
   "keywords": [
     "Roblox",
@@ -28,11 +28,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/brio": "^14.16.0",
+    "@quenty/brio": "^14.16.1",
     "@quenty/enumutils": "^3.4.0",
-    "@quenty/instanceutils": "^13.16.0",
+    "@quenty/instanceutils": "^13.16.1",
     "@quenty/loader": "^10.8.0",
-    "@quenty/rx": "^13.16.0"
+    "@quenty/rx": "^13.16.1"
   },
-  "gitHead": "184a407d8d7366c39009444c3c9a7023cb176471"
+  "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
 }

package/src/Client/GuiInteractionUtils.lua

@@ -16,21 +16,19 @@ local GuiInteractionUtils = {}
 	@param gui GuiObject
 	@return Observable<boolean>
 ]=]
-function GuiInteractionUtils.observeInteractionEnabled(gui)
+function GuiInteractionUtils.observeInteractionEnabled(gui: GuiObject)
 	assert(typeof(gui) == "Instance" and gui:IsA("GuiObject"), "Bad gui")
 
 	return Rx.combineLatest({
-		visible = RxInstanceUtils.observeProperty(gui, "Visible");
-		guiState = RxInstanceUtils.observeProperty(gui, "GuiState");
-		dataModel = RxInstanceUtils.observeFirstAncestorBrio(gui, "DataModel");
+		visible = RxInstanceUtils.observeProperty(gui, "Visible"),
+		guiState = RxInstanceUtils.observeProperty(gui, "GuiState"),
+		dataModel = RxInstanceUtils.observeFirstAncestorBrio(gui, "DataModel"),
 	}):Pipe({
 		Rx.map(function(state)
-			return state.visible
-				and state.guiState ~= Enum.GuiState.NonInteractable
-				and state.dataModel
-				and true or false
-		end);
-		Rx.distinct();
+			return state.visible and state.guiState ~= Enum.GuiState.NonInteractable and state.dataModel and true
+				or false
+		end),
+		Rx.distinct(),
 	})
 end
 
@@ -41,15 +39,14 @@ end
 	@param gui GuiObject
 	@return Observable<Brio>
 ]=]
-function GuiInteractionUtils.observeInteractionEnabledBrio(gui)
+function GuiInteractionUtils.observeInteractionEnabledBrio(gui: GuiObject)
 	assert(typeof(gui) == "Instance" and gui:IsA("GuiObject"), "Bad gui")
 
 	return GuiInteractionUtils.observeInteractionEnabled(gui):Pipe({
 		RxBrioUtils.switchToBrio(function(canInteract)
 			return canInteract
-		end)
+		end),
 	})
 end
 
-
-return GuiInteractionUtils
+return GuiInteractionUtils

package/src/Client/PlayerGuiUtils.lua

@@ -17,7 +17,7 @@ local PlayerGuiUtils = {}
 
 	@return PlayerGui
 ]=]
-function PlayerGuiUtils.getPlayerGui()
+function PlayerGuiUtils.getPlayerGui(): PlayerGui
 	local localPlayer = Players.LocalPlayer
 	if not localPlayer then
 		error("[PlayerGuiUtils.getPlayerGui] - No localPlayer")
@@ -36,7 +36,7 @@ end
 
 	@return PlayerGui | nil
 ]=]
-function PlayerGuiUtils.findPlayerGui()
+function PlayerGuiUtils.findPlayerGui(): PlayerGui?
 	local localPlayer = Players.LocalPlayer
 	if not localPlayer then
 		return nil
@@ -45,5 +45,4 @@ function PlayerGuiUtils.findPlayerGui()
 	return localPlayer:FindFirstChildOfClass("PlayerGui")
 end
 
-
-return PlayerGuiUtils
+return PlayerGuiUtils

package/src/Client/RxClippedRectUtils.lua

@@ -11,21 +11,20 @@ local RxInstanceUtils = require("RxInstanceUtils")
 
 local RxClippedRectUtils = {}
 
-
 --[=[
 	Observes the clipped rect for the given Gui
 
 	@param gui Gui
 	@return Observable<Rect>
 ]=]
-function RxClippedRectUtils.observeClippedRect(gui)
+function RxClippedRectUtils.observeClippedRect(gui: GuiObject)
 	assert(typeof(gui) == "Instance" and gui:IsA("GuiObject"), "Bad GuiBase2d")
 
 	-- At least use our object's size here...
 	return Rx.combineLatest({
-		absolutePosition = RxInstanceUtils.observeProperty(gui, "AbsolutePosition");
-		absoluteSize = RxInstanceUtils.observeProperty(gui, "AbsoluteSize");
-		parentRect = RxClippedRectUtils._observeParentClippedRect(gui);
+		absolutePosition = RxInstanceUtils.observeProperty(gui, "AbsolutePosition"),
+		absoluteSize = RxInstanceUtils.observeProperty(gui, "AbsoluteSize"),
+		parentRect = RxClippedRectUtils._observeParentClippedRect(gui),
 	}):Pipe({
 		Rx.map(function(state)
 			if state.parentRect then
@@ -33,22 +32,28 @@ function RxClippedRectUtils.observeClippedRect(gui)
 			else
 				return Rect.new(Vector2.zero, Vector2.zero)
 			end
-		end);
-		Rx.distinct();
+		end),
+		Rx.distinct(),
 	})
 end
 
-local function clampVector2(value)
-	return Vector2.new(math.clamp(value.x, 0, 1), math.clamp(value.y, 0, 1))
+local function clampVector2(value: Vector2): Vector2
+	return Vector2.new(math.clamp(value.X, 0, 1), math.clamp(value.Y, 0, 1))
 end
 
-function RxClippedRectUtils.observeClippedRectInScale(gui)
+--[=[
+	Observes the clipped rect for the given Gui, but in scale coordinates
+
+	@param gui Gui
+	@return Observable<Rect>
+]=]
+function RxClippedRectUtils.observeClippedRectInScale(gui: GuiObject)
 	assert(typeof(gui) == "Instance" and gui:IsA("GuiObject"), "Bad GuiBase2d")
 
 	return Rx.combineLatest({
-		absolutePosition = RxInstanceUtils.observeProperty(gui, "AbsolutePosition");
-		absoluteSize = RxInstanceUtils.observeProperty(gui, "AbsoluteSize");
-		visibleRect = RxClippedRectUtils.observeClippedRect(gui);
+		absolutePosition = RxInstanceUtils.observeProperty(gui, "AbsolutePosition"),
+		absoluteSize = RxInstanceUtils.observeProperty(gui, "AbsoluteSize"),
+		visibleRect = RxClippedRectUtils.observeClippedRect(gui),
 	}):Pipe({
 		Rx.map(function(state)
 			if state.absoluteSize.x == 0 or state.absoluteSize.y == 0 then
@@ -61,16 +66,16 @@ function RxClippedRectUtils.observeClippedRectInScale(gui)
 			local visibleMin = state.visibleRect.Min
 			local visibleSize = state.visibleRect.Max - visibleMin
 
-			local topLeft = clampVector2((visibleMin - ourMin)/ourSize)
-			local size = clampVector2(visibleSize/ourSize)
+			local topLeft = clampVector2((visibleMin - ourMin) / ourSize)
+			local size = clampVector2(visibleSize / ourSize)
 			local bottomRight = topLeft + size
 			return Rect.new(topLeft, bottomRight)
-		end);
-		Rx.distinct();
+		end),
+		Rx.distinct(),
 	})
 end
 
-function RxClippedRectUtils._observeClippedRectImpl(gui)
+function RxClippedRectUtils._observeClippedRectImpl(gui: GuiObject)
 	if gui:IsA("GuiObject") then
 		return RxInstanceUtils.observeProperty(gui, "ClipsDescendants"):Pipe({
 			Rx.switchMap(function(clipDescendants)
@@ -79,29 +84,34 @@ function RxClippedRectUtils._observeClippedRectImpl(gui)
 				end
 
 				return Rx.combineLatest({
-					absolutePosition = RxInstanceUtils.observeProperty(gui, "AbsolutePosition");
-					absoluteSize = RxInstanceUtils.observeProperty(gui, "AbsoluteSize");
-					parentRect = RxClippedRectUtils._observeParentClippedRect(gui);
+					absolutePosition = RxInstanceUtils.observeProperty(gui, "AbsolutePosition"),
+					absoluteSize = RxInstanceUtils.observeProperty(gui, "AbsoluteSize"),
+					parentRect = RxClippedRectUtils._observeParentClippedRect(gui),
 				}):Pipe({
 					Rx.map(function(state)
 						return RxClippedRectUtils._computeClippedRect(state)
-					end);
+					end),
 				})
-			end)
+			end),
 		})
 	else
 		if not gui:IsA("LayerCollector") then
-			warn(string.format("[RxClippedRectUtils._observeClippedRectImpl] - Unknown gui instance type behind GuiBase2d of class %s - treating as layer collector. Please patch this method.", tostring(gui.ClassName)))
+			warn(
+				string.format(
+					"[RxClippedRectUtils._observeClippedRectImpl] - Unknown gui instance type behind GuiBase2d of class %s - treating as layer collector. Please patch this method.",
+					tostring(gui.ClassName)
+				)
+			)
 		end
 
 		return Rx.combineLatest({
-			absolutePosition = RxInstanceUtils.observeProperty(gui, "AbsolutePosition");
-			absoluteSize = RxInstanceUtils.observeProperty(gui, "AbsoluteSize");
-			parentRect = RxClippedRectUtils._observeParentClippedRect(gui);
+			absolutePosition = RxInstanceUtils.observeProperty(gui, "AbsolutePosition"),
+			absoluteSize = RxInstanceUtils.observeProperty(gui, "AbsoluteSize"),
+			parentRect = RxClippedRectUtils._observeParentClippedRect(gui),
 		}):Pipe({
 			Rx.map(function(state)
 				return RxClippedRectUtils._computeClippedRect(state)
-			end);
+			end),
 		})
 	end
 end
@@ -129,7 +139,7 @@ function RxClippedRectUtils._computeClippedRect(state)
 	return Rect.new(topLeftX, topLeftY, topLeftX + sizeX, topLeftY + sizeY)
 end
 
-function RxClippedRectUtils._observeParentClippedRect(gui)
+function RxClippedRectUtils._observeParentClippedRect(gui: GuiBase2d)
 	assert(typeof(gui) == "Instance" and gui:IsA("GuiBase2d"), "Bad GuiBase2d")
 
 	return RxInstanceUtils.observeFirstAncestor(gui, "GuiObject"):Pipe({
@@ -137,10 +147,10 @@ function RxClippedRectUtils._observeParentClippedRect(gui)
 			if parent then
 				return RxClippedRectUtils._observeClippedRectImpl(parent)
 			else
-				return Rx.of(nil);
+				return Rx.of(nil)
 			end
-		end);
-	});
+		end),
+	})
 end
 
-return RxClippedRectUtils
+return RxClippedRectUtils

package/src/Client/ScrollingDirectionUtils.lua

@@ -1,4 +1,7 @@
+--!strict
 --[=[
+	Utility logic involving scrolling direction
+
 	@class ScrollingDirectionUtils
 ]=]
 
@@ -8,16 +11,22 @@ local EnumUtils = require("EnumUtils")
 
 local ScrollingDirectionUtils = {}
 
-function ScrollingDirectionUtils.canScrollHorizontal(scrollingDirection)
+--[=[
+	Determines if the scrolling direction can scroll horizontally
+]=]
+function ScrollingDirectionUtils.canScrollHorizontal(scrollingDirection: Enum.ScrollingDirection): boolean
 	assert(EnumUtils.isOfType(Enum.ScrollingDirection, scrollingDirection))
 
 	return scrollingDirection == Enum.ScrollingDirection.X or scrollingDirection == Enum.ScrollingDirection.XY
 end
 
-function ScrollingDirectionUtils.canScrollVertical(scrollingDirection)
+--[=[
+	Determines if the scrolling direction can scroll vertically
+]=]
+function ScrollingDirectionUtils.canScrollVertical(scrollingDirection: Enum.ScrollingDirection): boolean
 	assert(EnumUtils.isOfType(Enum.ScrollingDirection, scrollingDirection))
 
 	return scrollingDirection == Enum.ScrollingDirection.Y or scrollingDirection == Enum.ScrollingDirection.XY
 end
 
-return ScrollingDirectionUtils
+return ScrollingDirectionUtils

package/src/Client/UIAlignmentUtils.lua

@@ -6,39 +6,39 @@
 local UIAlignmentUtils = {}
 
 local HORIZONTAL_ALIGNMENT = {
-	[Enum.HorizontalAlignment.Left] = 0;
-	[Enum.HorizontalAlignment.Center] = 0.5;
-	[Enum.HorizontalAlignment.Right] = 1;
+	[Enum.HorizontalAlignment.Left] = 0,
+	[Enum.HorizontalAlignment.Center] = 0.5,
+	[Enum.HorizontalAlignment.Right] = 1,
 }
 
 local HORIZONTAL_BIAS = {
-	[Enum.HorizontalAlignment.Left] = -1;
-	[Enum.HorizontalAlignment.Center] = 0;
-	[Enum.HorizontalAlignment.Right] = 1;
+	[Enum.HorizontalAlignment.Left] = -1,
+	[Enum.HorizontalAlignment.Center] = 0,
+	[Enum.HorizontalAlignment.Right] = 1,
 }
 
 local VERTICAL_ALIGNMENT = {
-	[Enum.VerticalAlignment.Top] = 0;
-	[Enum.VerticalAlignment.Center] = 0.5;
-	[Enum.VerticalAlignment.Bottom] = 1;
+	[Enum.VerticalAlignment.Top] = 0,
+	[Enum.VerticalAlignment.Center] = 0.5,
+	[Enum.VerticalAlignment.Bottom] = 1,
 }
 
 local VERTICAL_BIAS = {
-	[Enum.VerticalAlignment.Top] = -1;
-	[Enum.VerticalAlignment.Center] = 0;
-	[Enum.VerticalAlignment.Bottom] = 1;
+	[Enum.VerticalAlignment.Top] = -1,
+	[Enum.VerticalAlignment.Center] = 0,
+	[Enum.VerticalAlignment.Bottom] = 1,
 }
 
 local VERTICAL_TO_HORIZONTAL = {
-	[Enum.VerticalAlignment.Top] = Enum.HorizontalAlignment.Left;
-	[Enum.VerticalAlignment.Center] = Enum.HorizontalAlignment.Center;
-	[Enum.VerticalAlignment.Bottom] = Enum.HorizontalAlignment.Right;
+	[Enum.VerticalAlignment.Top] = Enum.HorizontalAlignment.Left,
+	[Enum.VerticalAlignment.Center] = Enum.HorizontalAlignment.Center,
+	[Enum.VerticalAlignment.Bottom] = Enum.HorizontalAlignment.Right,
 }
 
 local HORIZONTAL_TO_VERTICAL = {
-	[Enum.HorizontalAlignment.Left] = Enum.VerticalAlignment.Top;
-	[Enum.HorizontalAlignment.Center] = Enum.VerticalAlignment.Center;
-	[Enum.HorizontalAlignment.Right] = Enum.VerticalAlignment.Bottom;
+	[Enum.HorizontalAlignment.Left] = Enum.VerticalAlignment.Top,
+	[Enum.HorizontalAlignment.Center] = Enum.VerticalAlignment.Center,
+	[Enum.HorizontalAlignment.Right] = Enum.VerticalAlignment.Bottom,
 }
 
 --[=[
@@ -47,7 +47,7 @@ local HORIZONTAL_TO_VERTICAL = {
 	@param alignment HorizontalAlignment | VertialAlignment
 	@return number
 ]=]
-function UIAlignmentUtils.toNumber(alignment)
+function UIAlignmentUtils.toNumber(alignment: Enum.HorizontalAlignment | Enum.VerticalAlignment): number
 	assert(alignment, "Bad alignment")
 
 	if HORIZONTAL_ALIGNMENT[alignment] then
@@ -64,12 +64,19 @@ end
 	@param verticalAlignment HorizontalAlignment
 	@return HorizontalAlignment
 ]=]
-function UIAlignmentUtils.verticalToHorizontalAlignment(verticalAlignment)
+function UIAlignmentUtils.verticalToHorizontalAlignment(
+	verticalAlignment: Enum.VerticalAlignment
+): Enum.HorizontalAlignment
 	assert(verticalAlignment, "Bad verticalAlignment")
 
 	local found = VERTICAL_TO_HORIZONTAL[verticalAlignment]
 	if not found then
-		error(string.format("[UIAlignmentUtils.verticalToHorizontalAlignment] - Bad verticalAlignment %q", tostring(verticalAlignment)))
+		error(
+			string.format(
+				"[UIAlignmentUtils.verticalToHorizontalAlignment] - Bad verticalAlignment %q",
+				tostring(verticalAlignment)
+			)
+		)
 	end
 	return found
 end
@@ -79,24 +86,30 @@ end
 	@param horizontalAlignment HorizontalAlignment
 	@return VertialAlignment
 ]=]
-function UIAlignmentUtils.horizontalToVerticalAlignment(horizontalAlignment)
+function UIAlignmentUtils.horizontalToVerticalAlignment(
+	horizontalAlignment: Enum.HorizontalAlignment
+): Enum.VerticalAlignment
 	assert(horizontalAlignment, "Bad horizontalAlignment")
 
 	local found = HORIZONTAL_TO_VERTICAL[horizontalAlignment]
 	if not found then
-		error(string.format("[UIAlignmentUtils.horizontalToVerticalAlignment] - Bad horizontalAlignment %q", tostring(horizontalAlignment)))
+		error(
+			string.format(
+				"[UIAlignmentUtils.horizontalToVerticalAlignment] - Bad horizontalAlignment %q",
+				tostring(horizontalAlignment)
+			)
+		)
 	end
 	return found
 end
 
-
 --[=[
 	Converts alignment to bias, as -1, 0, or 1
 
 	@param alignment HorizontalAlignment | VertialAlignment
 	@return number
 ]=]
-function UIAlignmentUtils.toBias(alignment)
+function UIAlignmentUtils.toBias(alignment: Enum.HorizontalAlignment | Enum.VerticalAlignment): number
 	assert(alignment, "Bad alignment")
 
 	if HORIZONTAL_BIAS[alignment] then
@@ -114,7 +127,7 @@ end
 	@param horizontalAlignment HorizontalAlignment
 	@return number
 ]=]
-function UIAlignmentUtils.horizontalAlignmentToNumber(horizontalAlignment)
+function UIAlignmentUtils.horizontalAlignmentToNumber(horizontalAlignment: Enum.HorizontalAlignment): number
 	assert(horizontalAlignment, "Bad horizontalAlignment")
 
 	if HORIZONTAL_ALIGNMENT[horizontalAlignment] then
@@ -130,7 +143,7 @@ end
 	@param horizontalAlignment HorizontalAlignment
 	@return number
 ]=]
-function UIAlignmentUtils.horizontalAlignmentToBias(horizontalAlignment)
+function UIAlignmentUtils.horizontalAlignmentToBias(horizontalAlignment: Enum.HorizontalAlignment): number
 	assert(horizontalAlignment, "Bad horizontalAlignment")
 
 	if HORIZONTAL_BIAS[horizontalAlignment] then
@@ -146,7 +159,7 @@ end
 	@param verticalAlignment VerticalAlignment
 	@return number
 ]=]
-function UIAlignmentUtils.verticalAlignmentToNumber(verticalAlignment)
+function UIAlignmentUtils.verticalAlignmentToNumber(verticalAlignment: Enum.VerticalAlignment): number
 	assert(verticalAlignment, "Bad verticalAlignment")
 
 	if VERTICAL_ALIGNMENT[verticalAlignment] then
@@ -162,7 +175,7 @@ end
 	@param verticalAlignment VerticalAlignment
 	@return number
 ]=]
-function UIAlignmentUtils.verticalAlignmentToBias(verticalAlignment)
+function UIAlignmentUtils.verticalAlignmentToBias(verticalAlignment: Enum.VerticalAlignment): number
 	assert(verticalAlignment, "Bad verticalAlignment")
 
 	if VERTICAL_BIAS[verticalAlignment] then
@@ -172,4 +185,4 @@ function UIAlignmentUtils.verticalAlignmentToBias(verticalAlignment)
 	end
 end
 
-return UIAlignmentUtils
+return UIAlignmentUtils

package/src/Client/UICornerUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class UICornerUtils
 ]=]
@@ -10,7 +11,7 @@ local UICornerUtils = {}
 	@param parent Instance
 	@return UICorner
 ]=]
-function UICornerUtils.fromScale(scale, parent)
+function UICornerUtils.fromScale(scale: number, parent: Instance?): UICorner
 	local uiCorner = Instance.new("UICorner")
 	uiCorner.CornerRadius = UDim.new(scale, 0)
 	uiCorner.Parent = parent
@@ -23,7 +24,7 @@ end
 	@param parent Instance
 	@return UICorner
 ]=]
-function UICornerUtils.fromOffset(offset, parent)
+function UICornerUtils.fromOffset(offset: number, parent: Instance?): UICorner
 	local uiCorner = Instance.new("UICorner")
 	uiCorner.CornerRadius = UDim.new(0, offset)
 	uiCorner.Parent = parent
@@ -31,15 +32,29 @@ function UICornerUtils.fromOffset(offset, parent)
 end
 
 -- framePosition is top left corner
--- returns position, relativePosition, normal
-function UICornerUtils.clampPositionToFrame(framePosition, frameSize, radius, point)
+--[=[
+	Clamps a position to a frame with a rounded corner
+
+	@param framePosition Vector2 -- From top left corner
+	@param frameSize Vector2
+	@param radius number
+	@param point Vector2
+	@return Vector2? -- Position
+	@return Vector2? -- Normal
+]=]
+function UICornerUtils.clampPositionToFrame(
+	framePosition: Vector2,
+	frameSize: Vector2,
+	radius: number,
+	point: Vector2
+): (Vector2?, Vector2?)
 	assert(radius >= 0, "Bad radius")
 	assert(point, "Bad point")
 
-	local px, py = point.x, point.y
+	local px, py = point.X, point.Y
 
-	local fpx, fpy = framePosition.x, framePosition.y
-	local fsx, fsy = frameSize.x, frameSize.y
+	local fpx, fpy = framePosition.X, framePosition.Y
+	local fsx, fsy = frameSize.X, frameSize.Y
 
 	local minx = fpx + radius
 	local maxx = fpx + fsx - radius
@@ -66,14 +81,14 @@ function UICornerUtils.clampPositionToFrame(framePosition, frameSize, radius, po
 
 	-- project in direction of offset
 	local direction = point - position
-	if direction.magnitude == 0 then
+	if direction.Magnitude == 0 then
 		-- Shouldn't happen!
 		return nil, nil
 	end
 
-	local normal = direction.unit
-	local outsidePosition = position + normal*radius
+	local normal = direction.Unit
+	local outsidePosition = position + normal * radius
 	return outsidePosition, normal
 end
 
-return UICornerUtils
+return UICornerUtils

package/src/Client/UIPaddingUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility functions for UI padding
 	@class UIPaddingUtils
@@ -5,7 +6,10 @@
 
 local UIPaddingUtils = {}
 
-function UIPaddingUtils.fromUDim(udim)
+--[=[
+	Constructs a new UIPadding from a UDim
+]=]
+function UIPaddingUtils.fromUDim(udim: UDim): UIPadding
 	local uiPadding = Instance.new("UIPadding")
 	uiPadding.PaddingBottom = udim
 	uiPadding.PaddingTop = udim
@@ -15,22 +19,29 @@ function UIPaddingUtils.fromUDim(udim)
 	return uiPadding
 end
 
-function UIPaddingUtils.getTotalPadding(uiPadding)
-	return UDim2.new(uiPadding.PaddingLeft + uiPadding.PaddingRight,
-		uiPadding.PaddingBottom + uiPadding.PaddingTop)
+--[=[
+	Compute the total padding for the UIPadding
+]=]
+function UIPaddingUtils.getTotalPadding(uiPadding: UIPadding): UDim2
+	return UDim2.new(uiPadding.PaddingLeft + uiPadding.PaddingRight, uiPadding.PaddingBottom + uiPadding.PaddingTop)
 end
 
-function UIPaddingUtils.getTotalAbsolutePadding(uiPadding, absoluteSize)
+--[=[
+	Computes the total absolute padding for a UIPadding
+]=]
+function UIPaddingUtils.getTotalAbsolutePadding(uiPadding: UIPadding, absoluteSize: Vector2): Vector2
 	local padding = UIPaddingUtils.getTotalPadding(uiPadding)
 	return Vector2.new(
-		padding.X.Offset + padding.X.Scale*absoluteSize.x,
-		padding.Y.Offset + padding.Y.Scale*absoluteSize.Y
+		padding.X.Offset + padding.X.Scale * absoluteSize.X,
+		padding.Y.Offset + padding.Y.Scale * absoluteSize.Y
 	)
 end
 
-function UIPaddingUtils.getHorizontalPadding(uiPadding)
+--[=[
+	Compute the horizontal Padding
+]=]
+function UIPaddingUtils.getHorizontalPadding(uiPadding: UIPadding): UDim
 	return uiPadding.PaddingLeft + uiPadding.PaddingRight
 end
 
-
-return UIPaddingUtils
+return UIPaddingUtils

package/src/Client/UIRotationUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class UIRotationUtils
 ]=]
@@ -6,13 +7,19 @@ local require = require(script.Parent.loader).load(script)
 
 local UIRotationUtils = {}
 
-function UIRotationUtils.toUnitCircle(rotationDegrees)
+--[=[
+	Converts a rotation to the unit circle
+]=]
+function UIRotationUtils.toUnitCircle(rotationDegrees: number): number
 	assert(type(rotationDegrees) == "number", "Bad rotationDegrees")
 
 	return -rotationDegrees + 90
 end
 
-function UIRotationUtils.toUnitCircleDirection(rotationDegrees)
+--[=[
+	Converts a rotation to the unit circle direction
+]=]
+function UIRotationUtils.toUnitCircleDirection(rotationDegrees: number): Vector2
 	assert(type(rotationDegrees) == "number", "Bad rotationDegrees")
 
 	local angle = math.rad(UIRotationUtils.toUnitCircle(rotationDegrees))
@@ -23,11 +30,13 @@ function UIRotationUtils.toUnitCircleDirection(rotationDegrees)
 	return Vector2.new(x, y)
 end
 
-function UIRotationUtils.toGuiDirection(unitCircleDirection)
+--[=[
+	Converts a rotation to the gui rotation vector
+]=]
+function UIRotationUtils.toGuiDirection(unitCircleDirection: Vector2): Vector2
 	assert(typeof(unitCircleDirection) == "Vector2", "Bad rotationAnchorPoint")
 
-	return unitCircleDirection*Vector2.new(1, -1)
+	return unitCircleDirection * Vector2.new(1, -1)
 end
 
-
-return UIRotationUtils
+return UIRotationUtils