Package wtf.choco.veinminer

Interface VeinMiner

All Known Implementing Classes:

VeinMinerServer

public interface VeinMiner

A class holding VeinMiner's core common functionality.

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	PATTERN_BLOCK_STATE	A pattern to match a Minecraft block state.
static final PluginMessageProtocol	PROTOCOL	VeinMiner's messaging protocol.
static final NamespacedKey	PROTOCOL_CHANNEL	The NamespacedKey of the VeinMiner messaging channel.
static final PluginMessageProtocol	PROTOCOL_LEGACY	Deprecated, for removal: This API element is subject to removal in a future version. legacy
static final int	PROTOCOL_VERSION	The version of the VeinMiner protocol.

Method Summary

Modifier and Type	Method	Description
@NotNull String	getVersion()	Get the version of VeinMiner (not to be confused with the protocol version).
default boolean	isClient()	Check whether or not VeinMiner is running on the client.
boolean	isServer()	Check whether or not VeinMiner is running on the server.

Field Details

PATTERN_BLOCK_STATE

static final Pattern PATTERN_BLOCK_STATE

A pattern to match a Minecraft block state. e.g. minecraft:chest[waterlogged=false]

• Group 1: The block's type
• Group 2: The block's states (without the [] brackets)

PROTOCOL_CHANNEL

static final NamespacedKey PROTOCOL_CHANNEL

The NamespacedKey of the VeinMiner messaging channel.

See Also:

• VeinMiner.PROTOCOL.getChannel()

PROTOCOL_VERSION

static final int PROTOCOL_VERSION

The version of the VeinMiner protocol.

See Also:

• VeinMiner.PROTOCOL.getVersion()
• Constant Field Values

PROTOCOL

static final PluginMessageProtocol PROTOCOL

VeinMiner's messaging protocol.

See Also:

• PluginMessageProtocol

PROTOCOL_LEGACY

@Deprecated(since="2.0.0",
            forRemoval=true)
static final PluginMessageProtocol PROTOCOL_LEGACY

Deprecated, for removal: This API element is subject to removal in a future version.

legacy

The legacy protocol for versions before VeinMiner 2.0.0. This protocol is not to be used under any circumstances.

See Also:

• modern protocol

Method Details

getVersion

@NotNull
@NotNull String getVersion()

Get the version of VeinMiner (not to be confused with the protocol version).

Returns:

the version

isServer

boolean isServer()

Check whether or not VeinMiner is running on the server.

Returns:

true if running on the server, false if running on the client

See Also:

• isClient()

isClient

default boolean isClient()

Check whether or not VeinMiner is running on the client.

Returns:

true if running on the client, false if running on the server

See Also:

• isServer()