gui_settings

GUI Global Settings — misc entry.

Entry Information

Property	Value
Entry ID	gui_settings
Type	Misc
Color	Blue
Icon	fa6-solid:gear

Description

Enum mapping each storage action to a Bukkit [ClickType]. Used by [StorageInteractionConfig] to make storage click behavior configurable from the gui_settings entry in Tapwriter. / enum class StorageClickType( @Help("The Bukkit ClickType this enum value maps to") val bukkit: ClickType ) { @Help("Left click") LEFT(ClickType.LEFT), @Help("Right click") RIGHT(ClickType.RIGHT), @Help("Shift + left click") SHIFT_LEFT(ClickType.SHIFT_LEFT), @Help("Shift + right click") SHIFT_RIGHT(ClickType.SHIFT_RIGHT), @Help("Middle click (scroll wheel press)") MIDDLE(ClickType.MIDDLE), @Help("Double click") DOUBLE_CLICK(ClickType.DOUBLE_CLICK), @Help("Drop key (Q)") DROP(ClickType.DROP), @Help("Ctrl + drop key (Ctrl+Q)") DROP_ALL(ClickType.CONTROL_DROP), @Help("Swap offhand (F)") SWAP_OFFHAND(ClickType.SWAP_OFFHAND); } /** Defines which [StorageClickType] maps to which storage action. Configured globally via [GuiSettingEntry.storageInteraction]. The default values match the traditional storage behavior: LEFT=placeOne, RIGHT=takeOne, SHIFT_LEFT=placeAll, SHIFT_RIGHT=takeStack, SWAP_OFFHAND=fillFromInventory, DROP=dropAll. / data class StorageInteractionConfig( @Help("Click to place ONE item from cursor into the storage slot") val placeOneClick: StorageClickType = StorageClickType.LEFT, @Help("Click to place ALL items from cursor into the storage slot") val placeAllClick: StorageClickType = StorageClickType.SHIFT_LEFT, @Help("Click to take ONE item from the storage slot onto cursor") val takeOneClick: StorageClickType = StorageClickType.RIGHT, @Help("Click to take ALL items from the storage slot onto cursor") val takeAllClick: StorageClickType = StorageClickType.LEFT, @Help("Click to take a full STACK (64) from the storage slot into inventory") val takeStackClick: StorageClickType = StorageClickType.SHIFT_RIGHT, @Help("Click to FILL the storage slot from the player inventory") val fillFromInvClick: StorageClickType = StorageClickType.SWAP_OFFHAND, @Help("Click to DROP all items from the storage slot onto the ground") val dropAllClick: StorageClickType = StorageClickType.DROP, ) /** Global settings for the GUI Extension. Allows defining default sounds, storage interaction config, and skill tree node connectors.

Fields

Field	Type	Description
audioDefaults	MenuAudioConfig	Default audio configuration for all GUIs if not overridden.
storageInteraction	StorageInteractionConfig	Configure which mouse/keyboard clicks trigger each storage action (place, take, fill, drop).
nodeDefaults	Map<NodeState, NodeDirectionalMap>	Default Skill Tree node connector items for each state.

Usage Example

- entry: gui_settings
  name: "GUI Global Settings"
  audioDefaults: ""
  storageInteraction: 0
  nodeDefaults: ""