Package net.kyori.adventure.text

Interface BlockNBTComponent.Pos

All Superinterfaces:

net.kyori.examination.Examinable

All Known Subinterfaces:

BlockNBTComponent.LocalPos, BlockNBTComponent.WorldPos

Enclosing interface:

BlockNBTComponent

public static interface BlockNBTComponent.Pos
extends net.kyori.examination.Examinable

A position.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
@NotNull java.lang.String	asString()	Gets a parseable string representation of this position.
static @NotNull BlockNBTComponent.Pos	fromString(@NotNull java.lang.String input)	Attempt to parse a position from the input string.

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Detail

fromString

@NotNull
static @NotNull BlockNBTComponent.Pos fromString(@NotNull
                                                 @NotNull java.lang.String input)
                                          throws java.lang.IllegalArgumentException

Attempt to parse a position from the input string.

The input string must refer to a local position (with 3 ^-prefixed digits), or a world position (with 3 digits that are global if unprefixed, or relative to the current position if ~-prefixed).

Parameters:

input - input

Returns:

a new pos

Throws:

java.lang.IllegalArgumentException - if the position was in an invalid format

Since:

4.0.0

asString

@NotNull
@NotNull java.lang.String asString()

Gets a parseable string representation of this position.

Returns:

a string representation

Since:

4.0.0

See Also:

fromString(String)