@quenty/coreguienabler 6.0.1 → 6.1.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.
 
+# [6.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/coreguienabler@6.0.1...@quenty/coreguienabler@6.1.0) (2023-01-11)
+
+
+### Bug Fixes
+
+* Use CoreGuiEnabler to disable core gui types ([808d020](https://github.com/Quenty/NevermoreEngine/commit/808d020ce49a72e738c7abdc0f918cba40043f46))
+
+
+
+
+
 ## [6.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/coreguienabler@6.0.0...@quenty/coreguienabler@6.0.1) (2022-11-04)
 
 **Note:** Version bump only for package @quenty/coreguienabler

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/coreguienabler",
-  "version": "6.0.1",
+  "version": "6.1.0",
   "description": "Key based CoreGuiEnabler, singleton Use this class to load/unload CoreGuis / other GUIs, by disabling based upon keys Keys are additive, so if you have more than 1 disabled, it's ok.",
   "keywords": [
     "Roblox",
@@ -26,10 +26,11 @@
   "dependencies": {
     "@quenty/characterutils": "^6.0.1",
     "@quenty/loader": "^6.0.1",
-    "@quenty/maid": "^2.4.0"
+    "@quenty/maid": "^2.4.0",
+    "@quenty/rx": "^7.4.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8b9877c26a3fc753409a5114e56717837291279d"
+  "gitHead": "db2db00ab4e24a3eab0449b77a00bee6d91f2755"
 }

package/src/Client/CoreGuiEnabler.lua

@@ -23,6 +23,8 @@ local UserInputService = game:GetService("UserInputService")
 
 local CharacterUtils = require("CharacterUtils")
 local Maid = require("Maid")
+local ObservableSubscriptionTable = require("ObservableSubscriptionTable")
+local Rx = require("Rx")
 
 local CoreGuiEnabler = {}
 CoreGuiEnabler.__index = CoreGuiEnabler
@@ -35,6 +37,9 @@ function CoreGuiEnabler.new()
 
 	self._states = {}
 
+	self._stateSubs = ObservableSubscriptionTable.new()
+	self._maid:GiveTask(self._stateSubs)
+
 	self:AddState(Enum.CoreGuiType.Backpack, function(isEnabled)
 		StarterGui:SetCoreGuiEnabled(Enum.CoreGuiType.Backpack, isEnabled)
 		CharacterUtils.unequipTools(Players.LocalPlayer)
@@ -64,48 +69,82 @@ function CoreGuiEnabler.new()
 end
 
 function CoreGuiEnabler:_addStarterGuiState(stateName)
-	local boolValueName = stateName .. "State"
-	self[boolValueName] = Instance.new("BoolValue")
-	self[boolValueName].Value = false
-
 	self:AddState(stateName, function(isEnabled)
-		self[boolValueName].Value = isEnabled
 		local success, err = pcall(function()
 			StarterGui:SetCore(stateName, isEnabled)
 		end)
 		if not success then
-			warn("Failed to set core", err)
+			warn("[CoreGuiEnabler] - Failed to set core", err)
 		end
 	end)
 end
 
+--[=[
+	Gets the current state
+
+	@param coreGuiState string | CoreGuiType
+	@return boolean
+]=]
+function CoreGuiEnabler:IsEnabled(coreGuiState)
+	local data = self._states[coreGuiState]
+	if not data then
+		error(string.format("[CoreGuiEnabler] - State '%s' does not exist.", tostring(coreGuiState)))
+	end
+
+	return next(data.disabledBy) == nil
+end
+
+--[=[
+	Observes the state whenever it changed
+	@param coreGuiState string | CoreGuiType
+	@return Observable<boolean>
+]=]
+function CoreGuiEnabler:ObserveIsEnabled(coreGuiState)
+	local data = self._states[coreGuiState]
+	if not data then
+		error(string.format("[CoreGuiEnabler] - State '%s' does not exist.", tostring(coreGuiState)))
+	end
+
+	return self._stateSubs:Observe(coreGuiState)
+		:Pipe({
+			Rx.startFrom(function()
+				return { self:IsEnabled(coreGuiState) }
+			end)
+		})
+end
+
 --[=[
 	Adds a state that can be disabled or enabled.
 	@param coreGuiState string | CoreGuiType
-	@param coreGuiStateChangeFunc (isEnabled: boolean)
+	@param onChangeCallback (isEnabled: boolean)
 ]=]
-function CoreGuiEnabler:AddState(coreGuiState, coreGuiStateChangeFunc)
-	assert(type(coreGuiStateChangeFunc) == "function", "must have coreGuiStateChangeFunc as function")
+function CoreGuiEnabler:AddState(coreGuiState, onChangeCallback)
+	assert(type(onChangeCallback) == "function", "must have onChangeCallback as function")
 	assert(self._states[coreGuiState] == nil, "state already exists")
 
-	local realState = {}
-	local lastState = true
+	self._states[coreGuiState] = {
+		lastState = true;
+		onChangeCallback = onChangeCallback;
+		disabledBy = {};
+	}
+end
+
+function CoreGuiEnabler:_setDisabledByKey(coreGuiState, key, value)
+	assert(key ~= nil, "Bad key")
 
-	local function isEnabled()
-		return next(realState) == nil
+	local data = self._states[coreGuiState]
+	if not data then
+		error(string.format("[CoreGuiEnabler] - State '%s' does not exist.", tostring(coreGuiState)))
 	end
 
-	self._states[coreGuiState] = setmetatable({}, {
-		__newindex = function(_, index, value)
-			rawset(realState, index, value)
-
-			local newState = isEnabled()
-			if lastState ~= newState then
-				lastState = newState
-				coreGuiStateChangeFunc(newState)
-			end
-		end;
-	})
+	data.disabledBy[key] = value
+
+	local newState = next(data.disabledBy) == nil
+	if data.lastState ~= newState then
+		data.lastState = newState
+		data.onChangeCallback(newState)
+		self._stateSubs:Fire(coreGuiState, newState)
+	end
 end
 
 --[=[
@@ -115,11 +154,13 @@ end
 	@return function -- Callback function to re-enable the state
 ]=]
 function CoreGuiEnabler:Disable(key, coreGuiState)
+	assert(key ~= nil, "Bad key")
+
 	if not self._states[coreGuiState] then
-		error(("[CoreGuiEnabler] - State '%s' does not exist."):format(tostring(coreGuiState)))
+		error(string.format("[CoreGuiEnabler] - State '%s' does not exist.", tostring(coreGuiState)))
 	end
 
-	self._states[coreGuiState][key] = true
+	self:_setDisabledByKey(coreGuiState, key, true)
 
 	return function()
 		self:Enable(key, coreGuiState)
@@ -132,11 +173,13 @@ end
 	@param coreGuiState string | CoreGuiType
 ]=]
 function CoreGuiEnabler:Enable(key, coreGuiState)
+	assert(key ~= nil, "Bad key")
+
 	if not self._states[coreGuiState] then
-		error(("[CoreGuiEnabler] - State '%s' does not exist."):format(tostring(coreGuiState)))
+		error(string.format("[CoreGuiEnabler] - State '%s' does not exist.", tostring(coreGuiState)))
 	end
 
-	self._states[coreGuiState][key] = nil
+	self:_setDisabledByKey(coreGuiState, key, nil)
 end
 
 return CoreGuiEnabler.new()