Dungeon Global Menu - BornToCraft STUDIO

Action entry that opens a global dungeon menu showing instances from a category. Uses the GUI layout system (scrollable, paginated, frame, flex, composite) via layoutPool and mainLayoutId. Use the buttons field to configure which interactive buttons appear and at which virtual coordinates.

Layout System

The menu uses the GUI extension’s layout engine exclusively. The parsed layout defines the visual structure (scrollable areas, frames, decoration items), and the dungeon-specific dynamic items (instance slots, info button, find-party button) are automatically composed on top via CompositeLayout. Buttons use virtual coordinates (x, y) instead of raw slot indices, making them compatible with all layout types including scrollable and composite layouts. (0, 0) is top-left, (8, 5) is bottom-right for a standard 6-row inventory.

Buttons System

Use the buttons list to configure interactive buttons. Each entry defines a type (enum), optional x/y position, and optional visual overrides (item, name, lore). If a button type is present in buttons, it overrides the per-field defaults. If absent, the individual fields (e.g., infoItem, infoName) are used as fallback with their legacy infoSlot position converted to (x, y).

Available Button Types

Type	Description	Default Position
`INFO`	Information button — shows dungeon details	(4, 0)
`FIND_PARTY`	Dual-state: “Find Party” (not in party) / “Leave Party” (in party)	(4, 5)

Configuration

Configuration for the dungeon global menu.

Show Properties

category

Ref<DungeonCategoryEntry>

Category to display in this menu.

inventoryTitle

Var<String>

Title of the inventory. Supports placeholders.

inventoryRows

Int

default:"6"

Number of rows in the inventory (1-6).

infoEnabled

Boolean

default:"true"

Enable the Information button.

infoSlot

Int

default:"4"

Legacy slot for the Information button. Prefer using buttons with x/y instead.

infoItem

Item

Item used for the Information button.

infoName

Var<String>

Display name for the Information button.

infoLore

List<Var<String>>

Lore for the Information button.

findPartyEnabled

Boolean

default:"true"

Enable the Find Party/Leave Party dual-state button.

findPartySlot

Int

default:"49"

Legacy slot for the party button. Prefer using buttons with x/y instead.

findPartyItem

Item

Item for the button when the player is NOT in a party.

findPartyName

Var<String>

Name when NOT in a party.

findPartyLore

List<Var<String>>

Lore when NOT in a party.

inPartyItem

Item

Item when the player IS in a party.

inPartyName

Var<String>

Name when the player IS in a party.

inPartyLore

List<Var<String>>

Lore when the player IS in a party.

fillItem

Item

Item to fill empty slots in the menu.

fillName

Var<String>

Name for filler items.

buttons

List<DungeonButtonSlot>

Button configurations. Overrides individual item/name/lore defaults when a type is present. Each type appears at most once.

Show DungeonButtonSlot

type

DungeonButtonType

default:"INFO"

Button type: INFO or FIND_PARTY.

x

Optional<Int>

X position in the virtual grid (0-8). If not set, uses the individual button slot default converted to x.

y

Optional<Int>

Y position in the virtual grid (0-5). If not set, uses the individual button slot default converted to y.

item

Optional<Item>

Override item. Uses individual field default if not set.

name

Optional<Var<String>>

Override display name. Uses individual field default if not set.

lore

Optional<List<Var<String>>>

Override lore lines. Uses individual field default if not set.

guiType

GuiType

default:"CUSTOM"

GUI type to use (CUSTOM, BOOK, FURNACE, etc.).

layoutPool

List<LayoutData>

Pool of layout definitions for this GUI. Supports SimpleLayoutData, FlexLayoutData, PaginatedLayoutData, ScrollableLayoutData, FrameLayoutData, and CompositeLayoutData.

mainLayoutId

Optional<String>

ID of the main layout to display from the pool.

globalInteractions

List<InteractionData>

Global interactions for the GUI (keybinds, clicks).

audio

GuiAudioData

Audio configuration (onOpen, onClose, onScroll, onClick).

Dungeon Enter Dungeon Leave