Interface BlockNBTComponent

All Superinterfaces:

Component, ComponentBuilderApplicable, ComponentLike, HoverEventSource<Component>, NBTComponent<BlockNBTComponent>, ScopedComponent<BlockNBTComponent>, StyleGetter, StyleSetter<Component>

public sealed interface BlockNBTComponent
extends NBTComponent<BlockNBTComponent>, 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 Component

EQUALS, EQUALS_IDENTITY, IS_NOT_EMPTY

Fields inherited from interface NBTComponent

INTERPRET_DEFAULT, PLAIN_DEFAULT

Method Summary

Modifier and Type	Method	Description
default BlockNBTComponent	absoluteWorldPos(int x, int y, int z)	Sets the block position to an absolute BlockNBTComponent.WorldPos with the given coordinates.
default BlockNBTComponent	localPos(double left, double up, double forwards)	Sets the block position to a BlockNBTComponent.LocalPos with the given coordinates.
BlockNBTComponent.Pos	pos()	Gets the block position.
BlockNBTComponent	pos(BlockNBTComponent.Pos pos)	Sets the block position.
default BlockNBTComponent	relativeWorldPos(int x, int y, int z)	Sets the block position to an relative BlockNBTComponent.WorldPos with the given coordinates.
BlockNBTComponent.Builder	toBuilder()	Returns a builder for this component.
default 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 Component

asHoverEvent, children, clickEvent, color, compact, compact, componentBuilderApply, contains, contains, decoration, decorations, font, hasDecoration, hasStyling, hoverEvent, insertion, iterable, iterable, iterator, iterator, replaceText, replaceText, shadowColor, spliterator, spliterator, style

Methods inherited from interface HoverEventSource

asHoverEvent

Methods inherited from interface NBTComponent

interpret, interpret, nbtPath, nbtPath, plain, plain, separator, separator

Methods inherited from interface ScopedComponent

append, append, append, append, append, appendNewline, appendSpace, applyFallbackStyle, applyFallbackStyle, asComponent, children, clickEvent, color, colorIfAbsent, decorate, decoration, decoration, decorationIfAbsent, decorations, font, hoverEvent, insertion, mergeStyle, mergeStyle, mergeStyle, shadowColor, shadowColorIfAbsent, style, style, style, style

Methods inherited from interface StyleSetter

decorate, decorations

Method Details

pos

BlockNBTComponent.Pos pos()

Gets the block position.

Returns:

the block position

Since:

4.0.0

pos

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

Since:

4.0.0

absoluteWorldPos

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

toBuilder

BlockNBTComponent.Builder toBuilder()

Description copied from interface: Component

Returns a builder for this component.

Specified by:

toBuilder in interface Component

Specified by:

toBuilder in interface NBTComponent<BlockNBTComponent>

Specified by:

toBuilder in interface ScopedComponent<BlockNBTComponent>

Returns:

the builder