team.unnamed.creative.metadata.gui

Interface GuiBorder

All Superinterfaces:

net.kyori.examination.Examinable

public interface GuiBorder
extends net.kyori.examination.Examinable

Represents border sizes for a GUI sprite.

Sizes are specified in pixels, pixels that the border slices should cover on-screen.

Since:

1.2.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

Method Summary

Modifier and Type	Method and Description
static @NotNull GuiBorder	border(int size) Returns a GuiBorder instance that will have a uniform border size on all sides specified by the given size, must be non-negative.
static @NotNull GuiBorder	border(int top, int bottom, int left, int right) Returns a GuiBorder instance that will have the specified border sizes on each side, all sizes must must be non-negative.
int	bottom() Returns the number of pixels for the border to cover on-screen across its bottom side, non-negative.
int	left() Returns the number of pixels for the border to cover on-screen across its left side, non-negative.
int	right() Returns the number of pixels for the border to cover on-screen across its right side, non-negative.
int	top() Returns the number of pixels for the border to cover on-screen across its top side, non-negative.

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Detail

border

@NotNull
static @NotNull GuiBorder border(int top,
                                           int bottom,
                                           int left,
                                           int right)

Returns a GuiBorder instance that will have the specified border sizes on each side, all sizes must must be non-negative.

Parameters:

top - The top border size in pixels

bottom - The bottom border size in pixels

left - The left border size in pixels

right - The right border size in pixels

Returns:

The created GuiBorder instance

Since:

1.2.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

border

@NotNull
static @NotNull GuiBorder border(int size)

Returns a GuiBorder instance that will have a uniform border size on all sides specified by the given size, must be non-negative.

Returns:

The created GuiBorder instance

Since:

1.2.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

top

int top()

Returns the number of pixels for the border to cover on-screen across its top side, non-negative.

Returns:

The number of pixels for the border to cover on-screen across its top side

Since:

1.2.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

bottom

int bottom()

Returns the number of pixels for the border to cover on-screen across its bottom side, non-negative.

Returns:

The number of pixels for the border to cover on-screen across its bottom side

Since:

1.2.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

left

int left()

Returns the number of pixels for the border to cover on-screen across its left side, non-negative.

Returns:

The number of pixels for the border to cover on-screen across its left side

Since:

1.2.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18

right

int right()

Returns the number of pixels for the border to cover on-screen across its right side, non-negative.

Returns:

The number of pixels for the border to cover on-screen across its right side

Since:

1.2.0

Since Minecraft:

1.20.2

Since Resource-Pack Format:

18