ItemInfo

Celestial Body Schema / Definitions / ItemInfo

Schema Type: JSON Type: object

No Description Found

# name

Type: string

The name of the item to be displayed in the UI. Defaults to the name of the detail object.

---

# itemType

Type: string

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, WarpCore, SharedStone, ConversationStone, Lantern, SlideReel, DreamLantern, or VisionTorch). Defaults to the item name.

---

# interactRange

Type: number Default: 2

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.

---

# colliderRadius

Type: number Default: 0.5

The radius that the added sphere collider will use for collision and hover detection.
If there's already a collider on the detail, you can make this 0.

---

# droppable

Type: boolean Default: true

Whether the item can be dropped. Defaults to true.

---

# dropOffset

Type: MVector3

A relative offset to apply to the item's position when dropping it on the ground.

See Definitions/MVector3

---

# dropNormal

Type: MVector3

The direction the item will be oriented when dropping it on the ground. Defaults to up (0, 1, 0).

See Definitions/MVector3

---

# holdOffset

Type: MVector3

A relative offset to apply to the item's position when holding it. The initial position varies for vanilla item types.

See Definitions/MVector3

---

# holdRotation

Type: MVector3

A relative offset to apply to the item's rotation when holding it.

See Definitions/MVector3

---

# socketOffset

Type: MVector3

A relative offset to apply to the item's position when placing it into a socket.

See Definitions/MVector3

---

# socketRotation

Type: MVector3

A relative offset to apply to the item's rotation when placing it into a socket.

See Definitions/MVector3

---

# pickupAudio

Type: string

The audio to play when this item is picked up. Only applies to custom/non-vanilla item types.
Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.

---

# dropAudio

Type: string

The audio to play when this item is dropped. Only applies to custom/non-vanilla item types.
Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.

---

# socketAudio

Type: string

The audio to play when this item is inserted into a socket. Only applies to custom/non-vanilla item types.
Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.

---

# unsocketAudio

Type: string

The audio to play when this item is removed from a socket. Only applies to custom/non-vanilla item types.
Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.

---

# pickupCondition

Type: string

A dialogue condition to set when picking up this item.

---

# clearPickupConditionOnDrop

Type: boolean Default: true

Whether the pickup condition should be cleared when dropping the item. Defaults to true.

---

# pickupFact

Type: string

A ship log fact to reveal when picking up this item.

---

# pathToInitialSocket

Type: string

A relative path from the planet to a socket that this item will be automatically inserted into.