Expose BlockState string representation (#2425)

* Expose BlockState string representation

* Clarify BlockState#asString javadoc
This commit is contained in:
Yeregorix authored and GitHub committed 2022-04-28 20:21:44 +01:00
1 parent a8350d66e8
commit 44f1788068
1 file changed
+8
@@ -157,6 +157,14 @@ public interface BlockState extends State<BlockState>, DirectionRelativeDataHold
return this.mirror(mirror.get());
}
/**
* Gets a string representation of this block state, including the block type and the properties.
* Do not confuse with {@link #toString} which is implementation specific.
*
* @return A string representation of this block state.
*/
String asString();
/**
* An {@link org.spongepowered.api.data.DataHolderBuilder.Immutable} for a {@link BlockState}. Just like the
* {@link org.spongepowered.api.data.DataHolderBuilder.Immutable}, the {@link Value}s passed in to