@quenty/settings 11.7.0-canary.490.601c967.0 → 11.8.0

package/CHANGELOG.md

@@ -3,17 +3,34 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [11.7.0-canary.490.601c967.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.6.0...@quenty/settings@11.7.0-canary.490.601c967.0) (2024-08-27)
+# [11.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.7.0...@quenty/settings@11.8.0) (2024-09-12)
 
 
 ### Features
 
+* Simplified settings manager usage ([71fdb58](https://github.com/Quenty/NevermoreEngine/commit/71fdb5870c07e8b73b36bd4b938c4fcca914ba1b))
 * Unedited all changes ([60e64e3](https://github.com/Quenty/NevermoreEngine/commit/60e64e3efce17c10c4b8965871187d231b338dd4))
 
 
 
 
 
+# [11.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.6.1...@quenty/settings@11.7.0) (2024-08-09)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
+## [11.6.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.6.0...@quenty/settings@11.6.1) (2024-07-16)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
 # [11.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.5.0...@quenty/settings@11.6.0) (2024-05-09)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/settings",
-  "version": "11.7.0-canary.490.601c967.0",
+  "version": "11.8.0",
   "description": "Centralized player settings service",
   "keywords": [
     "Roblox",
@@ -25,35 +25,35 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/attributeutils": "14.4.0-canary.490.601c967.0",
-    "@quenty/baseobject": "10.4.0-canary.490.601c967.0",
-    "@quenty/binder": "14.5.0-canary.490.601c967.0",
-    "@quenty/cmdrservice": "13.6.0-canary.490.601c967.0",
-    "@quenty/datastore": "13.6.0-canary.490.601c967.0",
-    "@quenty/ducktype": "5.4.0-canary.490.601c967.0",
-    "@quenty/enumutils": "3.2.0",
-    "@quenty/jsonutils": "10.4.0-canary.490.601c967.0",
-    "@quenty/loader": "10.4.0-canary.490.601c967.0",
-    "@quenty/maid": "3.2.0",
-    "@quenty/observablecollection": "12.4.0-canary.490.601c967.0",
-    "@quenty/playerbinder": "14.5.0-canary.490.601c967.0",
-    "@quenty/playerutils": "8.4.0-canary.490.601c967.0",
-    "@quenty/remotefunctionutils": "10.4.0-canary.490.601c967.0",
-    "@quenty/remoting": "12.5.0-canary.490.601c967.0",
-    "@quenty/rx": "13.4.0-canary.490.601c967.0",
-    "@quenty/rxbinderutils": "14.5.0-canary.490.601c967.0",
-    "@quenty/servicebag": "11.5.0-canary.490.601c967.0",
-    "@quenty/signal": "7.4.0-canary.490.601c967.0",
-    "@quenty/statestack": "14.5.0-canary.490.601c967.0",
-    "@quenty/string": "3.2.0",
-    "@quenty/symbol": "3.1.0",
-    "@quenty/table": "3.5.0",
-    "@quenty/throttle": "10.4.0-canary.490.601c967.0",
-    "@quenty/tie": "10.6.0-canary.490.601c967.0",
-    "@quenty/valueobject": "13.4.0-canary.490.601c967.0"
+    "@quenty/attributeutils": "^14.5.0",
+    "@quenty/baseobject": "^10.4.0",
+    "@quenty/binder": "^14.6.0",
+    "@quenty/cmdrservice": "^13.7.0",
+    "@quenty/datastore": "^13.7.0",
+    "@quenty/ducktype": "^5.4.0",
+    "@quenty/enumutils": "^3.2.0",
+    "@quenty/jsonutils": "^10.4.0",
+    "@quenty/loader": "^10.4.0",
+    "@quenty/maid": "^3.3.0",
+    "@quenty/observablecollection": "^12.5.0",
+    "@quenty/playerbinder": "^14.6.0",
+    "@quenty/playerutils": "^8.5.0",
+    "@quenty/remotefunctionutils": "^10.4.0",
+    "@quenty/remoting": "^12.6.0",
+    "@quenty/rx": "^13.5.0",
+    "@quenty/rxbinderutils": "^14.6.0",
+    "@quenty/servicebag": "^11.5.0",
+    "@quenty/signal": "^7.4.0",
+    "@quenty/statestack": "^14.6.0",
+    "@quenty/string": "^3.2.0",
+    "@quenty/symbol": "^3.1.0",
+    "@quenty/table": "^3.5.0",
+    "@quenty/throttle": "^10.5.0",
+    "@quenty/tie": "^10.7.0",
+    "@quenty/valueobject": "^13.5.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "601c9671f09638be4f326e41fcfe3343ccfe76d8"
+  "gitHead": "fb172906f3ee725269ec1e5f4daf9dca227e729d"
 }

package/src/Shared/Setting/SettingDefinition.lua

@@ -22,9 +22,11 @@ local require = require(script.Parent.loader).load(script)
 
 local Players = game:GetService("Players")
 
+local SettingRegistryServiceShared = require("SettingRegistryServiceShared")
 local SettingProperty = require("SettingProperty")
 local ServiceBag = require("ServiceBag")
 local DuckTypeUtils = require("DuckTypeUtils")
+local Maid = require("Maid")
 
 local SettingDefinition = {}
 SettingDefinition.ClassName = "SettingDefinition"
@@ -44,15 +46,96 @@ function SettingDefinition.new(settingName, defaultValue)
 
 	local self = setmetatable({}, SettingDefinition)
 
-
 	self._settingName = settingName
 	self._defaultValue = defaultValue
 
-	self.ServiceName = self._settingName
+	self.ServiceName = self._settingName .. "SettingDefinition"
 
 	return self
 end
 
+--[=[
+	Initializes the setting definition from a service bag.
+
+	@param serviceBag ServiceBag
+]=]
+function SettingDefinition:Init(serviceBag)
+	assert(serviceBag, "No serviceBag")
+	assert(not self._maid, "Already initialized")
+
+	self._maid = Maid.new()
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+
+	local settingRegistryServiceShared = self._serviceBag:GetService(SettingRegistryServiceShared)
+	self._maid:GiveTask(settingRegistryServiceShared:RegisterSettingDefinition(self))
+end
+
+--[=[
+	Gets the value for the given player
+
+	@param player Player
+	@return T
+]=]
+function SettingDefinition:Get(player)
+	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
+	assert(self._serviceBag, "Retrieve from serviceBag")
+
+	return self:GetSettingProperty(self._serviceBag, player):GetValue()
+end
+
+--[=[
+	Sets the value
+
+	@param player Player
+	@param value T
+]=]
+function SettingDefinition:Set(player, value)
+	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
+	assert(self._serviceBag, "Retrieve from serviceBag")
+
+	return self:GetSettingProperty(self._serviceBag, player):SetValue(value)
+end
+
+--[=[
+	Promise gets the value
+
+	@param player Player
+	@return Promise<T>
+]=]
+function SettingDefinition:Promise(player)
+	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
+	assert(self._serviceBag, "Retrieve from serviceBag")
+
+	return self:GetSettingProperty(self._serviceBag, player):PromiseValue()
+end
+
+--[=[
+	Promise gets the value
+
+	@param player Player
+	@param value T
+	@return Promise<T>
+]=]
+function SettingDefinition:PromiseSet(player, value)
+	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
+	assert(self._serviceBag, "Retrieve from serviceBag")
+
+	return self:GetSettingProperty(self._serviceBag, player):PromiseSetValue(value)
+end
+
+--[=[
+	Promise gets the value
+
+	@param player Player
+	@return Promise<T>
+]=]
+function SettingDefinition:Observe(player)
+	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
+	assert(self._serviceBag, "Retrieve from serviceBag")
+
+	return self:GetSettingProperty(self._serviceBag, player):Observe()
+end
+
 --[=[
 	Returns true if the value is a setting definition
 
@@ -107,4 +190,8 @@ function SettingDefinition:GetDefaultValue()
 	return self._defaultValue
 end
 
+function SettingDefinition:Destroy()
+	self._maid:DoCleaning()
+end
+
 return SettingDefinition

package/src/Shared/Setting/SettingDefinitionProvider.lua

@@ -26,7 +26,6 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local SettingRegistryServiceShared = require("SettingRegistryServiceShared")
 local Maid = require("Maid")
 local SettingDefinition = require("SettingDefinition")
 
@@ -39,6 +38,7 @@ SettingDefinitionProvider.__index = SettingDefinitionProvider
 	Constructs a new provider with a list of [SettingDefinition]'s.
 
 	```lua
+	-- In one location
 	local SettingDefinition = require("SettingDefinition")
 
 	return require("SettingDefinitionProvider").new({
@@ -48,13 +48,28 @@ SettingDefinitionProvider.__index = SettingDefinitionProvider
 	})
 	```
 
+	Usage:
+
+	```lua
+	local ourSettings = serviceBag:GetService(require("OurSettings"))
+
+	print(ourSettings.CameraShake:Get(Players.LocalPlayer), true)
+
+	ourSettings.CameraShake:Set(Players.LocalPlayer, false)
+
+	ourSettings.CameraShake:Promise(Players.LocalPlayer)
+		:Then(function(cameraShake)
+			print(cameraShake)
+		end)
+	```
+
 	@param settingDefinitions { SettingDefinition }
 	@return SettingDefinitionProvider
 ]=]
 function SettingDefinitionProvider.new(settingDefinitions)
 	local self = setmetatable({}, SettingDefinitionProvider)
 
-	self._settingDefinitions = {}
+	self._settingDefinitionList = {}
 	self._lookup = {}
 
 	for key, value in pairs(settingDefinitions) do
@@ -80,7 +95,7 @@ end
 function SettingDefinitionProvider:_addSettingDefinition(settingDefinition)
 	assert(SettingDefinition.isSettingDefinition(settingDefinition), "Bad settingDefinition")
 
-	table.insert(self._settingDefinitions, settingDefinition)
+	table.insert(self._settingDefinitionList, settingDefinition)
 	self._lookup[settingDefinition:GetSettingName()] = settingDefinition
 end
 
@@ -94,10 +109,17 @@ function SettingDefinitionProvider:Init(serviceBag)
 	assert(not self._maid, "Already initialized")
 
 	self._maid = Maid.new()
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+
+	self._initializedDefinitionLookup = {}
+
+	-- Register our setting definitions
+	for _, settingDefinition in pairs(self._settingDefinitionList) do
+		local initialized = self._serviceBag:GetService(settingDefinition)
+		self._initializedDefinitionLookup[settingDefinition] = initialized
 
-	local settingRegistryServiceShared = serviceBag:GetService(SettingRegistryServiceShared)
-	for _, settingDefinition in pairs(self._settingDefinitions) do
-		self._maid:GiveTask(settingRegistryServiceShared:RegisterSettingDefinition(settingDefinition))
+		-- Store lookup to overcome metatable lookup
+		self[settingDefinition:GetSettingName()] = initialized
 	end
 end
 
@@ -114,7 +136,17 @@ end
 	@return { SettingDefinition }
 ]=]
 function SettingDefinitionProvider:GetSettingDefinitions()
-	return self._settingDefinitions
+	if self._serviceBag then
+		local copy = table.clone(self._settingDefinitionList)
+
+		for key, settingDefinition in pairs(copy) do
+			copy[key] = assert(self._initializedDefinitionLookup[settingDefinition], "Missing settingDefinition")
+		end
+
+		return copy
+	end
+
+	return table.clone(self._settingDefinitionList)
 end
 
 --[=[
@@ -143,18 +175,27 @@ function SettingDefinitionProvider:__index(index)
 		error("[SettingDefinitionProvider] - Cannot index provider with nil value")
 	elseif SettingDefinitionProvider[index] then
 		return SettingDefinitionProvider[index]
-	elseif index == "_lookup" or index == "_settingDefinitions" or index == "_maid" then
+	elseif index == "_lookup"
+		or index == "_settingDefinitionList"
+		or index == "_maid"
+		or index == "_initializedDefinitionLookup"
+		or index == "_serviceBag" then
+
 		return rawget(self, index)
 	elseif type(index) == "string" then
 		local lookup = rawget(self, "_lookup")
 		local settingDefinition = lookup[index]
 		if not settingDefinition then
-			error(("Bad index %q into SettingDefinitionProvider"):format(tostring(index)))
+			error(string.format("Bad index %q into SettingDefinitionProvider", tostring(index)))
+		end
+
+		if self._serviceBag then
+			return assert(self._initializedDefinitionLookup[settingDefinition], "Missing settingDefinition")
 		else
 			return settingDefinition
 		end
 	else
-		error(("Bad index %q into SettingDefinitionProvider"):format(tostring(index)))
+		error(string.format("Bad index %q into SettingDefinitionProvider", tostring(index)))
 	end
 end
 
@@ -167,7 +208,16 @@ end
 function SettingDefinitionProvider:Get(settingName)
 	assert(type(settingName) == "string", "Bad settingName")
 
-	return self._lookup[settingName]
+	local found = self._lookup[settingName]
+	if not found then
+		return nil
+	end
+
+	if self._serviceBag then
+		return assert(self._initializedDefinitionLookup[found], "Missing settingDefinition")
+	else
+		return found
+	end
 end
 
 --[=[