@quenty/genericscreenguiprovider 13.17.0 → 13.18.0-canary.527.65d09e1.0

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.0-canary.527.65d09e1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/genericscreenguiprovider@13.17.0...@quenty/genericscreenguiprovider@13.18.0-canary.527.65d09e1.0) (2025-01-17)
+
+
+### Features
+
+* Allow order t obe set ([7edc784](https://github.com/Quenty/NevermoreEngine/commit/7edc784fa0983895fc9260adaf73a8e5012144fa))
+
+
+
+
+
 # [13.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/genericscreenguiprovider@13.16.0...@quenty/genericscreenguiprovider@13.17.0) (2024-12-15)
 
 **Note:** Version bump only for package @quenty/genericscreenguiprovider

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/genericscreenguiprovider",
-  "version": "13.17.0",
+  "version": "13.18.0-canary.527.65d09e1.0",
   "description": "Providers screenGuis with a given display order for easy use",
   "keywords": [
     "Roblox",
@@ -24,16 +24,17 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/blend": "^12.15.0",
-    "@quenty/loader": "^10.7.1",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/servicebag": "^11.10.0",
-    "@quenty/string": "^3.3.0",
-    "@quenty/uiobjectutils": "^6.14.0",
-    "@quenty/valueobject": "^13.15.0"
+    "@quenty/blend": "12.16.0-canary.527.65d09e1.0",
+    "@quenty/loader": "10.7.1",
+    "@quenty/maid": "3.4.0",
+    "@quenty/rx": "13.15.0",
+    "@quenty/servicebag": "11.10.0",
+    "@quenty/string": "3.3.0",
+    "@quenty/uiobjectutils": "6.14.0",
+    "@quenty/valueobject": "13.15.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0a20ace4dc7d38f8c889bf73b716b33e8a767c54"
+  "gitHead": "65d09e10d2b3519746fd1bcd592425cd985dbaf6"
 }

package/src/Client/GenericScreenGuiProvider.lua

@@ -32,6 +32,7 @@ local Maid = require("Maid")
 local ScreenGuiService = require("ScreenGuiService")
 local ServiceBag = require("ServiceBag")
 local String = require("String")
+local ValueObject = require("ValueObject")
 
 local GenericScreenGuiProvider = {}
 GenericScreenGuiProvider.ClassName = "GenericScreenGuiProvider"
@@ -46,7 +47,7 @@ function GenericScreenGuiProvider.new(orders)
 	assert(type(orders) == "table", "Bad orders")
 
 	local self = setmetatable({
-		_order = orders;
+		_defaultOrders = orders;
 	}, GenericScreenGuiProvider)
 
 	return self
@@ -57,6 +58,11 @@ function GenericScreenGuiProvider:Init(serviceBag)
 	self._maid = Maid.new()
 
 	self._screenGuiService = self._serviceBag:GetService(ScreenGuiService)
+
+	self._orderValues = {}
+	for key, value in self._defaultOrders do
+		self._orderValues[key] = self._maid:Add(ValueObject.new(value, "number"))
+	end
 end
 
 function GenericScreenGuiProvider:Start()
@@ -107,12 +113,19 @@ function GenericScreenGuiProvider:ObserveScreenGui(orderName)
 		Name = String.toCamelCase(orderName);
 		ResetOnSpawn = false;
 		AutoLocalize = false;
-		DisplayOrder = self:GetDisplayOrder(orderName);
+		DisplayOrder = self:ObserveDisplayOrder(orderName);
 		Parent = self:_getScreenGuiService():ObservePlayerGui();
 		ZIndexBehavior = Enum.ZIndexBehavior.Sibling;
 	}
 end
 
+function GenericScreenGuiProvider:SetDisplayOrder(orderName, order)
+	assert(type(orderName) == "string", "Bad orderName")
+	self:_assertOrderExists(orderName)
+
+	return self._orderValues[orderName]:Mount(order)
+end
+
 --[=[
 	Returns a new ScreenGui at DisplayOrder specified
 	@param orderName string -- Order name of display order
@@ -120,6 +133,7 @@ end
 ]=]
 function GenericScreenGuiProvider:Get(orderName)
 	assert(type(orderName) == "string", "Bad orderName")
+	self:_assertOrderExists(orderName)
 
 	if not RunService:IsRunning() then
 		local frame = Instance.new("Frame")
@@ -152,9 +166,29 @@ end
 ]=]
 function GenericScreenGuiProvider:GetDisplayOrder(orderName)
 	assert(type(orderName) == "string", "Bad orderName")
-	assert(self._order[orderName], string.format("No DisplayOrder with orderName '%s'", tostring(orderName)))
+	self:_assertOrderExists(orderName)
+
+	return self._orderValues[orderName].Value
+end
 
-	return self._order[orderName]
+--[=[
+	Retrieve the display order for a given order.
+	@param orderName string -- Order name of display order
+	@return Observable<number>
+]=]
+function GenericScreenGuiProvider:ObserveDisplayOrder(orderName)
+	assert(type(orderName) == "string", "Bad orderName")
+	self:_assertOrderExists(orderName)
+
+	return self._orderValues[orderName]:Observe()
+end
+
+function GenericScreenGuiProvider:_assertOrderExists(orderName)
+	assert(type(orderName) == "string", "Bad orderName")
+
+	if not self._defaultOrders[orderName] then
+		error(string.format("No DisplayOrder with orderName '%s'", tostring(orderName)))
+	end
 end
 
 function GenericScreenGuiProvider:_getScreenGuiService()