From b891cf1efce1f68b1be09063e4cb83af5ac8a180 Mon Sep 17 00:00:00 2001
From: NullBite <me@nullbite.com>
Date: Mon, 26 Jun 2023 14:09:50 -0400
Subject: [PATCH] PartsManager: rename misleading functions

Added alias to old functions with deprecation notice
---
 PartsManager.lua | 22 ++++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)

diff --git a/PartsManager.lua b/PartsManager.lua
index 6a3c647..82d26e6 100644
--- a/PartsManager.lua
+++ b/PartsManager.lua
@@ -39,15 +39,20 @@ function PartsManager.setInitialValue(part, init)
 end
 
 --- Set initial value for chain on all objects in table.
---- @param group table A table containing objects with a setEnabled() method.
+--- @param list table A table containing objects with a setEnabled() method.
 --- @param init? boolean Default value for chain. Should only be set once, subsequent uses overwrite the entire chain's initial value.
-function PartsManager.setGroupInitialValue(group, init)
+function PartsManager.setListInitialValue(list, init)
 	assert(init~=nil)
-	for _, v in pairs(group) do
+	for _, v in pairs(list) do
 		PartsManager.setInitialValue(v, init)
 	end
 end
 
+---@deprecated misleading naming, use setListInitialValue instead
+function PartsManager.setGroupInitialValue(list, init)
+	return PartsManager.setListInitialValue(list, init)
+end
+
 --- Evaluate a part's chain to determine if it should be visible.
 --- @param part table An object managed by PartsManager.
 function PartsManager.evaluatePart(part)
@@ -76,13 +81,18 @@ function PartsManager.refreshAll()
 end
 
 --- Add function to list of parts in PartsManager
---- @param group table A table containing objects with a setEnabled() method.
+--- @param list table A table containing objects with a setEnabled() method.
 --- @param func function Function to add to each model part's function chain.
 --- @param default? boolean Default value for chain. Should only be set once, subsequent uses overwrite the entire chain's initial value.
-function PartsManager.addPartGroupFunction(group, func, default)
-	for _, v in ipairs(group) do
+function PartsManager.addPartListFunction(list, func, default)
+	for _, v in ipairs(list) do
 		PartsManager.addPartFunction(v, func, default)
 	end
 end
 
+---@deprecated misleading naming, use addPartListFunction instead
+function PartsManager.addPartGroupFunction(list, func, default)
+	return PartsManager.addPartListFunction(list, func, default)
+end
+
 return PartsManager