Slot element

Add an item slot in the machine gui.

The slot elements is used to render an item slot into the Machine GUI.

Slot elements are defined in json with : "type": "custommachinery:slot".

A slot must be associated with an Item Component using the id property. It will display the item stored in the Item Component and allow you to put or remove the item trough the Machine GUI.

If the slot element cannot find the item component (usually because of an error in the id) the slot will still be rendered but it will be empty and you will not be able to put or remove items.

Properties

The slot element has 4 mandatory properties and 6 optional properties :

Mandatory properties

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

Id

Name : id

Description :

The id of the Item Component you want to link to this element. It must be the exact same id specified in the item component json id property.

Example :

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

"id": "slot1"

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_slot.png"

Example :

The file assets/textures/my_slot_texture.png will be used for the slot element.

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

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

Ghost

Name : ghost

Description :

If specified the slot will render a "ghost item" (slightly transparent item). The item will not be physically present on the slot (aka the player can't take it out). This can be used, for example, to show a filter.

The item must be referenced by it's registry name like "minecraft:stone" or modid:item_name in general.

This can be a single item, a tag (using "#namespace:id", for example "#forge:stone") or a list of both combined : ["minecraft:diamond", "#forge:stone"].

All possible items will be cycled in the slot as ghost items, the time between each items can be changed in the config file (default : 1 second).

Default : no item

Extra properties :

If needed, a custom color/transparency can be applied to the ghost item (default is white with half transparency). The color must be specified as an ARGB array which value are between 0 and 1.

By default the ghost item will only render if no item are present in the slot, this behavior can be changed by setting "always_render": true in the ghost property.

Example :

A transparent coal will be displayed in the slot.

"ghost": "minecraft:coal"

An opaque (no transparency) stone, colored in full red will be always displayed in the slot :

"ghost": {
    "items": "minecraft:stone",
    "color": [1.0, 1.0, 0.0, 0.0],
    "always_render": true
}

Example :

A basic slot element linked to an item component using the id "slot1" and using the default texture :

{
    "type": "custommachinery:slot",
    "x": 20,
    "y": 20,
    "id": "slot1"
}

Result :

Slot element base texture

(Here the item component contains 32 diamonds, you can add and remove them through the Slot Element like in any other GUI)

If you add "item": "minecraft:coal" to the slot element json the slot will be rendered like this

Ghost item in slot element