org.cloudburstmc.protocol.bedrock.data.inventory

Interface ItemData

public interface ItemData

Represents item data that is sent over the network.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ItemData.Builder Creates a builder for this item data.

Field Summary

Fields

Modifier and Type	Field and Description
static ItemData	AIR

Method Summary

Modifier and Type	Method and Description
static ItemData.Builder	builder() Creates a new builder for this ItemData.
boolean	equals(ItemData other, boolean checkAmount, boolean checkMetadata, boolean checkUserdata) Checks if this item us equal to another ItemData.
@Nullable BlockDefinition	getBlockDefinition() Gets the block definition of this item, if applicable.
long	getBlockingTicks() Gets the item's blocking ticks.
java.lang.String[]	getCanBreak() Gets the blocks this item can break
java.lang.String[]	getCanPlace() Gets the blocks this item can be placed on.
int	getCount() Gets the item count.
int	getDamage() Gets the item damage.
@NonNull ItemDefinition	getDefinition() Gets the ItemDefinition.
int	getNetId() Gets the item's net id.
@Nullable org.cloudburstmc.nbt.NbtMap	getTag() Gets the item NBT.
boolean	isNull() Gets if this item is null.
boolean	isUsingNetId() Gets whether this item is using a net id.
boolean	isValid() Gets if this item is valid.
void	setNetId(int netId) Sets the item's net id.
default ItemData.Builder	toBuilder() Creates a new builder for this item.

Field Detail

AIR

static final ItemData AIR

Method Detail

getDefinition

@NonNull ItemDefinition getDefinition()

Gets the ItemDefinition.

Returns:

the item definition

getDamage

int getDamage()

Gets the item damage.

Returns:

the item damage

getCount

int getCount()

Gets the item count.

Returns:

the item count

getTag

@Nullable org.cloudburstmc.nbt.NbtMap getTag()

Gets the item NBT.

Returns:

the item NBT

getCanPlace

java.lang.String[] getCanPlace()

Gets the blocks this item can be placed on.

Returns:

the blocks this item can be placed on

getCanBreak

java.lang.String[] getCanBreak()

Gets the blocks this item can break

Returns:

the blocks this item can break

getBlockingTicks

long getBlockingTicks()

Gets the item's blocking ticks.

Returns:

the item's blocking ticks

getBlockDefinition

@Nullable BlockDefinition getBlockDefinition()

Gets the block definition of this item, if applicable.

Returns:

the block definition of this item

isUsingNetId

boolean isUsingNetId()

Gets whether this item is using a net id.

Returns:

whether this item is using a net id

getNetId

int getNetId()

Gets the item's net id.

Returns:

the item's net id

setNetId

void setNetId(int netId)

Sets the item's net id.

Parameters:

netId - the item's net id

isValid

boolean isValid()

Gets if this item is valid.

Returns:

if this item is valid

isNull

boolean isNull()

Gets if this item is null.

Returns:

if this item is null

equals

boolean equals(ItemData other,
               boolean checkAmount,
               boolean checkMetadata,
               boolean checkUserdata)

Checks if this item us equal to another ItemData.

Parameters:

other - the item data to compare against

checkAmount - whether to check the amount

checkMetadata - whether to check the metadata

checkUserdata - whether to check the user data

Returns:

if this item is equal to the other item data

toBuilder

default ItemData.Builder toBuilder()

Creates a new builder for this item.

Returns:

a new builder for this item

builder

static ItemData.Builder builder()

Creates a new builder for this ItemData.

Returns:

a new builder for this ItemData