com.nukkitx.protocol.bedrock

Class BedrockPacketHelper

java.lang.Object

com.nukkitx.protocol.bedrock.BedrockPacketHelper

Direct Known Subclasses:

NoopBedrockPacketHelper

public abstract class BedrockPacketHelper
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Int2ObjectBiMap<CommandParam>	commandParams
protected Int2ObjectBiMap<EntityData>	entityData
protected Int2ObjectBiMap<EntityData.Type>	entityDataTypes
protected Int2ObjectBiMap<EntityEventType>	entityEvents
protected Int2ObjectBiMap<EntityFlag>	entityFlags
protected it.unimi.dsi.fastutil.objects.Object2IntMap<Class<?>>	gameRuleTypes
protected Int2ObjectBiMap<LevelEventType>	levelEvents
protected static InternalLogger	log
protected Int2ObjectBiMap<ResourcePackType>	resourcePackTypes
protected Int2ObjectBiMap<SoundEvent>	soundEvents

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BedrockPacketHelper()

Method Summary

Modifier and Type	Method and Description
void	addCommandParam(int index, CommandParam commandParam)
protected void	addEntityData(int index, EntityData entityData)
protected void	addEntityDataType(int index, EntityData.Type type)
protected void	addEntityEvent(int index, EntityEventType type)
protected void	addEntityFlag(int index, EntityFlag flag)
protected void	addGameRuleType(int index, Class<?> clazz)
protected void	addLevelEvent(int index, LevelEventType levelEventType)
void	addResourcePackType(int index, ResourcePackType resourcePackType)
protected void	addSoundEvent(int index, SoundEvent soundEvent)
String	getBlockingItemIdentifier() In case of identifier being different in any version, helper can be used to return correct identifier.
CommandParam	getCommandParam(int index)
int	getCommandParamId(CommandParam commandParam)
EntityEventType	getEntityEvent(int id)
int	getEntityEventId(EntityEventType type)
int	getIdFromStackRequestActionType(StackRequestActionType type)
LevelEventType	getLevelEvent(int id)
int	getLevelEventId(LevelEventType event)
ResourcePackType	getResourcePackType(int index)
int	getResourcePackTypeId(ResourcePackType resourcePackType)
SoundEvent	getSoundEvent(int id)
int	getSoundEventId(SoundEvent event)
StackRequestActionType	getStackRequestActionTypeFromId(int id)
boolean	isBlockingItem(int id, BedrockSession session) Return true if the item id has a blockingTicks attached.
abstract AnimationData	readAnimationData(ByteBuf buffer)
<T> void	readArray(ByteBuf buffer, Collection<T> array, BedrockSession session, TriFunction<ByteBuf,BedrockPacketHelper,BedrockSession,T> function)
<T> void	readArray(ByteBuf buffer, Collection<T> array, BiFunction<ByteBuf,BedrockPacketHelper,T> function)
<T> void	readArray(ByteBuf buffer, Collection<T> array, Function<ByteBuf,T> function)
<T> T[]	readArray(ByteBuf buffer, T[] array, BedrockSession session, TriFunction<ByteBuf,BedrockPacketHelper,BedrockSession,T> function)
<T> T[]	readArray(ByteBuf buffer, T[] array, BiFunction<ByteBuf,BedrockPacketHelper,T> function)
<T> T[]	readArray(ByteBuf buffer, T[] array, Function<ByteBuf,T> function)
<T> void	readArrayShortLE(ByteBuf buffer, Collection<T> array, BiFunction<ByteBuf,BedrockPacketHelper,T> function)
<T> void	readArrayShortLE(ByteBuf buffer, Collection<T> array, Function<ByteBuf,T> function)
com.nukkitx.math.vector.Vector3i	readBlockPosition(ByteBuf buffer)
ByteBuf	readBuffer(ByteBuf buffer)
float	readByteAngle(ByteBuf buffer)
byte[]	readByteArray(ByteBuf buffer)
com.nukkitx.math.vector.Vector3f	readByteRotation(ByteBuf buffer)
abstract CommandEnumData	readCommandEnum(ByteBuf buffer, boolean soft)
CommandEnumConstraintData	readCommandEnumConstraints(ByteBuf buffer, List<CommandEnumData> enums, List<String> enumValues)
abstract CommandOriginData	readCommandOrigin(ByteBuf buffer)
ContainerMixData	readContainerChangeRecipe(ByteBuf buffer)
abstract void	readEntityData(ByteBuf buffer, EntityDataMap entityData)
abstract EntityLinkData	readEntityLink(ByteBuf buffer)
void	readExperiments(ByteBuf buffer, List<ExperimentData> experiments)
abstract GameRuleData<?>	readGameRule(ByteBuf buffer)
abstract ImageData	readImage(ByteBuf buffer)
boolean	readInventoryActions(ByteBuf buffer, BedrockSession session, List<InventoryActionData> actions)
abstract ItemData	readItem(ByteBuf buffer, BedrockSession session)
abstract ItemData	readItemInstance(ByteBuf buffer, BedrockSession session)
ItemStackRequest	readItemStackRequest(ByteBuf buffer, BedrockSession session)
void	readItemUse(ByteBuf buffer, InventoryTransactionPacket packet, BedrockSession session)
AsciiString	readLEAsciiString(ByteBuf buffer)
abstract ItemData	readNetItem(ByteBuf buffer, BedrockSession session)
<O> O	readOptional(ByteBuf buffer, O emptyValue, Function<ByteBuf,O> function)
PotionMixData	readPotionRecipe(ByteBuf buffer)
ItemData	readRecipeIngredient(ByteBuf buffer)
abstract SerializedSkin	readSkin(ByteBuf buffer)
InventorySource	readSource(ByteBuf buffer)
String	readString(ByteBuf buffer)
abstract StructureSettings	readStructureSettings(ByteBuf buffer)
<T> T	readTag(ByteBuf buffer)
UUID	readUuid(ByteBuf buffer)
com.nukkitx.math.vector.Vector2f	readVector2f(ByteBuf buffer)
com.nukkitx.math.vector.Vector3f	readVector3f(ByteBuf buffer)
com.nukkitx.math.vector.Vector3i	readVector3i(ByteBuf buffer)
protected abstract void	registerCommandParams()
protected abstract void	registerEntityData()
protected abstract void	registerEntityDataTypes()
protected abstract void	registerEntityEvents()
protected abstract void	registerEntityFlags()
protected abstract void	registerGameRuleTypes()
protected abstract void	registerLevelEvents()
protected abstract void	registerResourcePackTypes()
protected abstract void	registerSoundEvents()
protected void	registerStackActionRequestTypes()
void	removeCommandParam(CommandParam type)
void	removeCommandParam(int index)
abstract void	writeAnimationData(ByteBuf buffer, AnimationData animation)
<T> void	writeArray(ByteBuf buffer, Collection<T> array, BedrockSession session, QuadConsumer<ByteBuf,BedrockPacketHelper,BedrockSession,T> consumer)
<T> void	writeArray(ByteBuf buffer, Collection<T> array, BiConsumer<ByteBuf,T> biConsumer)
<T> void	writeArray(ByteBuf buffer, Collection<T> array, TriConsumer<ByteBuf,BedrockPacketHelper,T> consumer)
<T> void	writeArray(ByteBuf buffer, T[] array, BedrockSession session, QuadConsumer<ByteBuf,BedrockPacketHelper,BedrockSession,T> consumer)
<T> void	writeArray(ByteBuf buffer, T[] array, BiConsumer<ByteBuf,T> biConsumer)
<T> void	writeArray(ByteBuf buffer, T[] array, TriConsumer<ByteBuf,BedrockPacketHelper,T> consumer)
<T> void	writeArrayShortLE(ByteBuf buffer, Collection<T> array, BiConsumer<ByteBuf,T> biConsumer)
<T> void	writeArrayShortLE(ByteBuf buffer, Collection<T> array, TriConsumer<ByteBuf,BedrockPacketHelper,T> consumer)
void	writeBlockPosition(ByteBuf buffer, com.nukkitx.math.vector.Vector3i blockPosition)
void	writeBuffer(ByteBuf buffer, ByteBuf toWrite)
void	writeByteAngle(ByteBuf buffer, float angle)
void	writeByteArray(ByteBuf buffer, byte[] bytes)
void	writeByteRotation(ByteBuf buffer, com.nukkitx.math.vector.Vector3f rotation)
abstract void	writeCommandEnum(ByteBuf buffer, CommandEnumData commandEnum)
void	writeCommandEnumConstraints(ByteBuf buffer, CommandEnumConstraintData data, List<CommandEnumData> enums, List<String> enumValues)
abstract void	writeCommandOrigin(ByteBuf buffer, CommandOriginData commandOrigin)
void	writeContainerChangeRecipe(ByteBuf buffer, ContainerMixData data)
abstract void	writeEntityData(ByteBuf buffer, EntityDataMap entityData)
abstract void	writeEntityLink(ByteBuf buffer, EntityLinkData link)
void	writeExperiments(ByteBuf buffer, List<ExperimentData> experiments)
abstract void	writeGameRule(ByteBuf buffer, GameRuleData<?> gameRule)
abstract void	writeImage(ByteBuf buffer, ImageData image)
void	writeInventoryActions(ByteBuf buffer, BedrockSession session, List<InventoryActionData> actions, boolean hasNetworkIds)
abstract void	writeItem(ByteBuf buffer, ItemData item, BedrockSession session)
abstract void	writeItemInstance(ByteBuf buffer, ItemData item, BedrockSession session)
void	writeItemStackRequest(ByteBuf buffer, BedrockSession session, ItemStackRequest request)
void	writeItemUse(ByteBuf buffer, InventoryTransactionPacket packet, BedrockSession session)
void	writeLEAsciiString(ByteBuf buffer, AsciiString string)
abstract void	writeNetItem(ByteBuf buffer, ItemData item, BedrockSession session)
<T> void	writeOptional(ByteBuf buffer, Predicate<T> isPresent, T object, BiConsumer<ByteBuf,T> consumer)
void	writePotionRecipe(ByteBuf buffer, PotionMixData data)
void	writeRecipeIngredient(ByteBuf buffer, ItemData item)
abstract void	writeSkin(ByteBuf buffer, SerializedSkin skin)
void	writeSource(ByteBuf buffer, InventorySource inventorySource)
void	writeString(ByteBuf buffer, String string)
abstract void	writeStructureSettings(ByteBuf buffer, StructureSettings settings)
<T> void	writeTag(ByteBuf buffer, T tag)
void	writeUuid(ByteBuf buffer, UUID uuid)
void	writeVector2f(ByteBuf buffer, com.nukkitx.math.vector.Vector2f vector2f)
void	writeVector3f(ByteBuf buffer, com.nukkitx.math.vector.Vector3f vector3f)
void	writeVector3i(ByteBuf buffer, com.nukkitx.math.vector.Vector3i vector3i)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static final InternalLogger log

entityData

protected final Int2ObjectBiMap<EntityData> entityData

entityFlags

protected final Int2ObjectBiMap<EntityFlag> entityFlags

entityDataTypes

protected final Int2ObjectBiMap<EntityData.Type> entityDataTypes

entityEvents

protected final Int2ObjectBiMap<EntityEventType> entityEvents

gameRuleTypes

protected final it.unimi.dsi.fastutil.objects.Object2IntMap<Class<?>> gameRuleTypes

soundEvents

protected final Int2ObjectBiMap<SoundEvent> soundEvents

levelEvents

protected final Int2ObjectBiMap<LevelEventType> levelEvents

commandParams

protected final Int2ObjectBiMap<CommandParam> commandParams

resourcePackTypes

protected final Int2ObjectBiMap<ResourcePackType> resourcePackTypes

Constructor Detail

BedrockPacketHelper

protected BedrockPacketHelper()

Method Detail

addGameRuleType

protected final void addGameRuleType(int index,
                                     Class<?> clazz)

addEntityData

protected final void addEntityData(int index,
                                   EntityData entityData)

addEntityFlag

protected final void addEntityFlag(int index,
                                   EntityFlag flag)

addEntityDataType

protected final void addEntityDataType(int index,
                                       EntityData.Type type)

addEntityEvent

protected final void addEntityEvent(int index,
                                    EntityEventType type)

addSoundEvent

protected final void addSoundEvent(int index,
                                   SoundEvent soundEvent)

addLevelEvent

protected final void addLevelEvent(int index,
                                   LevelEventType levelEventType)

getEntityEventId

public final int getEntityEventId(EntityEventType type)

getEntityEvent

public final EntityEventType getEntityEvent(int id)

getSoundEventId

public final int getSoundEventId(SoundEvent event)

getSoundEvent

public final SoundEvent getSoundEvent(int id)

getLevelEventId

public final int getLevelEventId(LevelEventType event)

getLevelEvent

public final LevelEventType getLevelEvent(int id)

addCommandParam

public final void addCommandParam(int index,
                                  CommandParam commandParam)

getCommandParam

public final CommandParam getCommandParam(int index)

getCommandParamId

public final int getCommandParamId(CommandParam commandParam)

removeCommandParam

public final void removeCommandParam(int index)

removeCommandParam

public final void removeCommandParam(CommandParam type)

addResourcePackType

public final void addResourcePackType(int index,
                                      ResourcePackType resourcePackType)

getResourcePackType

public final ResourcePackType getResourcePackType(int index)

getResourcePackTypeId

public final int getResourcePackTypeId(ResourcePackType resourcePackType)

registerEntityData

protected abstract void registerEntityData()

registerEntityFlags

protected abstract void registerEntityFlags()

registerEntityDataTypes

protected abstract void registerEntityDataTypes()

registerEntityEvents

protected abstract void registerEntityEvents()

registerGameRuleTypes

protected abstract void registerGameRuleTypes()

registerSoundEvents

protected abstract void registerSoundEvents()

registerCommandParams

protected abstract void registerCommandParams()

registerResourcePackTypes

protected abstract void registerResourcePackTypes()

registerLevelEvents

protected abstract void registerLevelEvents()

readEntityLink

public abstract EntityLinkData readEntityLink(ByteBuf buffer)

writeEntityLink

public abstract void writeEntityLink(ByteBuf buffer,
                                     EntityLinkData link)

readNetItem

public abstract ItemData readNetItem(ByteBuf buffer,
                                     BedrockSession session)

writeNetItem

public abstract void writeNetItem(ByteBuf buffer,
                                  ItemData item,
                                  BedrockSession session)

readItem

public abstract ItemData readItem(ByteBuf buffer,
                                  BedrockSession session)

writeItem

public abstract void writeItem(ByteBuf buffer,
                               ItemData item,
                               BedrockSession session)

readItemInstance

public abstract ItemData readItemInstance(ByteBuf buffer,
                                          BedrockSession session)

writeItemInstance

public abstract void writeItemInstance(ByteBuf buffer,
                                       ItemData item,
                                       BedrockSession session)

readCommandOrigin

public abstract CommandOriginData readCommandOrigin(ByteBuf buffer)

writeCommandOrigin

public abstract void writeCommandOrigin(ByteBuf buffer,
                                        CommandOriginData commandOrigin)

readGameRule

public abstract GameRuleData<?> readGameRule(ByteBuf buffer)

writeGameRule

public abstract void writeGameRule(ByteBuf buffer,
                                   GameRuleData<?> gameRule)

readEntityData

public abstract void readEntityData(ByteBuf buffer,
                                    EntityDataMap entityData)

writeEntityData

public abstract void writeEntityData(ByteBuf buffer,
                                     EntityDataMap entityData)

readCommandEnum

public abstract CommandEnumData readCommandEnum(ByteBuf buffer,
                                                boolean soft)

writeCommandEnum

public abstract void writeCommandEnum(ByteBuf buffer,
                                      CommandEnumData commandEnum)

readStructureSettings

public abstract StructureSettings readStructureSettings(ByteBuf buffer)

writeStructureSettings

public abstract void writeStructureSettings(ByteBuf buffer,
                                            StructureSettings settings)

readSkin

public abstract SerializedSkin readSkin(ByteBuf buffer)

writeSkin

public abstract void writeSkin(ByteBuf buffer,
                               SerializedSkin skin)

readAnimationData

public abstract AnimationData readAnimationData(ByteBuf buffer)

writeAnimationData

public abstract void writeAnimationData(ByteBuf buffer,
                                        AnimationData animation)

readImage

public abstract ImageData readImage(ByteBuf buffer)

writeImage

public abstract void writeImage(ByteBuf buffer,
                                ImageData image)

readByteArray

public byte[] readByteArray(ByteBuf buffer)

writeByteArray

public void writeByteArray(ByteBuf buffer,
                           byte[] bytes)

readBuffer

public ByteBuf readBuffer(ByteBuf buffer)

writeBuffer

public void writeBuffer(ByteBuf buffer,
                        ByteBuf toWrite)

readString

public String readString(ByteBuf buffer)

writeString

public void writeString(ByteBuf buffer,
                        String string)

readLEAsciiString

public AsciiString readLEAsciiString(ByteBuf buffer)

writeLEAsciiString

public void writeLEAsciiString(ByteBuf buffer,
                               AsciiString string)

readUuid

public UUID readUuid(ByteBuf buffer)

writeUuid

public void writeUuid(ByteBuf buffer,
                      UUID uuid)

readVector3f

public com.nukkitx.math.vector.Vector3f readVector3f(ByteBuf buffer)

writeVector3f

public void writeVector3f(ByteBuf buffer,
                          com.nukkitx.math.vector.Vector3f vector3f)

readVector2f

public com.nukkitx.math.vector.Vector2f readVector2f(ByteBuf buffer)

writeVector2f

public void writeVector2f(ByteBuf buffer,
                          com.nukkitx.math.vector.Vector2f vector2f)

readVector3i

public com.nukkitx.math.vector.Vector3i readVector3i(ByteBuf buffer)

writeVector3i

public void writeVector3i(ByteBuf buffer,
                          com.nukkitx.math.vector.Vector3i vector3i)

readBlockPosition

public com.nukkitx.math.vector.Vector3i readBlockPosition(ByteBuf buffer)

writeBlockPosition

public void writeBlockPosition(ByteBuf buffer,
                               com.nukkitx.math.vector.Vector3i blockPosition)

readByteRotation

public com.nukkitx.math.vector.Vector3f readByteRotation(ByteBuf buffer)

writeByteRotation

public void writeByteRotation(ByteBuf buffer,
                              com.nukkitx.math.vector.Vector3f rotation)

readByteAngle

public float readByteAngle(ByteBuf buffer)

writeByteAngle

public void writeByteAngle(ByteBuf buffer,
                           float angle)

readArray

public <T> void readArray(ByteBuf buffer,
                          Collection<T> array,
                          BiFunction<ByteBuf,BedrockPacketHelper,T> function)

writeArray

public <T> void writeArray(ByteBuf buffer,
                           Collection<T> array,
                           TriConsumer<ByteBuf,BedrockPacketHelper,T> consumer)

readArray

public <T> void readArray(ByteBuf buffer,
                          Collection<T> array,
                          BedrockSession session,
                          TriFunction<ByteBuf,BedrockPacketHelper,BedrockSession,T> function)

writeArray

public <T> void writeArray(ByteBuf buffer,
                           Collection<T> array,
                           BedrockSession session,
                           QuadConsumer<ByteBuf,BedrockPacketHelper,BedrockSession,T> consumer)

readArray

public <T> T[] readArray(ByteBuf buffer,
                         T[] array,
                         BiFunction<ByteBuf,BedrockPacketHelper,T> function)

writeArray

public <T> void writeArray(ByteBuf buffer,
                           T[] array,
                           TriConsumer<ByteBuf,BedrockPacketHelper,T> consumer)

readArray

public <T> T[] readArray(ByteBuf buffer,
                         T[] array,
                         BedrockSession session,
                         TriFunction<ByteBuf,BedrockPacketHelper,BedrockSession,T> function)

writeArray

public <T> void writeArray(ByteBuf buffer,
                           T[] array,
                           BedrockSession session,
                           QuadConsumer<ByteBuf,BedrockPacketHelper,BedrockSession,T> consumer)

readArrayShortLE

public <T> void readArrayShortLE(ByteBuf buffer,
                                 Collection<T> array,
                                 BiFunction<ByteBuf,BedrockPacketHelper,T> function)

writeArrayShortLE

public <T> void writeArrayShortLE(ByteBuf buffer,
                                  Collection<T> array,
                                  TriConsumer<ByteBuf,BedrockPacketHelper,T> consumer)

readArray

public <T> void readArray(ByteBuf buffer,
                          Collection<T> array,
                          Function<ByteBuf,T> function)

writeArray

public <T> void writeArray(ByteBuf buffer,
                           Collection<T> array,
                           BiConsumer<ByteBuf,T> biConsumer)

readArray

public <T> T[] readArray(ByteBuf buffer,
                         T[] array,
                         Function<ByteBuf,T> function)

writeArray

public <T> void writeArray(ByteBuf buffer,
                           T[] array,
                           BiConsumer<ByteBuf,T> biConsumer)

readArrayShortLE

public <T> void readArrayShortLE(ByteBuf buffer,
                                 Collection<T> array,
                                 Function<ByteBuf,T> function)

writeArrayShortLE

public <T> void writeArrayShortLE(ByteBuf buffer,
                                  Collection<T> array,
                                  BiConsumer<ByteBuf,T> biConsumer)

readTag

public <T> T readTag(ByteBuf buffer)

writeTag

public <T> void writeTag(ByteBuf buffer,
                         T tag)

readItemUse

public void readItemUse(ByteBuf buffer,
                        InventoryTransactionPacket packet,
                        BedrockSession session)

writeItemUse

public void writeItemUse(ByteBuf buffer,
                         InventoryTransactionPacket packet,
                         BedrockSession session)

readInventoryActions

public boolean readInventoryActions(ByteBuf buffer,
                                    BedrockSession session,
                                    List<InventoryActionData> actions)

writeInventoryActions

public void writeInventoryActions(ByteBuf buffer,
                                  BedrockSession session,
                                  List<InventoryActionData> actions,
                                  boolean hasNetworkIds)

readSource

public InventorySource readSource(ByteBuf buffer)

writeSource

public void writeSource(ByteBuf buffer,
                        InventorySource inventorySource)

readRecipeIngredient

public ItemData readRecipeIngredient(ByteBuf buffer)

writeRecipeIngredient

public void writeRecipeIngredient(ByteBuf buffer,
                                  ItemData item)

readPotionRecipe

public PotionMixData readPotionRecipe(ByteBuf buffer)

writePotionRecipe

public void writePotionRecipe(ByteBuf buffer,
                              PotionMixData data)

readContainerChangeRecipe

public ContainerMixData readContainerChangeRecipe(ByteBuf buffer)

writeContainerChangeRecipe

public void writeContainerChangeRecipe(ByteBuf buffer,
                                       ContainerMixData data)

readCommandEnumConstraints

public CommandEnumConstraintData readCommandEnumConstraints(ByteBuf buffer,
                                                            List<CommandEnumData> enums,
                                                            List<String> enumValues)

writeCommandEnumConstraints

public void writeCommandEnumConstraints(ByteBuf buffer,
                                        CommandEnumConstraintData data,
                                        List<CommandEnumData> enums,
                                        List<String> enumValues)

isBlockingItem

public boolean isBlockingItem(int id,
                              BedrockSession session)

Return true if the item id has a blockingTicks attached. Only a shield should return true

Parameters:

id - ID of item

session - BedrockSession which holds correct blockingId

Returns:

true if reading/writing blockingTicks

getBlockingItemIdentifier

public String getBlockingItemIdentifier()

In case of identifier being different in any version, helper can be used to return correct identifier.

Returns:

item identifier of shield.

readExperiments

public void readExperiments(ByteBuf buffer,
                            List<ExperimentData> experiments)

writeExperiments

public void writeExperiments(ByteBuf buffer,
                             List<ExperimentData> experiments)

registerStackActionRequestTypes

protected void registerStackActionRequestTypes()

getStackRequestActionTypeFromId

public StackRequestActionType getStackRequestActionTypeFromId(int id)

getIdFromStackRequestActionType

public int getIdFromStackRequestActionType(StackRequestActionType type)

readItemStackRequest

public ItemStackRequest readItemStackRequest(ByteBuf buffer,
                                             BedrockSession session)

writeItemStackRequest

public void writeItemStackRequest(ByteBuf buffer,
                                  BedrockSession session,
                                  ItemStackRequest request)

readOptional

public <O> O readOptional(ByteBuf buffer,
                          O emptyValue,
                          Function<ByteBuf,O> function)

writeOptional

public <T> void writeOptional(ByteBuf buffer,
                              Predicate<T> isPresent,
                              T object,
                              BiConsumer<ByteBuf,T> consumer)