From 904ecb76dad52d7377342f0e09442d5718aeb459 Mon Sep 17 00:00:00 2001
From: chimchooree <chimchooree@mail.com>
Date: Mon, 14 Nov 2022 13:29:32 -0600
Subject: [PATCH] items, no plural gdd topics

---
 src/blessfrey-gdd/floor-item            | 35 +++++++++++++++++++++++++
 src/blessfrey-gdd/item                  | 13 ++++-----
 src/blessfrey-gdd/{jobs => job}         |  0
 src/blessfrey-gdd/{keywords => keyword} |  0
 src/views/bf-gdd.tpl                    |  2 +-
 5 files changed, 43 insertions(+), 7 deletions(-)
 create mode 100644 src/blessfrey-gdd/floor-item
 rename src/blessfrey-gdd/{jobs => job} (100%)
 rename src/blessfrey-gdd/{keywords => keyword} (100%)

diff --git a/src/blessfrey-gdd/floor-item b/src/blessfrey-gdd/floor-item
new file mode 100644
index 0000000..20446cc
--- /dev/null
+++ b/src/blessfrey-gdd/floor-item
@@ -0,0 +1,35 @@
+    <h2>description </h2>
+    <p>Floor items are the representation of an item that spawns in the environment, drops from opponents, and can be picked up. They are technically tangible entities. <br></p>
+    <br>
+    <h2>structure </h2>
+    <p><ul>
+        <li>Node2D - $ThreeLeafClover (floor_item.gd, inherits from tangible.gd)</li>
+        <ul><li>Node2D - $Body (tangibleBody.gd, inherits from mobileBody.gd)</li>
+            <ul><li>Area2D - $Sprite (Items/Components/Sprite.gd)</li>
+                <ul><li>Sprite - $Sprite</li>
+                    <ul><li>PanelContainer - $Highlight (the <a href="/blessfrey-gdd/highlight">highlight scene</a></li></ul>
+                <li>CollisionPolygon2D - $CollisionPolygon2D</li></ul>
+            </ul>
+        </ul>
+    </ul></p>
+    <br>
+    <h2>variables</h2>
+    <p><ul>
+        <li>ITEM_SCENE_NAME, a constant reference to the <a href="/blessfrey-gdd/base-item">base item</a>'s path within the folder </li>
+        <li>item_scene, the base item's scene, loaded from ITEM_SCENE_NAME </li>
+        <li>item, the <a href="/blessfrey-gdd/base-item">base item</a>. It's instanced from item_scene and added as a child of the floor item.
+        <li>display_name, the name seen in the <a href="/blessfrey-gdd/highlight">highlight</a> label, <a href="/blessfrey-gdd/inventory">inventory</a> listings, etc.  </li>
+    <br>
+    <h2>logic </h2>
+    <p> <br></p>
+    <br>
+    <br>
+    <h2>challenges/known issues </h2>
+    <p> <br></p>
+    <br>
+    <h2>works for...</h2>
+    <ul>
+        <li>???✓ </li>
+        <li>???✗ </li>
+    </ul>
+
diff --git a/src/blessfrey-gdd/item b/src/blessfrey-gdd/item
index 935afdc..424631f 100644
--- a/src/blessfrey-gdd/item
+++ b/src/blessfrey-gdd/item
@@ -4,9 +4,9 @@
     <h2>four representations </h2>
     <p>An item changes its form depending on its context. <br></p>
     <br>
-    <p>Base items are the purest form of an item, maintaining its continuity and containing its essential data. Other items hold the base item as a child or generates one if one doesn't already exist. <br></p>
+    <p><a href="/blessfrey-gdd/base-item">Base items</a> are the purest form of an item, maintaining its continuity and containing its essential data. Other items hold the base item as a child or generates one if one doesn't already exist. <br></p>
     <br>
-    <p>Floor items are the representation of an item that spawns in the environment, drops from opponents, and can be picked up. They are technically tangible entities. <br></p>
+    <p><a href="/blessfrey-gdd/floor-item">Floor items</a> are the representation of an item that spawns in the environment, drops from opponents, and can be picked up. They are technically tangible entities. <br></p>
     <br>
     <p>Inventory items appear in the inventory window. They are technically control nodes. <br></p>
     <br>
@@ -15,16 +15,17 @@
     <h2>move to pick up item </h2>
     <p>Items can only be picked up by the player. They can be picked up via item targeting or through selecting 'pick up' on the <a href="/blessfrey-gdd/inspect">inspect menu</a>. <br></p>
     <br>
-    <p>Item pickup is triggered when a floor item is targeted, that is, a 'target' (left-click) triggers a $Item/Body/Sprite/Sprite.gd/_on_input_event. If 'no_move_to_target' (shift) is held while targeting, the item will be targeted without initiating pickup. Otherwise, floor_item.gd/target_event(viewport,event,shape_idx) is called to set the target and handle the input before prompting the player to consider pickup. <br></p>
+    <p>Item pickup is triggered when a <a href="/blessfrey-gdd/floor-item">floor item</a> is targeted, that is, a 'target' (left-click) triggers a $Item/Body/Sprite/Sprite.gd/_on_input_event. If 'no_move_to_target' (shift) is held while targeting, the item will be targeted without initiating pickup. Otherwise, floor_item.gd/target_event(viewport,event,shape_idx) is called to set the target and handle the input before prompting the player to consider pickup. <br></p>
     <br>
-    <p>Item pickup is also an option on the floor items' <a href="/blessfrey-gdd/inspect">inspect menu</a>. Choosing it triggers that floor item's id_pressed(id), which calls the associated method from its inspect_options dictionary: floor_item.gd/move_player_then_pickup(), prompting the player to consider pickup. <br></p>
+    <p>Item pickup is also an option on the <a href="/blessfrey-gdd/floor-item">floor items</a>' <a href="/blessfrey-gdd/inspect">inspect menu</a>. Choosing it triggers that <a href="/blessfrey-gdd/floor-item">floor item</a>'s id_pressed(id), which calls the associated method from its inspect_options dictionary: floor_item.gd/move_player_then_pickup(), prompting the player to consider pickup. <br></p>
     <br>
     <p>Character.gd/consider_pickup(item) passes to UserControl/pickup(item). The next branch depends on a distance check. <br></p>
     <br>
     <p>If the item is within the player's <a href="/blessfrey-gdd/proxemics">intimate distance</a>, the character will be prompted to pick up the item. 
     <br>
-    <p>Otherwise, <a href="/blessfrey-gdd/pathfinding">pathfinding</a> begins towards the floor item. Upon arrival, it calls floor_item.pick_up().pick_up(). The floor item's pick_up removes itself from the room and returns the base item, then the <a href="/blessfrey-gdd/inventory">inventory system</a> takes care of the rest. <br></p>
+    <p>Otherwise, <a href="/blessfrey-gdd/pathfinding">pathfinding</a> begins towards the <a href="/blessfrey-gdd/floor-item">floor item</a>. Upon arrival, it calls floor_item.pick_up().pick_up(). The <a href="/blessfrey-gdd/floor-item">floor item</a>'s pick_up removes itself from the room and returns the base item, then the <a href="/blessfrey-gdd/inventory">inventory system</a> takes care of the rest. <br></p>
     <br>
+    <h2>drop item </h2>
     <br>
     <h2>challenges/known issues </h2>
     <p> <br></p>
@@ -38,7 +39,7 @@
         <li>drop from inv✗ </li>
         <li>drop from death drop table✗ </li>
         <li>equip✗ </li>
-        <li>inspect inventory item, floor item✗ </li>
+        <li>inspect inventory item, <a href="/blessfrey-gdd/floor-item">floor item</a>✗ </li>
         <li>pickup in range, out of range, target, inspect✓ </li>
         <li>progress quest, open door✗ </li>
         <li>read✗ </li>
diff --git a/src/blessfrey-gdd/jobs b/src/blessfrey-gdd/job
similarity index 100%
rename from src/blessfrey-gdd/jobs
rename to src/blessfrey-gdd/job
diff --git a/src/blessfrey-gdd/keywords b/src/blessfrey-gdd/keyword
similarity index 100%
rename from src/blessfrey-gdd/keywords
rename to src/blessfrey-gdd/keyword
diff --git a/src/views/bf-gdd.tpl b/src/views/bf-gdd.tpl
index 3c17f54..67bd450 100644
--- a/src/views/bf-gdd.tpl
+++ b/src/views/bf-gdd.tpl
@@ -5,7 +5,7 @@
     <p>The vision for Blessfrey <br></p>
     <br>
     <ul>
-        % for i in ["achievements","cast","controls","credits","ID","inspect menu", "inventory","item","job","keyword","mechanics","Mercur","milestones","pathfinding","proxemics","setting","skill","story","style guide","terms","vibe","website"]:
+        % for i in ["achievements","cast","controls","credits","highlight","ID","inspect menu", "inventory","item","job","keyword","mechanics","Mercur","milestones","pathfinding","proxemics","setting","skill","story","style guide","terms","vibe","website"]:
         <li class="list">{{random.choice(['.','•','☆','★'])}}&#9;<a href=/blessfrey-gdd/{{i}}>{{i}}</a></li>
         % end
     </ul>