Text element

Add text in the machine gui.

Text element is used to render a text on the Machine GUI.

Text elements are defined in json with : "type": "custommachinery:text".

The text must be a single text component and can't have multiple lines (use multiple text elements for that).

You can change the size of text using width and height property.

By default all text gui elements are hidden in jei, to make them show up see the "jei" property below.

Properties

The text element has 4 mandatory properties and 7 optional properties :

Mandatory properties

"type": "custommachinery:text" //Mandatory to define a text element.

X

Name : x

Description :

A positive integer value that define the x axis position of the element to be displayed on the Machine GUI.

Example :

The element will be rendered 100px to the right from the top-left corner of the gui.

"x": 100

Y

Name : y

Description :

A positive integer value that define the y axis position of the element to be displayed on the Machine GUI.

Example :

The element will be rendered 100px to the bottom from the top-left corner of the gui.

"y": 100

Text

Name : text

Description :

A text component to be rendered on the GUI.

Example :

A simple line of text :

"text": "An Awesome Title For My Machine GUI !"

Adding some style options :

"text": {"text": "Red and bold text", "color": "red", "bold": true}

Optional properties

Priority

Name : priority

Description :

An integer property that define the priority of the Element to be rendered.

Elements with higher priority will be rendered first. If 2 elements are at the same position the first to be rendered will be under and the last will be above.

Default : 0

Example :

The element will be rendered under each element that have a priority lower than 1000.

"priority": 1000

Alignment

Name : alignment

Description :

How the text is aligned compared to the Element position. Available values are left/center/right

Default : left

The left of the text string will be at the Element position.

Example :

"alignment": "center" //The center of the text string will be at the element position.

Jei

Name : jei

Description :

A boolean that define if the element should render in jei.

Default : false

Example :

The element will render in jei :

"jei": true

Tooltips

Name : tooltips

Description :

A list of Text components that will be shown as tooltips when the player mouse cursor hover the element.

Each tooltips of the list will be a new line.

Example :

Replace the default tooltips with a single line that say "Click me !" :

"tooltips": "Click me !"

Width

Name : width

Description :

A positive integer value that define the width of the element on the Machine GUI.

Default :

The width of the specified text.

Example :

The width of the element will be 100px.

"width": 100

Height

Name : height

Description :

A positive integer value that define the height of the element on the Machine GUI.

Default :

The default height of text in Minecraft (about 9px).

Example :

The height of the element will be 100px.

"height": 100

Tooltips

Name : tooltips

Description :

A list of Text components that will be shown as tooltips when the player mouse cursor hover the element.

Each tooltips of the list will be a new line.

Example :

Replace the default tooltips with a single line that say "Click me !" :

"tooltips": "Click me !"

Example

A basic text element :

{
    "type": "custommachinery:text",
    "x": 20,
    "y": 20,
    "text": "My Awesome Machine"
}

Result :

A text element