Skip to main content

GUI Storage

Persistent storage artifact for GUI storage slots

ArtifactProvided by GUI

Persistent storage artifact used by [StorageLayout] and [StorageSlotData]. Each artifact holds item data for one or more storage slots. Create one artifact per storage menu. Items in layouts reference this artifact via their storage.entry field.

Fields

FieldTypeDefaultDescription
artifactIdString—Unique artifact identifier. Used internally to persist data per group key.

How to use it​

Create one artifact per storage menu. It only holds data: the behaviour lives in the Open GUI that references it, either through a storage layout (entry, groupKey, slots) or through the storagePool entry used by an item's storageId.

  • Scope. Leave group empty in a storagePool configuration for per-player storage, or reference a group entry to share the same slots between its members. In a storage layout, groupKey defaults to %player_uuid%.
  • Placeholders. Names and lore of the slot accept {stored_name}, {stored_amount} and {stored_max}. PlaceholderAPI exposes %typewriter_gui_storage_amount_<entry_id>_<slot_index>% and %typewriter_gui_storage_has_<entry_id>_<slot_index>%, where the slot index is y * 9 + x.
  • Quotas. requiredItem limits the slot to one material. With requiredAmount, deposits accumulate; at the target, onReachRequired fires and consumeOnReach decides whether the items are used up.
  • Temporary slots. temporary empties the slot when the menu closes and fires temporaryTriggers. dropOnClose instead drops the remaining items at the player's feet on a real close, on Escape or on disconnect, but not when the player moves to another menu.

Click bindings (place, take, fill, drop) are global and set in GUI Global Settings.