Dump element

Add a button to void stored fluids.

The dump element is a button used to void the content of one or several fluid tanks.

When clicked, the dump button will find the specified fluid component in the machine and void it's content.

Dump elements are defined in json with : "type": "custommachinery:dump".

Properties

The dump gui element has 4 mandatory properties and 7 optional properties :

Mandatory properties

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

Tanks

Name : tanks

Description :

The id of the Fluid Component you want to void. It must be the exact same id specified in the fluid component json id property. You can specify a list of tank id `["tank1", "tank2"...] in which case all specified tanks will be voided when the dump element is clicked.

Example :

The element will void the fluid component with id tank1, if no fluid component has this id it will do nothing.

"tanks": "tank1"

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

Texture

Name : texture

Description :

The location of the texture that will be rendered into the GUI.

The location must be referenced by : namespace:path/file.png The texture loader will search for textures in the assets/namespace folder, the .png extension is required or the file will not be found.

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": "custommachinery:textures/gui/base_dump.png"

Example :

The file assets/textures/my_texture.png will be used for the dump element.

"texture": "namespace:textures/my_texture.png"

Texture hovered

Name : texture_hovered

Description :

The location of the texture that will be rendered into the GUI when the players mouse cursor is hovering the element.

The location must be referenced by : namespace:path/file.png The texture loader will search for textures in the assets/namespace folder, the .png extension is required or the file will not be found.

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_hovered": "custommachinery:textures/gui/base_dump_hovered.png"

Example :

The file assets/textures/my_texture.png will be used.

"texture_hovered": "namespace:textures/my_texture.png"

Component

Name : component

Description :

The type of component to dump contents.

Must be specified as a machine component type id e.g: "custommachinery:item"

This can be a list if you need to dump the content of multiple component types : ["custommachinery:item", "custommachinery:fluid"]

Default : "custommachinery:fluid"

Example :

This will make the dump gui element void content from item slots only.

"component": "custommachinery:item"

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 dump element :

{
    "type": "custommachinery:dump",
    "x": 20,
    "y": 20,
    "id": "tank1"
}

Dump element base texture