@quenty/uiobjectutils 3.4.0 → 3.5.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/uiobjectutils@3.4.0...@quenty/uiobjectutils@3.5.0) (2023-12-14)
+
+
+### Features
+
+* Add PlayerGuiUtils.findPlayerGui() and documentation ([8f6ddd7](https://github.com/Quenty/NevermoreEngine/commit/8f6ddd7186b296dfe158f66f666bc08b02d02e8a))
+* Add ScrollingDirectionUtils.canScrollHorizontal(scrollingDirection) ([0b18d30](https://github.com/Quenty/NevermoreEngine/commit/0b18d30af7003ce4abb75398490d40d4afb530ac))
+
+
+
+
+
 # [3.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/uiobjectutils@3.3.0...@quenty/uiobjectutils@3.4.0) (2023-05-26)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/uiobjectutils",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "UI object utils library for Roblox",
   "keywords": [
     "Roblox",
@@ -27,5 +27,9 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "11058e90e51ea83d3dad6ae9abe59cc19c36b94b"
+  "dependencies": {
+    "@quenty/enumutils": "^3.1.0",
+    "@quenty/loader": "^7.1.0"
+  },
+  "gitHead": "2c2dbbc0cb2fbb46b4f3270c559c63890fe18b26"
 }

package/src/Client/PlayerGuiUtils.lua

@@ -1,4 +1,5 @@
 --[=[
+	Helper methods for finding and retrieving the [PlayerGui] instance
 	@class PlayerGuiUtils
 ]=]
 
@@ -6,13 +7,43 @@ local Players = game:GetService("Players")
 
 local PlayerGuiUtils = {}
 
+--[=[
+	Finds the current player gui for the [Players.LocalPlayer] property or errors.
+
+	:::warning
+	This method errors if it can't find the PlayerGui. Fortunately, the PlayerGui is pretty much
+	guaranteed to exist in most scenarios.
+	:::
+
+	@return PlayerGui
+]=]
 function PlayerGuiUtils.getPlayerGui()
 	local localPlayer = Players.LocalPlayer
 	if not localPlayer then
-		error("No localPlayer")
+		error("[PlayerGuiUtils.getPlayerGui] - No localPlayer")
+	end
+
+	local playerGui = localPlayer:FindFirstChildOfClass("PlayerGui")
+	if not playerGui then
+		error("[PlayerGuiUtils.getPlayerGui] - No playerGui")
+	end
+
+	return playerGui
+end
+
+--[=[
+	Finds the current player gui for the [Players.LocalPlayer] property.
+
+	@return PlayerGui | nil
+]=]
+function PlayerGuiUtils.findPlayerGui()
+	local localPlayer = Players.LocalPlayer
+	if not localPlayer then
+		return nil
 	end
 
-	return localPlayer:FindFirstChildOfClass("PlayerGui") or error("No PlayerGui")
+	return localPlayer:FindFirstChildOfClass("PlayerGui")
 end
 
+
 return PlayerGuiUtils

package/src/Client/ScrollingDirectionUtils.lua

@@ -0,0 +1,23 @@
+--[=[
+	@class ScrollingDirectionUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local EnumUtils = require("EnumUtils")
+
+local ScrollingDirectionUtils = {}
+
+function ScrollingDirectionUtils.canScrollHorizontal(scrollingDirection)
+	assert(EnumUtils.isOfType(Enum.ScrollingDirection, scrollingDirection))
+
+	return scrollingDirection == Enum.ScrollingDirection.X or scrollingDirection == Enum.ScrollingDirection.XY
+end
+
+function ScrollingDirectionUtils.canScrollVertical(scrollingDirection)
+	assert(EnumUtils.isOfType(Enum.ScrollingDirection, scrollingDirection))
+
+	return scrollingDirection == Enum.ScrollingDirection.Y or scrollingDirection == Enum.ScrollingDirection.XY
+end
+
+return ScrollingDirectionUtils

package/src/Client/UIRotationUtils.lua

@@ -0,0 +1,33 @@
+--[=[
+	@class UIRotationUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local UIRotationUtils = {}
+
+function UIRotationUtils.toUnitCircle(rotationDegrees)
+	assert(type(rotationDegrees) == "number", "Bad rotationDegrees")
+
+	return -rotationDegrees + 90
+end
+
+function UIRotationUtils.toUnitCircleDirection(rotationDegrees)
+	assert(type(rotationDegrees) == "number", "Bad rotationDegrees")
+
+	local angle = math.rad(UIRotationUtils.toUnitCircle(rotationDegrees))
+
+	local x = math.cos(angle)
+	local y = math.sin(angle)
+
+	return Vector2.new(x, y)
+end
+
+function UIRotationUtils.toGuiDirection(unitCircleDirection)
+	assert(typeof(unitCircleDirection) == "Vector2", "Bad rotationAnchorPoint")
+
+	return unitCircleDirection*Vector2.new(1, -1)
+end
+
+
+return UIRotationUtils

package/src/node_modules.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "node_modules",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": { "optional": "../node_modules" }
+  }
+}