Package net.kyori.adventure.text

Interface BlockNBTComponent

All Superinterfaces:

Buildable<BlockNBTComponent,BlockNBTComponent.Builder>, BuildableComponent<BlockNBTComponent,BlockNBTComponent.Builder>, Component, ComponentBuilderApplicable, ComponentLike, net.kyori.examination.Examinable, HoverEventSource<Component>, NBTComponent<BlockNBTComponent,BlockNBTComponent.Builder>, ScopedComponent<BlockNBTComponent>, StyleGetter, StyleSetter<Component>

public interface BlockNBTComponent
extends NBTComponent<BlockNBTComponent,BlockNBTComponent.Builder>, ScopedComponent<BlockNBTComponent>

Given an in-game position, this component reads the NBT of the associated block and displays that information.

This component consists of:

pos

a position in the world the component is being displayed in.

everything in

NBTComponent

Since:

4.0.0

See Also:

• NBTComponent

Since Minecraft:

1.14

Nested Class Summary

Nested Classes

Modifier and Type	Interface	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.

Field Summary

Fields inherited from interface net.kyori.adventure.text.Component

EQUALS, EQUALS_IDENTITY, IS_NOT_EMPTY

Method Summary

Modifier and Type	Method	Description
default @NotNull BlockNBTComponent	absoluteWorldPos(int x, int y, int z)	Sets the block position to an absolute BlockNBTComponent.WorldPos with the given coordinates.
default @NotNull Stream<? extends net.kyori.examination.ExaminableProperty>	examinableProperties()
default @NotNull BlockNBTComponent	localPos(double left, double up, double forwards)	Sets the block position to a BlockNBTComponent.LocalPos with the given coordinates.
@NotNull BlockNBTComponent.Pos	pos()	Gets the block position.
@NotNull BlockNBTComponent	pos(@NotNull BlockNBTComponent.Pos pos)	Sets the block position.
default @NotNull BlockNBTComponent	relativeWorldPos(int x, int y, int z)	Sets the block position to an relative BlockNBTComponent.WorldPos with the given coordinates.
default @NotNull BlockNBTComponent	worldPos(@NotNull BlockNBTComponent.WorldPos.Coordinate x, @NotNull BlockNBTComponent.WorldPos.Coordinate y, @NotNull BlockNBTComponent.WorldPos.Coordinate z)	Sets the block position to a BlockNBTComponent.WorldPos with the given coordinates.

Methods inherited from interface net.kyori.adventure.text.BuildableComponent

toBuilder

Methods inherited from interface net.kyori.adventure.text.Component

appendNewline, appendSpace, applyFallbackStyle, applyFallbackStyle, asComponent, asHoverEvent, children, clickEvent, color, compact, componentBuilderApply, contains, contains, decoration, decorationIfAbsent, decorations, decorations, detectCycle, font, font, hasDecoration, hasStyling, hoverEvent, insertion, iterable, iterable, iterator, iterator, replaceFirstText, replaceFirstText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, shadowColor, spliterator, spliterator, style, style

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examine

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent

Methods inherited from interface net.kyori.adventure.text.NBTComponent

interpret, interpret, nbtPath, nbtPath, separator, separator

Methods inherited from interface net.kyori.adventure.text.ScopedComponent

append, append, append, children, clickEvent, color, colorIfAbsent, decorate, decoration, decoration, hoverEvent, insertion, mergeStyle, mergeStyle, mergeStyle, shadowColor, shadowColorIfAbsent, style, style, style

Methods inherited from interface net.kyori.adventure.text.format.StyleSetter

decorate, decorations

Method Details

pos

@NotNull
@NotNull BlockNBTComponent.Pos pos()

Gets the block position.

Returns:

the block position

Since:

4.0.0

pos

@Contract(pure=true)
@NotNull
@NotNull BlockNBTComponent pos(@NotNull
 @NotNull BlockNBTComponent.Pos pos)

Sets the block position.

Parameters:

pos - the block position

Returns:

a block NBT component

Since:

4.0.0

localPos

@Contract(pure=true)
@NotNull
default @NotNull 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 block NBT component

Since:

4.0.0

worldPos

@Contract(pure=true)
@NotNull
default @NotNull BlockNBTComponent worldPos(@NotNull BlockNBTComponent.WorldPos.Coordinate x,
 @NotNull BlockNBTComponent.WorldPos.Coordinate y,
 @NotNull 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 block NBT component

Since:

4.0.0

absoluteWorldPos

@Contract(pure=true)
@NotNull
default @NotNull 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 block NBT component

Since:

4.0.0

relativeWorldPos

@Contract(pure=true)
@NotNull
default @NotNull 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 block NBT component

Since:

4.0.0

examinableProperties

@NotNull
default @NotNull Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()

Specified by:

examinableProperties in interface Component

Specified by:

examinableProperties in interface net.kyori.examination.Examinable

Specified by:

examinableProperties in interface NBTComponent<BlockNBTComponent,BlockNBTComponent.Builder>