From 45d5c701e61f834976313aaf882498bb0af1053a Mon Sep 17 00:00:00 2001
From: lowercasedonkey <lowercasedonkey@gmail.com>
Date: Sun, 20 Dec 2020 17:22:30 -0500
Subject: [PATCH] add doc
---
src/js/itemAvailability.js | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/js/itemAvailability.js b/src/js/itemAvailability.js
index e4ebc606383..1a23c13bead 100644
--- a/src/js/itemAvailability.js
+++ b/src/js/itemAvailability.js
@@ -63,8 +63,8 @@ globalThis.isItemAccessible = (function() {
/**
* Returns array of wearable clothing in format [name, value], basically player facing / game data.
* @param {Map} map Map to look in (such as App.Data.clothes)
- * @param {string} [filter]
- * @param {any} [filterValue]
+ * @param {string} [filter] for example, if we want to filer clothing data by the "harsh" property, pass harsh as the parameter here.
+ * @param {any} [filterValue] remove any clothing where the .filter property does not match this value. Function will evaluate undefined as false.
* @returns {Array}
*/
function array(map, filter, filterValue) {
--
GitLab