nullbite/nulllib-lua
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

PartsManager: rename misleading functions

Browse Source 
Added alias to old functions with deprecation notice
This commit is contained in:
NullBite 2023-06-26 14:09:50 -04:00
parent a8155f5941
commit b891cf1efc
Signed by: nullbite
GPG Key ID: 6C4D545385D4925A
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
PartsManager.lua
View File

@ -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