net.kyori.text

Interface BlockNbtComponent

All Superinterfaces:

BuildableComponent<BlockNbtComponent,BlockNbtComponent.Builder>, Component, NbtComponent<BlockNbtComponent,BlockNbtComponent.Builder>, ScopedComponent<BlockNbtComponent>

public interface BlockNbtComponent
extends NbtComponent<BlockNbtComponent,BlockNbtComponent.Builder>, ScopedComponent<BlockNbtComponent>

A block NBT component.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BlockNbtComponent.Builder An NBT component builder.
static interface	BlockNbtComponent.LocalPos A local position.
static interface	BlockNbtComponent.Pos A position.
static interface	BlockNbtComponent.WorldPos A world position.

Method Summary

Modifier and Type	Method and Description
default @NonNull BlockNbtComponent	absoluteWorldPos(int x, int y, int z) Sets the block position to an absolute BlockNbtComponent.WorldPos with the given coordinates.
static @NonNull BlockNbtComponent.Builder	builder() Creates a block NBT component builder.
default @NonNull BlockNbtComponent	localPos(double left, double up, double forwards) Sets the block position to a BlockNbtComponent.LocalPos with the given coordinates.
static @NonNull BlockNbtComponent	make(@NonNull java.util.function.Consumer<? super BlockNbtComponent.Builder> consumer) Creates a block NBT component by applying configuration from consumer.
static @NonNull BlockNbtComponent	of(@NonNull java.lang.String nbtPath, @NonNull BlockNbtComponent.Pos pos) Creates a block NBT component with a position.
@NonNull BlockNbtComponent.Pos	pos() Gets the block position.
@NonNull BlockNbtComponent	pos(@NonNull BlockNbtComponent.Pos pos) Sets the block position.
default @NonNull BlockNbtComponent	relativeWorldPos(int x, int y, int z) Sets the block position to an relative BlockNbtComponent.WorldPos with the given coordinates.
default @NonNull BlockNbtComponent	worldPos(BlockNbtComponent.WorldPos.Coordinate x, BlockNbtComponent.WorldPos.Coordinate y, BlockNbtComponent.WorldPos.Coordinate z) Sets the block position to a BlockNbtComponent.WorldPos with the given coordinates.

Methods inherited from interface net.kyori.text.NbtComponent

interpret, interpret, nbtPath, nbtPath

Methods inherited from interface net.kyori.text.BuildableComponent

toBuilder

Methods inherited from interface net.kyori.text.Component

append, append, children, children, clickEvent, clickEvent, color, color, contains, decoration, decoration, decoration, decorations, decorations, detectCycle, hasDecoration, hasStyling, hoverEvent, hoverEvent, insertion, insertion, mergeColor, mergeDecorations, mergeEvents, style, style

Methods inherited from interface net.kyori.text.ScopedComponent

append, append, children, clickEvent, color, decoration, decoration, hoverEvent, insertion, mergeColor, mergeDecorations, mergeEvents

Method Detail

builder

static @NonNull BlockNbtComponent.Builder builder()

Creates a block NBT component builder.

Returns:

a builder

of

static @NonNull BlockNbtComponent of(@NonNull java.lang.String nbtPath,
                                     @NonNull BlockNbtComponent.Pos pos)

Creates a block NBT component with a position.

Parameters:

nbtPath - the nbt path

pos - the block position

Returns:

the block NBT component

make

static @NonNull BlockNbtComponent make(@NonNull java.util.function.Consumer<? super BlockNbtComponent.Builder> consumer)

Creates a block NBT component by applying configuration from consumer.

Parameters:

consumer - the builder configurator

Returns:

the block NBT component

pos

@NonNull BlockNbtComponent.Pos pos()

Gets the block position.

Returns:

the block position

pos

@NonNull BlockNbtComponent pos(@NonNull BlockNbtComponent.Pos pos)

Sets the block position.

Parameters:

pos - the block position

Returns:

a component

localPos

default @NonNull BlockNbtComponent localPos(double left,
                                            double up,
                                            double forwards)

Sets the block position to a BlockNbtComponent.LocalPos with the given coordinates.

Parameters:

left - the left coordinate

up - the up coordinate

forwards - the forwards coordinate

Returns:

a component

worldPos

default @NonNull BlockNbtComponent worldPos(BlockNbtComponent.WorldPos.Coordinate x,
                                            BlockNbtComponent.WorldPos.Coordinate y,
                                            BlockNbtComponent.WorldPos.Coordinate z)

Sets the block position to a BlockNbtComponent.WorldPos with the given coordinates.

Parameters:

x - the x coordinate

y - the y coordinate

z - the z coordinate

Returns:

a component

absoluteWorldPos

default @NonNull BlockNbtComponent absoluteWorldPos(int x,
                                                    int y,
                                                    int z)

Sets the block position to an absolute BlockNbtComponent.WorldPos with the given coordinates.

Parameters:

x - the x coordinate

y - the y coordinate

z - the z coordinate

Returns:

a component

relativeWorldPos

default @NonNull BlockNbtComponent relativeWorldPos(int x,
                                                    int y,
                                                    int z)

Sets the block position to an relative BlockNbtComponent.WorldPos with the given coordinates.

Parameters:

x - the x coordinate

y - the y coordinate

z - the z coordinate

Returns:

a component