Beta 2 (#17)

* update tags inferface * beta2 release candidate fixes #16 fixes #11 todo: - equipment recipe - thorough testing of tags features
ChapelR · Feb 19, 2024 · e74a5b6 · e74a5b6
1 parent 4c578f9
commit e74a5b6
Show file tree

Hide file tree

Showing 17 changed files with 1,969 additions and 1,928 deletions.
diff --git a/dist/simple-inventory.css b/dist/simple-inventory.css
diff --git a/dist/simple-inventory.js b/dist/simple-inventory.js
diff --git a/docs/InventoryAPI.md b/docs/InventoryAPI.md
@@ -131,6 +131,14 @@ Cannot be set by users.
 
 Returns the number of unique items in the inventory. Each type of item is only counted once, regardless of the quantity.
 
+### `inventory#tags`
+
+##### ( array )
+
+Cannot be set by users.
+
+Returns the array of tags.
+
 ## `Inventory` Instance Methods
 
 ### `inventory#count()`
@@ -392,6 +400,54 @@ Can be chained.
 
 Can be chained.
 
+### `inventory#hasTag()`
+
+##### Syntax
+
+```
+<inventory>.hasTag(tag)
+```
+
+##### Arguments 
+
+- `tag` (string) a tag to check for  
+
+Returns whether the inventory has the indicated tag.
+
+##### Returns ( boolean )
+
+### `inventory#hasAllTags()`
+
+##### Syntax
+
+```
+<inventory>.hasAllTags(tagList)
+```
+
+##### Arguments 
+
+- `tagList` (string | string array) a list of tags to check for; can be strings passed as individual arguments, an array of strings, or any combination thereof
+
+Returns whether the inventory has **all of** the indicated tag(s).
+
+##### Returns ( boolean )
+
+### `inventory#hasAnyTags()`
+
+##### Syntax
+
+```
+<inventory>.hasAnyTags(tagList)
+```
+
+##### Arguments 
+
+- `tagList` (string | string array) a list of tags to check for; can be strings passed as individual arguments, an array of strings, or any combination thereof
+
+Returns whether the inventory has **any of** the indicated tag(s).
+
+##### Returns ( boolean )
+
 ### `inventory#clone()`
 
 ##### Syntax

diff --git a/docs/ItemAPI.md b/docs/ItemAPI.md
@@ -105,6 +105,14 @@ Replaces the item's ID in the user-interfaces.
 
 Can be set to any string value.
 
+### `item#tags`
+
+##### ( array )
+
+Cannot be set by users.
+
+Returns the array of tags.
+
 ## `Item` Instance Methods
 
 ### `item#use()`
@@ -136,4 +144,52 @@ Creates a dialog box and renders the item's description into it.
 
 ##### Returns ( `this` )
 
-Can be chained.
+Can be chained.
+
+### `item#hasTag()`
+
+##### Syntax
+
+```
+<item>.hasTag(tag)
+```
+
+##### Arguments 
+
+- `tag` (string) a tag to check for  
+
+Returns whether the item has the indicated tag.
+
+##### Returns ( boolean )
+
+### `item#hasAllTags()`
+
+##### Syntax
+
+```
+<item>.hasAllTags(tagList)
+```
+
+##### Arguments 
+
+- `tagList` (string | string array) a list of tags to check for; can be strings passed as individual arguments, an array of strings, or any combination thereof
+
+Returns whether the item has **all of** the indicated tag(s).
+
+##### Returns ( boolean )
+
+### `item#hasAnyTags()`
+
+##### Syntax
+
+```
+<item>.hasAnyTags(tagList)
+```
+
+##### Arguments 
+
+- `tagList` (string | string array) a list of tags to check for; can be strings passed as individual arguments, an array of strings, or any combination thereof
+
+Returns whether the item has **any of** the indicated tag(s).
+
+##### Returns ( boolean )
diff --git a/docs/demo.html b/docs/demo.html
diff --git a/docs/recipes/collectibles.html b/docs/recipes/collectibles.html
diff --git a/docs/recipes/crafting.html b/docs/recipes/crafting.html
diff --git a/docs/recipes/keys.html b/docs/recipes/keys.html
diff --git a/docs/recipes/potions.html b/docs/recipes/potions.html
diff --git a/docs/recipes/shop.html b/docs/recipes/shop.html
diff --git a/docs/recipes/shop/index.twee b/docs/recipes/shop/index.twee
@@ -33,7 +33,7 @@ Config.ui.stowBarInitially = false;
     ["pretty stone", 3]
 ])>>
 
-<<pickup $shop "coal" 10 "gold nugget" 2, "iron ingot" 5>>
+<<pickup $shop "coal" 10 "gold nugget" 2 "iron ingot" 5>>
 <<pickup $storage "iron ingot" 1 "glass shard" 20>>
 <<pickup $player "glass shard" 10 "pretty stone" 20, "gemstone" 5>>
 
@@ -54,20 +54,22 @@ Gold: @@#gold;<<= $gold>>@@
         <span>_item</span> 
         <span class="count">_amount</span> 
         <span class="buy-link">
-            <<link "Buy">>
-                <<if $gold < _price>>
-                    <<run UI.alert("You don't have enough gold!")>>
-                <<else>>
-                    <<gold `-1 * _price`>>
-                    <<transfer $shop $player _item 1>>
-                    <<set _amount -->>
-                    <<if _amount > 0>>
-                        <<replace `"p.buy-listing[data-item=\"" + _item + "\"] > .count"`>>_amount<</replace>>
+            <<capture _item, _amount, _price>>
+                <<link "Buy">>
+                    <<if $gold < _price>>
+                        <<run UI.alert("You don't have enough gold!")>>
                     <<else>>
-                        <<remove `"p.buy-listing[data-item=\"" + _item + "\"]"`>>
+                        <<gold `-1 * _price`>>
+                        <<transfer $shop $player _item 1>>
+                        <<set _amount -->>
+                        <<if _amount > 0>>
+                            <<replace `"p.buy-listing[data-item=\"" + _item + "\"] > .count"`>>_amount<</replace>>
+                        <<else>>
+                            <<remove `"p.buy-listing[data-item=\"" + _item + "\"]"`>>
+                        <</if>>
                     <</if>>
-                <</if>>
-            <</link>>
+                <</link>>
+            <</capture>>
         </span>
     </p>
 <</widget>>
@@ -80,10 +82,8 @@ Gold: @@#gold;<<= $gold>>@@
         <span>_item</span> 
         <span class="count">_amount</span> 
         <span class="sell-link">
-            <<link "Sell">>
-                <<if $gold < _price>>
-                    <<run UI.alert("You don't have enough gold!")>>
-                <<else>>
+            <<capture _item, _amount, _price>>
+                <<link "Sell">>
                     <<gold _price>>
                     <<transfer $player $shop _item 1>>
                     <<set _amount -->>
@@ -92,8 +92,8 @@ Gold: @@#gold;<<= $gold>>@@
                     <<else>>
                         <<remove `"p.sell-listing[data-item=\"" + _item + "\"]"`>>
                     <</if>>
-                <</if>>
-            <</link>>
+                <</link>>
+            <</capture>>
         </span>
     </p>
 <</widget>>
@@ -133,9 +133,7 @@ You arrive at the market!
 <h2>Items for sale:</h2>
 <div class="shopping-interface">
 <<for _item, _amount range $shop.table>>
-    <<capture _item _amount>>
-        <<buylink _item _amount>>
-    <</capture>>
+    <<buylink _item _amount>>
 <</for>>
 </div>
 <br><br>
@@ -145,9 +143,7 @@ You arrive at the market!
 <h2>Items on hand:</h2>
 <div class="shopping-interface">
 <<for _item, _amount range $player.table>>
-    <<capture _item _amount>>
-        <<selllink _item _amount>>
-    <</capture>>
+    <<selllink _item _amount>>
 <</for>>
 </div>
 <br><br>