Merge branch 'hawkbar-item-props' of https://github.com/Outer-Wilds-New-Horizons/new-horizons into hawkbar-item-props

NewHorizons/Schemas/body_schema.json

@@ -1381,6 +1381,129 @@
           "type": "boolean",
           "description": "Should the player close their eyes while the activation state changes. Only relevant if activationCondition or deactivationCondition are set.",
           "default": true
+        },
+        "item": {
+          "description": "Should this detail be treated as an interactible item",
+          "$ref": "#/definitions/ItemInfo"
+        },
+        "itemSocket": {
+          "description": "Should this detail be treated as a socket for an interactible item",
+          "$ref": "#/definitions/ItemSocketInfo"
+        }
+      }
+    },
+    "ItemInfo": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "The name of the item to be displayed in the UI. Defaults to the name of the detail object."
+        },
+        "itemType": {
+          "type": "string",
+          "description": "The type of the item, which determines its orientation when held and what sockets it fits into. This can be a custom string, or a vanilla ItemType (Scroll, WarpCode, SharedStone, ConversationStone, Lantern, SlideReel, DreamLantern, or VisionTorch). Defaults to the item name."
+        },
+        "interactRange": {
+          "type": "number",
+          "description": "The furthest distance where the player can interact with this item. Defaults to two meters, same as most vanilla items. Set this to zero to disable all interaction by default.",
+          "format": "float",
+          "default": 2.0
+        },
+        "droppable": {
+          "type": "boolean",
+          "description": "Whether the item can be dropped. Defaults to true.",
+          "default": true
+        },
+        "dropOffset": {
+          "description": "A relative offset to apply to the item's position when dropping it on the ground.",
+          "$ref": "#/definitions/MVector3"
+        },
+        "dropNormal": {
+          "description": "The direction the item will be oriented when dropping it on the ground. Defaults to up (0, 1, 0).",
+          "$ref": "#/definitions/MVector3"
+        },
+        "pickupCondition": {
+          "type": "string",
+          "description": "A dialogue condition to set when picking up this item."
+        },
+        "clearPickupConditionOnDrop": {
+          "type": "boolean",
+          "description": "Whether the pickup condition should be cleared when dropping the item. Defaults to true.",
+          "default": true
+        },
+        "pathToInitialSocket": {
+          "type": "string",
+          "description": "A relative path from the planet to a socket that this item will be automatically inserted into."
+        }
+      }
+    },
+    "ItemSocketInfo": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "rotation": {
+          "description": "Rotation of the object",
+          "$ref": "#/definitions/MVector3"
+        },
+        "alignRadial": {
+          "type": [
+            "boolean",
+            "null"
+          ],
+          "description": "Do we try to automatically align this object to stand upright relative to the body's center? Stacks with rotation.\nDefaults to true for geysers, tornados, and volcanoes, and false for everything else."
+        },
+        "position": {
+          "description": "Position of the object",
+          "$ref": "#/definitions/MVector3"
+        },
+        "parentPath": {
+          "type": "string",
+          "description": "The relative path from the planet to the parent of this object. Optional (will default to the root sector)."
+        },
+        "isRelativeToParent": {
+          "type": "boolean",
+          "description": "Whether the positional and rotational coordinates are relative to parent instead of the root planet object."
+        },
+        "rename": {
+          "type": "string",
+          "description": "An optional rename of this object"
+        },
+        "socketPath": {
+          "type": "string",
+          "description": "The relative path to a child game object of this detail that will act as the socket point for the item. Will be used instead of this socket's positioning info if set."
+        },
+        "itemType": {
+          "type": "string",
+          "description": "The type of item allowed in this socket. This can be a custom string, or a vanilla ItemType (Scroll, WarpCode, SharedStone, ConversationStone, Lantern, SlideReel, DreamLantern, or VisionTorch)."
+        },
+        "interactRange": {
+          "type": "number",
+          "description": "The furthest distance where the player can interact with this item socket. Defaults to two meters, same as most vanilla item sockets. Set this to zero to disable all interaction by default.",
+          "format": "float",
+          "default": 2.0
+        },
+        "useGiveTakePrompts": {
+          "type": "boolean",
+          "description": "Whether to use \"Give Item\" / \"Take Item\" prompts instead of \"Insert Item\" / \"Remove Item\"."
+        },
+        "insertCondition": {
+          "type": "string",
+          "description": "A dialogue condition to set when inserting an item into this socket."
+        },
+        "clearInsertConditionOnRemoval": {
+          "type": "boolean",
+          "description": "Whether the insert condition should be cleared when removing the socketed item. Defaults to true.",
+          "default": true
+        },
+        "removalCondition": {
+          "type": "string",
+          "description": "A dialogue condition to set when removing an item from this socket, or when the socket is empty."
+        },
+        "clearRemovalConditionOnInsert": {
+          "type": "boolean",
+          "description": "Whether the removal condition should be cleared when inserting a socketed item. Defaults to true.",
+          "default": true
         }
       }
     },