Player inventory element

Customize the view of the player inventory in the machine gui.

The player inventory element is used to render the player inventory into the Machine GUI (only the 4 row of items).

Player inventory elements are defined in json with :

"type": "custommachinery:player_inventory".

There can be only one player inventory element per Machine GUI, if you define several Player Inventory Elements only the first will be used.

While you can change the default texture of the player inventory element you can't change the position of it's slots. See the default texture of the player inventory to see how the slots are placed.

Properties

The player inventory element has 3 mandatory properties and 7 optional properties :

Mandatory properties

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

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

Example :

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

"texture": "namespace:textures/player_inventory.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 :

None, the element will use the texture defined in the texture property.

Example :

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

"texture_hovered": "namespace:textures/my_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 !"

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 player_inventory

"id": "player_inventory"

Example

A basic Player Inventory Element using the default texture :

{
    "type": "custommachinery:player_inventory",
    "x": 50,
    "y": 80
}

Result :

Player inventory element base texture

(The diamonds are present in the Player Inventory, you can move them from the Element like in any other GUI)