Widgets

Widgets are the elements inside a layout: text, buttons, images, item icons, the player model, and so on. Each entry in a layout's widgets list is an object with a type field and the type's own settings:

{
  "type": "palladium:text",
  "text": "Hello!",
  "properties": {
    "alignment": "center",
    "y": -20
  }
}

---

Common Properties

Every widget accepts an optional properties object with the same set of fields:

Field	Type	Required	Fallback	Description
alignment	Alignment	No	top_left	Which point of the layout the widget is anchored to. See Positioning.
x	Integer	No	0	Horizontal offset from the anchor point. Can be negative.
y	Integer	No	0	Vertical offset from the anchor point. Can be negative.
width	Integer	No	per type	Width of the widget. Most types default to 50, square types (icon, item) to 16.
height	Integer	No	per type	Height of the widget. Most types default to 18, square types (icon, item) to 16.
action	Action	No	/	Action to run on click. Only used by button widgets. See Click Actions.
tooltip	Text Component	No	/	Tooltip shown while hovering the widget.
visibility	Condition(s)	No	always	The widget is only shown while the condition is true. Re-checked every tick.

Positioning

Widgets are not laid out automatically; each one is positioned on its own. The alignment anchors the widget to one of nine points of the layout's padded area, and x/y shift it from there:

top_left      top_center      top_right
middle_left   center          middle_right
bottom_left   bottom_center   bottom_right

For centered alignments the widget's own size is taken into account, so "alignment": "center" with no offsets puts the widget exactly in the middle. Offsets always move the widget right (x) and down (y); use negative values for the other direction. A back button in the bottom right corner, 4 pixels off the edge, would be:

"properties": {
  "alignment": "bottom_right",
  "x": -4,
  "y": -4,
  "width": 60,
  "height": 20
}

Click Actions

The action property makes buttons do something when pressed. It uses the vanilla dialog action format, so everything vanilla supports works here: minecraft:run_command, minecraft:open_url, minecraft:suggest_command, minecraft:show_dialog, minecraft:copy_to_clipboard, and the dynamic variants.

Palladium adds three more action types:

• palladium:open_screen opens another Palladium screen (field screen, the screen ID). This is how you link screens together into multi-page menus.
• palladium:open_customization_screen opens the player customization screen (optional field category to jump to a category).
• palladium:custom_event sends an event to the server. This is the way to make a button do something server-side beyond running a command; see Custom Events below.

{
  "type": "palladium:button",
  "text": "Choose your side",
  "close_on_press": true,
  "properties": {
    "action": {
      "type": "minecraft:run_command",
      "command": "function mypack:choose_side"
    }
  }
}

Only the two button widgets (palladium:button and palladium:flat_button) execute actions; on all other widgets the action property is ignored. Commands run through actions are executed by the player, with their permission level, exactly like the vanilla dialog system.

Custom Events

The palladium:custom_event action sends an event with a freely chosen ID and optional NBT data to the server:

Field	Type	Required	Description
id	ID	Yes	The event ID. Use your own namespace.
data	Object	No	Arbitrary NBT data sent along with the event.

On the server, the event fires the palladium:custom_event advancement criterion trigger, so anything that listens to criterion triggers can react to it. The main consumer is the automation system, where you can match on the event ID and data and run server-side actions; inside the automation, the event ID and data are also available on the context. It also works as a regular criterion in advancements.

{
  "type": "palladium:button",
  "text": "Claim reward",
  "properties": {
    "action": {
      "type": "palladium:custom_event",
      "id": "mypack:claim_reward",
      "data": { "tier": 2 }
    }
  }
}

Keep in mind that the client decides what it sends: treat an incoming event like a button press, not as trusted data, and put any real checks into the automation's condition.

Visibility

The visibility property takes the same conditions used everywhere else in Palladium, tested against the viewing player. Since it is re-evaluated every tick while the screen is open, you can build screens that react to the player's state, for example showing a button only once a power is unlocked:

"properties": {
  "visibility": {
    "type": "palladium:has_power",
    "power": "mypack:super_strength"
  }
}

---

Widget Types

Blit

ID: palladium:blit

Renders a simple (piece of a) texture

Settings

Key	Type	Description	Required	Fallback
texture	Texture Reference	Texture path/dynamic texture		/
u	(Dynamic) Value	U-position on the texture where to start drawing from		0
v	(Dynamic) Value	V-position on the texture where to start drawing from		0
texture_width	Integer (>= 0)	Total width of the texture file		256
texture_height	Integer (>= 0)	Total height of the texture file		256
properties	UI Properties	Properties of this widget		{"width":50,"height":18}

Example

{
  "type": "palladium:blit",
  "texture": "mypack:textures/gui/texture_file.png"
}

---

Button

ID: palladium:button

Adds a button.

Settings

Key	Type	Description	Required	Fallback
text	Text Component	Text of the button		/
close_on_press	Boolean	Whether or not the screen will be closed when pressing the button.		/
properties	UI Properties	Properties of this widget		{"width":50,"height":18}

Example

{
  "type": "palladium:button",
  "text": "Click me!",
  "close_on_press": true
}

---

Colored Rectangle

ID: palladium:colored_rectangle

Renders a colored rectangle.

Settings

Key	Type	Description	Required	Fallback
color	Color	The color for the rectangle.		/
properties	UI Properties	Properties of this widget		{"width":50,"height":18}

Example

{
  "type": "palladium:colored_rectangle",
  "color": "#ff0000"
}

---

Custom Button

ID: palladium:custom_button

Adds a button with a custom texture.

Settings

Key	Type	Description	Required	Fallback
text	Text Component	Text of the button		/
background	Button Background (enabled*, disabled, highlighted)	The background that is drawn for the button. Can specify separate textures for normal, disabled and highlighted states.		/
close_on_press	Boolean	Whether or not the screen will be closed when pressing the button.		/
properties	UI Properties	Properties of this widget		{"width":50,"height":18}

Example 1

{
  "type": "palladium:custom_button",
  "text": "Hello World!",
  "background": {
    "type": "palladium:sprite",
    "sprite": "palladium:background/default"
  },
  "close_on_press": true
}

Example 2

{
  "type": "palladium:custom_button",
  "text": "Hello World!",
  "background": {
    "enabled": {
      "type": "palladium:sprite",
      "sprite": "palladium:background/default"
    },
    "disabled": {
      "type": "palladium:sprite",
      "sprite": "palladium:background/modal_with_header"
    },
    "highlighted": {
      "type": "palladium:sprite",
      "sprite": "palladium:background/modal_with_footer"
    }
  },
  "close_on_press": true
}

---

Flat Button

ID: palladium:flat_button

Adds a flat button.

Settings

Key	Type	Description	Required	Fallback
text	Text Component	Text of the button		/
close_on_press	Boolean	Whether or not the screen will be closed when pressing the button.		/
properties	UI Properties	Properties of this widget		{"width":50,"height":18}

Example

{
  "type": "palladium:flat_button",
  "text": "Click me!",
  "close_on_press": true
}

---

Gradient Rectangle

ID: palladium:gradient_rectangle

Renders a gradient rectangle.

Settings

Key	Type	Description	Required	Fallback
color_from	Color	The color for the start of the gradient.		/
color_to	Color	The color for the end of the gradient.		/
properties	UI Properties	Properties of this widget		{"width":50,"height":18}

Example

{
  "type": "palladium:gradient_rectangle",
  "color_from": "#ff0000",
  "color_to": "#0000ff"
}

---

Icon

ID: palladium:icon

Renders an icon

Settings

Key	Type	Description	Required	Fallback
icon	Icon definition	The icon to be rendered		/
properties	UI Properties	Properties of this widget		{"width":50,"height":18}

Example

{
  "type": "palladium:icon",
  "icon": {
    "type": "palladium:item",
    "item": {
      "id": "minecraft:apple"
    }
  }
}

---

Icon Button

ID: palladium:icon_button

Adds a button that renders an icon instead of text.

Settings

Key	Type	Description	Required	Fallback
icon	Icon definition	Icon that is rendered on the button		/
background	Button Background (enabled*, disabled, highlighted)	The background that is drawn for the button. If not specified, the default vanilla button texture is used.		/
close_on_press	Boolean	Whether or not the screen will be closed when pressing the button.		/
properties	UI Properties	Properties of this widget		{"width":50,"height":18}

Example 1

{
  "type": "palladium:icon_button",
  "icon": {
    "type": "palladium:item",
    "item": {
      "id": "minecraft:apple"
    }
  },
  "close_on_press": true
}

Example 2

{
  "type": "palladium:icon_button",
  "icon": {
    "type": "palladium:item",
    "item": {
      "id": "minecraft:apple"
    }
  },
  "background": {
    "type": "palladium:sprite",
    "sprite": "palladium:background/default"
  },
  "close_on_press": true
}

---

Item

ID: palladium:item

Renders an item

Settings

Key	Type	Description	Required	Fallback
item	Item / ItemStack	The item stack to be rendered		/
decorations	Boolean	Whether or not item stack "decorations" should be drawn (count, damage, etc.).		true
tooltip	Boolean	Whether or not the default tooltip for the item information should be rendered. If enabled, this will override the tooltip of the properties.		true
properties	UI Properties	Properties of this widget		{"width":50,"height":18}

Example

{
  "type": "palladium:item",
  "item": {
    "id": "minecraft:apple"
  }
}

---

Player Display

ID: palladium:player_display

Renders your player on the screen

Settings

Key	Type	Description	Required	Fallback
scale	Float (>= 0.0)	Scale of the player.		30
follow_mouse	Boolean	When enabled the player will follow the mouse cursor.		false
mimic_player	Boolean	When enabled the player will copy all of the actual player's properties. Equipment, animation, render layers, etc.		true
rotation	Vector 3D	The rotation that is applied to the player. If 'follow_mouse' is active, the rotation will be ignored.		/
render_layers	Identifier, Identifier[]	List of/single render layer ID that will be attached to the rendered player.		/
apply_customization_category_preview	Customization Category ID(s)	ID(s) of customization category that should be previewed		/
properties	UI Properties	Properties of this widget		{"width":50,"height":18}

Example

{
  "type": "palladium:player_display"
}

---

Power Name

ID: palladium:power_name

Renders the name of a power.

Settings

Key	Type	Description	Required	Fallback
power	Power ID	The power that will be displayed. If none is specified, it will use the from the current power screen (if this widget is used in one).		/
color	Color	Color of this text		"#404040"
shadow	Boolean	Whether or not this text has a shadow		false
alignment	left center right	Alignment of this text		left
overflow	clamped scrolling	How to behave if the text is longer than the widget width		clamped
properties	UI Properties	Properties of this widget		{"width":50,"height":18}

Example

{
  "type": "palladium:power_name"
}

---

Power Tree

ID: palladium:power_tree

Renders an interactable tree for a power of a power

Settings

Key	Type	Description	Required	Fallback
power	Power ID	The power that will be displayed. If none is specified, it will use the from the current power screen (if this widget is used in one).		/
background	UI Background	The background that is drawn for the power tree.		"minecraft:textures/block/red_wool.png"
properties	UI Properties	Properties of this widget		{"width":50,"height":18}

Example

{
  "type": "palladium:power_tree"
}

---

Text

ID: palladium:text

Renders a text component

Settings

Key	Type	Description	Required	Fallback
text	Text Component	The text to be drawn		/
color	Color	Color of this text		"#404040"
shadow	Boolean	Whether or not this text has a shadow		false
alignment	left center right	Alignment of this text		left
overflow	clamped scrolling	How to behave if the text is longer than the widget width		clamped
properties	UI Properties	Properties of this widget		{"width":50,"height":18}

Example

{
  "type": "palladium:text",
  "text": "Hello World!"
}

---

Text Box

ID: palladium:text_box

Renders a scrollable text box

Settings

Key	Type	Description	Required	Fallback
text	Text Component	The text to be drawn		/
properties	UI Properties	Properties of this widget		{"width":50,"height":18}

Example

{
  "type": "palladium:text_box",
  "text": "Hello World!"
}

---