Progress bar element

Customize the recipe progress arrow in the machine gui.

The progress bar element is used to render a progress bar in the Machine GUI (see the arrow that is slowly filled in the furnace GUI while smelting ? That's a progress bar).

Progress bar elements are defined in json with : "type": "custommachinery:progress".

You can add as much Progress Bar Elements as you want but they will all be filled at the same time since the machine can only process 1 recipe at a time.

When hovering the progress bar in jei with advanced item tooltips enabled (F3 + H), the progress bar tooltip will display the recipe ID. You can disable the need of enabling item tooltips in the config by setting needAdvancedInfoForRecipeID to false.

If JEI is installed you can click on the progress bar element in the machine gui to display in JEI all the recipes for this machine.

Properties

The progress bar element has 3 mandatory properties and 10 optional properties :

Mandatory properties

"type": "custommachinery:progress" //Mandatory to define a progress bar 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

Optional properties

Width

Name : width

Description :

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

Default :

The same width as the texture specified in the texture property.

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 same height as the texture specified in the texture property.

Example :

The height of the element will be 100px.

"height": 100

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

Empty texture

Name : texture_empty

Description :

Point to a texture to use as the empty element texture. The texture must be loaded in-game with a resource pack or a loader mod.

The texture can be any size, if the texture size is different from the default size the width and height properties of the element will be automatically changed to fit the texture size if not provided.

If the width and/or height properties of the element are provided, the texture will be stretched to fit the dimensions of the element (it can render weirdly in that case).

Default :

"texture_empty": "custommachinery:textures/gui/base_progress_empty"

Example :

"texture_empty": "namespace:textures/progress_element_texture_empty.png"

The element will search for a texture located in assets/namespace/textures/progress_element_texture_empty.png

The .png extension is mandatory.

Filled texture

Name : texture_filled

Description :

Point to a texture to use as the filled element texture. The texture must be loaded in-game with a resource pack or a loader mod.

The filled texture will be rendered on top on the empty texture, how much the filled texture overlap the empty texture is relative to the amount of energy inside the energy component.

Default :

"texture_filled": "custommachinery:textures/gui/base_progress_filled"

Example :

"texture_filled": "namespace:textures/progress_element_texture_filled.png"

The element will search for a texture located in assets/namespace/textures/progress_element_texture_filled.png

The .png extension is mandatory.

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 !"

Orientation

Name : orientation

Description :

The orientation (right/left/top/bottom) of the arrow. When the recipe is processing the arrow will fill to this direction (from the opposite).

If using custom textures they will not be rotated, but they will be filled according to the specified direction.

Default : right

The arrow point to the right and is filled from the left to the right.

Example :

The arrow point to the bottom and is filled from the top to the bottom.

"orientation": "bottom"

Start

Name : start

Description :

A positive decimal value that represent at which percentage of the recipe progress the bar should start rendering.

The specified value must be between 0.0 (start of the recipe) and 1.0 (end of the recipe).

Default : 0.0

Example :

The progress bar will start rendering at 30% of the recipe progress :

"start": 0.3

End

Name : end

Description :

A positive decimal value that represent at which percentage of the recipe progress the bar should stop rendering.

The specified value must be between 0.0 (start of the recipe) and 1.0 (end of the recipe).

Default : 1.0

Example :

The progress bar will stop rendering at 80% of the recipe progress :

"end": 0.8

Id

Name : id

Description :

The id of this gui element. By default it does nothing and can be omitted.

This is really only useful if you intend to make a recipe that replace this element.

Default : empty

Example :

The id of this element will be progress

"id": "progress"

Example

A basic Progress Bar Element using the default textures :

{
    "type": "custommachinery:progress",
    "x": 116,
    "y": 50
}

Result :

Progress bar base texture

In this example JEI is installed and display a "Show Recipes" tooltip when the mouse hover the element.