@quenty/linkutils 7.5.0 → 7.6.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.
 
+# [7.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/linkutils@7.5.0...@quenty/linkutils@7.6.0) (2023-02-21)
+
+
+### Features
+
+* Add LinkUtils.setSingleLinkValue ([325fcea](https://github.com/Quenty/NevermoreEngine/commit/325fceab423d57ab89e1c4ffbd549adba3bb6127))
+
+
+
+
+
 # [7.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/linkutils@7.4.0...@quenty/linkutils@7.5.0) (2023-01-11)
 
 **Note:** Version bump only for package @quenty/linkutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/linkutils",
-  "version": "7.5.0",
+  "version": "7.6.0",
   "description": "Utility functions for links. Links are object values pointing to other values!",
   "keywords": [
     "Roblox",
@@ -25,15 +25,15 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^8.4.0",
-    "@quenty/instanceutils": "^7.5.0",
-    "@quenty/loader": "^6.0.1",
+    "@quenty/brio": "^8.5.0",
+    "@quenty/instanceutils": "^7.6.0",
+    "@quenty/loader": "^6.1.0",
     "@quenty/maid": "^2.4.0",
-    "@quenty/promise": "^6.0.1",
-    "@quenty/rx": "^7.4.0"
+    "@quenty/promise": "^6.1.0",
+    "@quenty/rx": "^7.5.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "db2db00ab4e24a3eab0449b77a00bee6d91f2755"
+  "gitHead": "e084b0cc097ddbcb7c782b8ecbd9c2d619c49354"
 }

package/src/Shared/LinkUtils.lua

@@ -25,6 +25,7 @@ function LinkUtils.createLink(linkName, from, to)
 	local objectValue = Instance.new("ObjectValue")
 	objectValue.Name = linkName
 	objectValue.Value = to
+	objectValue.Archivable = false
 	objectValue.Parent = from
 
 	return objectValue
@@ -54,6 +55,51 @@ function LinkUtils.getAllLinkValues(linkName, from)
 	return linkValues
 end
 
+
+--[=[
+	Ensures after operation a single link is pointed to the value, unless the value is "nil"
+	in which case no link will be set
+
+	@param linkName string
+	@param from Instance
+	@param to Instance
+	@return Instance | nil
+]=]
+function LinkUtils.setSingleLinkValue(linkName, from, to)
+	assert(type(linkName) == "string", "Bad linkName")
+	assert(typeof(from) == "Instance", "Bad from")
+	assert(typeof(to) == "Instance" or to == nil, "Bad to")
+
+	if to then
+		local existingLink = nil
+		for _, link in pairs(from:GetChildren()) do
+			if link:IsA("ObjectValue") and link.Name == linkName then
+				if existingLink then
+					link:Destroy()
+				else
+					existingLink = link
+					link.Value = to
+				end
+			end
+		end
+
+		if existingLink then
+			return existingLink
+		end
+
+		return LinkUtils.createLink(linkName, from, to)
+	else
+		for _, link in pairs(from:GetChildren()) do
+			if link:IsA("ObjectValue") and link.Name == linkName then
+				link:Destroy()
+			end
+		end
+
+		return nil
+	end
+end
+
+
 --[=[
 	Gets all links underneath an instance.
 	@param linkName string

package/src/Shared/RxLinkUtils.lua

@@ -31,6 +31,13 @@ function RxLinkUtils.observeValidLinksBrio(linkName, parent)
 		})
 end
 
+--[=[
+	Observes a link value that is not nil.
+
+	@param linkName string
+	@param parent Instance
+	@return Brio<Instance>
+]=]
 function RxLinkUtils.observeLinkValueBrio(linkName, parent)
 	assert(type(linkName) == "string", "linkName should be 'string'")
 	assert(typeof(parent) == "Instance", "parent should be 'Instance'")