@quenty/genericscreenguiprovider 8.1.1 → 8.2.0

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.
 
+# [8.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/genericscreenguiprovider@8.1.1...@quenty/genericscreenguiprovider@8.2.0) (2023-12-14)
+
+**Note:** Version bump only for package @quenty/genericscreenguiprovider
+
+
+
+
+
 ## [8.1.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/genericscreenguiprovider@8.1.0...@quenty/genericscreenguiprovider@8.1.1) (2023-10-28)
 
 **Note:** Version bump only for package @quenty/genericscreenguiprovider

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/genericscreenguiprovider",
-  "version": "8.1.1",
+  "version": "8.2.0",
   "description": "Providers screenGuis with a given display order for easy use",
   "keywords": [
     "Roblox",
@@ -24,13 +24,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/blend": "^7.1.1",
-    "@quenty/loader": "^7.0.0",
+    "@quenty/blend": "^7.2.0",
+    "@quenty/loader": "^7.1.0",
+    "@quenty/maid": "^2.6.0",
+    "@quenty/servicebag": "^7.1.0",
     "@quenty/string": "^3.1.0",
-    "@quenty/uiobjectutils": "^3.4.0"
+    "@quenty/uiobjectutils": "^3.5.0",
+    "@quenty/valueobject": "^8.2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "440aca7ce2b50b74317ee05fdc0b8d1e58001af3"
+  "gitHead": "2c2dbbc0cb2fbb46b4f3270c559c63890fe18b26"
 }

package/src/Client/GenericScreenGuiProvider.lua

@@ -25,12 +25,13 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local Players = game:GetService("Players")
 local RunService = game:GetService("RunService")
 
 local String = require("String")
-local PlayerGuiUtils = require("PlayerGuiUtils")
 local Blend = require("Blend")
+local Maid = require("Maid")
+local ScreenGuiService = require("ScreenGuiService")
+local ServiceBag = require("ServiceBag")
 
 local GenericScreenGuiProvider = {}
 GenericScreenGuiProvider.ClassName = GenericScreenGuiProvider
@@ -50,16 +51,37 @@ function GenericScreenGuiProvider.new(orders)
 	return self
 end
 
+function GenericScreenGuiProvider:Init(serviceBag)
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
+
+	self._screenGuiService = self._serviceBag:GetService(ScreenGuiService)
+end
+
+function GenericScreenGuiProvider:Start()
+
+end
+
 function GenericScreenGuiProvider:__index(index)
 	if GenericScreenGuiProvider[index] then
 		return GenericScreenGuiProvider[index]
+	elseif index == "_screenGuiService"
+		or index == "_serviceBag"
+		or index == "_maid" then
+		return rawget(self, index)
+	else
+		error(string.format("Bad index %q", tostring(index)), 2)
 	end
-
-	error(("Bad index %q"):format(tostring(index)), 2)
 end
 
-function GenericScreenGuiProvider:__newindex(index, _)
-	error(("Bad index %q"):format(tostring(index)), 2)
+function GenericScreenGuiProvider:__newindex(index, value)
+	if index == "_screenGuiService"
+		or index == "_serviceBag"
+		or index == "_maid" then
+		rawset(self, index, value)
+	else
+		error(string.format("Bad index %q", tostring(index)), 2)
+	end
 end
 
 --[=[
@@ -68,8 +90,16 @@ end
 	@return Observable<Instance>
 ]=]
 function GenericScreenGuiProvider:ObserveScreenGui(orderName)
+	assert(type(orderName) == "string", "Bad orderName")
+
 	if not RunService:IsRunning() then
-		return self:_observeMockScreenGui(orderName)
+		return Blend.New "Frame" {
+			Name = String.toCamelCase(orderName);
+			Archivable = false;
+			Size = UDim2.fromScale(1, 1);
+			BackgroundTransparency = 1;
+			Parent = self:_getScreenGuiService():ObservePlayerGui();
+		}
 	end
 
 	return Blend.New "ScreenGui" {
@@ -77,7 +107,7 @@ function GenericScreenGuiProvider:ObserveScreenGui(orderName)
 		ResetOnSpawn = false;
 		AutoLocalize = false;
 		DisplayOrder = self:GetDisplayOrder(orderName);
-		Parent = PlayerGuiUtils.getPlayerGui();
+		Parent = self:_getScreenGuiService():ObservePlayerGui();
 		ZIndexBehavior = Enum.ZIndexBehavior.Sibling;
 	}
 end
@@ -88,21 +118,27 @@ end
 	@return ScreenGui
 ]=]
 function GenericScreenGuiProvider:Get(orderName)
-	if not RunService:IsRunning() then
-		return self:_mockScreenGui(orderName)
-	end
+	assert(type(orderName) == "string", "Bad orderName")
 
-	local localPlayer = Players.LocalPlayer
-	if not localPlayer then
-		error("[GenericScreenGuiProvider] - No localPlayer")
+	if not RunService:IsRunning() then
+		local frame = Instance.new("Frame")
+		frame.Name = String.toCamelCase(orderName)
+		frame.Archivable = false
+		frame.Size = UDim2.fromScale(1, 1)
+		frame.BorderSizePixel = 0
+		frame.BackgroundTransparency = 1
+		frame.BackgroundColor3 = Color3.new(1, 1, 1)
+		frame.Parent = self:_getScreenGuiService():GetPlayerGui()
+		return frame
 	end
 
 	local screenGui = Instance.new("ScreenGui")
 	screenGui.Name = String.toCamelCase(orderName)
 	screenGui.ResetOnSpawn = false
 	screenGui.AutoLocalize = false
+	screenGui.Archivable = false
 	screenGui.DisplayOrder = self:GetDisplayOrder(orderName)
-	screenGui.Parent = PlayerGuiUtils.getPlayerGui()
+	screenGui.Parent = self:_getScreenGuiService():GetPlayerGui()
 	screenGui.ZIndexBehavior = Enum.ZIndexBehavior.Sibling
 
 	return screenGui
@@ -120,53 +156,24 @@ function GenericScreenGuiProvider:GetDisplayOrder(orderName)
 	return self._order[orderName]
 end
 
---[=[
-	Sets up a mock parent for the given target during test mode.
-	@param target GuiBase
-	@return function -- Cleanup function to reset mock parent
-]=]
-function GenericScreenGuiProvider:SetupMockParent(target)
-	assert(not RunService:IsRunning(), "Bad target")
-	assert(target, "Bad target")
-
-	rawset(self, "_mockParent", target)
-
-	return function()
-		if rawget(self, "_mockParent") == target then
-			rawset(self, "_mockParent", nil)
-		end
+function GenericScreenGuiProvider:_getScreenGuiService()
+	if self._screenGuiService then
+		return self._screenGuiService
 	end
-end
-
-function GenericScreenGuiProvider:_mockScreenGui(orderName)
-	assert(type(orderName) == "string", "Bad orderName")
-	assert(rawget(self, "_mockParent"), "No _mockParent set")
-
-	local displayOrder = self:GetDisplayOrder(orderName)
 
-	local mock = Instance.new("Frame")
-	mock.Size = UDim2.new(1, 0, 1, 0)
-	mock.BackgroundTransparency = 1
-	mock.ZIndex = displayOrder
-	mock.Parent = rawget(self, "_mockParent")
+	-- Hack!
+	-- TODO: Don't do this? But what's the alternative..
+	if not RunService:IsRunning() then
+		local serviceBag = ServiceBag.new()
+		self._screenGuiService = serviceBag:GetService(require("ScreenGuiService"))
+		return self._screenGuiService
+	end
 
-	return mock
+	error("Not initialized")
 end
 
-function GenericScreenGuiProvider:_observeMockScreenGui(orderName)
-	assert(type(orderName) == "string", "Bad orderName")
-	assert(rawget(self, "_mockParent"), "No _mockParent set")
-
-	local displayOrder = self:GetDisplayOrder(orderName)
-
-	return Blend.New "Frame" {
-		Size = UDim2.new(1, 0, 1, 0);
-		BackgroundTransparency = 1;
-		ZIndex = displayOrder;
-		Parent = rawget(self, "_mockParent");
-	};
+function GenericScreenGuiProvider:Destroy()
+	self._maid:DoCleaning()
 end
 
-
-
 return GenericScreenGuiProvider

package/src/Client/ScreenGuiService.lua

@@ -0,0 +1,63 @@
+--[=[
+	@class ScreenGuiService
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local RunService = game:GetService("RunService")
+
+local Maid = require("Maid")
+local ValueObject = require("ValueObject")
+local PlayerGuiUtils = require("PlayerGuiUtils")
+
+local ScreenGuiService = {}
+ScreenGuiService.ServiceName = "ScreenGuiService"
+
+function ScreenGuiService:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+
+	self:_ensureInit()
+end
+
+function ScreenGuiService:GetPlayerGui()
+	self:_ensureInit()
+
+	return self._playerGui.Value
+end
+
+function ScreenGuiService:SetGuiParent(playerGui)
+	self:_ensureInit()
+
+	self._playerGui.Value = playerGui
+end
+
+function ScreenGuiService:ObservePlayerGui()
+	self:_ensureInit()
+
+	return self._playerGui:Observe()
+end
+
+function ScreenGuiService:_ensureInit()
+	assert(self ~= ScreenGuiService, "Cannot call directly, use serviceBag")
+
+	if not self._maid then
+		self._maid = Maid.new()
+		self._playerGui = self._maid:Add(ValueObject.new(PlayerGuiUtils.findPlayerGui()))
+
+		-- TODO: Don't do this? But what's the alternative..
+		if not RunService:IsRunning() then
+			if ScreenGuiService._hackPlayerGui then
+				self._playerGui:Mount(ScreenGuiService._hackPlayerGui:Observe())
+			else
+				ScreenGuiService._hackPlayerGui = self._playerGui
+			end
+		end
+	end
+end
+
+function ScreenGuiService:Destroy()
+	self._maid:DoCleaning()
+end
+
+return ScreenGuiService