Package codechicken.lib.data

Interface MCDataInput

All Known Implementing Classes:

MCDataByteBuf, MCDataInputStream, PacketCustom

public interface MCDataInput

Provides the ability to read various datas from some sort of data stream. See MCDataInputStream to wrap an InputStream to this. See MCByteStream to wrap an ByteBuf to this.

Created by covers1624 on 4/15/20.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	MCDataInput.InputStreamWrapper	Simple wrapper to an InputStream.

Method Summary

Modifier and Type	Method	Description
boolean	readBoolean()	Reads a boolean from the stream.
default boolean[]	readBooleans()	Reads a block of booleans written with, MCDataOutput.writeBooleans(boolean[]), or MCDataOutput.writeBooleans(boolean[], int, int)
byte	readByte()	Reads a byte from the stream.
default io.netty.buffer.ByteBuf	readByteBuf()	Reads a block of bytes written with, MCDataOutput.writeBytes(byte[]), MCDataOutput.writeBytes(byte[], int, int), MCDataOutput.writeByteBuffer(ByteBuffer), or MCDataOutput.writeByteBuf(ByteBuf)
default ByteBuffer	readByteBuffer()	Reads a block of bytes written with, MCDataOutput.writeBytes(byte[]), MCDataOutput.writeBytes(byte[], int, int), MCDataOutput.writeByteBuffer(ByteBuffer), or MCDataOutput.writeByteBuf(ByteBuf)
default byte[]	readBytes()	Reads a block of bytes written with, MCDataOutput.writeBytes(byte[]), MCDataOutput.writeBytes(byte[], int, int), or MCDataOutput.writeByteBuffer(ByteBuffer)
char	readChar()	Reads a char from the stream.
default CharBuffer	readCharBuffer()	Reads a block of chars written with, MCDataOutput.writeChars(char[]), MCDataOutput.writeChars(char[], int, int), or MCDataOutput.writeCharBuffer(CharBuffer)
default char[]	readChars()	Reads a block of chars written with, MCDataOutput.writeChars(char[]), MCDataOutput.writeChars(char[], int, int), or MCDataOutput.writeCharBuffer(CharBuffer)
default net.minecraft.nbt.CompoundTag	readCompoundNBT()	Reads a CompoundTag from the stream.
default Cuboid6	readCuboid()	Reads a Cuboid6 from the stream.
default net.minecraft.core.Direction	readDirection()	Reads a Direction from the stream.
double	readDouble()	Reads a double from the stream.
default DoubleBuffer	readDoubleBuffer()	Reads a block of doubles written with, MCDataOutput.writeDoubles(double[]), MCDataOutput.writeDoubles(double[], int, int), or MCDataOutput.writeDoubleBuffer(DoubleBuffer).
default double[]	readDoubles()	Reads a block of doubles written with, MCDataOutput.writeDoubles(double[]), MCDataOutput.writeDoubles(double[], int, int), or MCDataOutput.writeDoubleBuffer(DoubleBuffer).
default <T extends Enum<T>> T	readEnum(Class<T> clazz)	Reads an Enum value from the stream.
float	readFloat()	Reads a float from the stream.
default FloatBuffer	readFloatBuffer()	Reads a block of floats written with, MCDataOutput.writeFloats(float[]), MCDataOutput.writeFloats(float[], int, int), or MCDataOutput.writeFloatBuffer(FloatBuffer).
default float[]	readFloats()	Reads a block of floats written with, MCDataOutput.writeFloats(float[]), MCDataOutput.writeFloats(float[], int, int), or MCDataOutput.writeFloatBuffer(FloatBuffer).
default net.minecraftforge.fluids.FluidStack	readFluidStack()	Reads a FluidStack from the stream.
int	readInt()	Reads an int from the stream.
default IntBuffer	readIntBuffer()	Reads a block of ints written with, MCDataOutput.writeInts(int[]), MCDataOutput.writeInts(int[], int, int), or MCDataOutput.writeIntBuffer(IntBuffer).
default int[]	readInts()	Reads a block of ints written with, MCDataOutput.writeInts(int[]), MCDataOutput.writeInts(int[], int, int), or MCDataOutput.writeIntBuffer(IntBuffer).
default net.minecraft.world.item.ItemStack	readItemStack()	Reads an ItemStack from the stream.
long	readLong()	Reads a long from the stream.
default LongBuffer	readLongBuffer()	Reads a block of longs written with, MCDataOutput.writeLongs(long[]), MCDataOutput.writeLongs(long[], int, int), or MCDataOutput.writeLongBuffer(LongBuffer).
default long[]	readLongs()	Reads a block of longs written with, MCDataOutput.writeLongs(long[]), MCDataOutput.writeLongs(long[], int, int), or MCDataOutput.writeLongBuffer(LongBuffer).
default net.minecraft.core.BlockPos	readPos()	Reads a BlockPos from the stream.
default <T> T	readRegistryId()	Reads a registry object from the stream.
default <T> T	readRegistryIdDirect(net.minecraftforge.registries.IForgeRegistry<T> registry)	Reads a registry object from the stream.
default net.minecraft.resources.ResourceLocation	readResourceLocation()	Reads a ResourceLocation from the stream.
short	readShort()	Reads a Short from the stream.
default ShortBuffer	readShortBuffer()	Reads a block of shorts written with, MCDataOutput.writeShorts(short[]), MCDataOutput.writeShorts(short[], int, int), or MCDataOutput.writeShortBuffer(ShortBuffer).
default short[]	readShorts()	Reads a block of shorts written with, MCDataOutput.writeShorts(short[]), MCDataOutput.writeShorts(short[], int, int), or MCDataOutput.writeShortBuffer(ShortBuffer).
default int	readSignedVarInt()	Reads a Variable length signed int.
default int[]	readSignedVarInts()	Reads an array of Variable length Signed ints from the stream.
default long	readSignedVarLong()	Reads a Variable length signed long.
default long[]	readSignedVarLongs()	Reads an array of Variable length Signed longs from the stream.
default String	readString()	Reads a UTF-8 encoded String from the stream.
default net.minecraft.network.chat.MutableComponent	readTextComponent()	Reads an Component from the stream.
short	readUByte()	Reads an Unsigned byte from the stream.
int	readUShort()	Reads an Unsigned short from the stream.
default UUID	readUUID()	Reads a UUID from the stream.
default int	readVarInt()	Reads a Variable length int from the stream.
default int[]	readVarInts()	Reads an array of Variable length ints from the stream.
default long	readVarLong()	Reads a Variable length long from the stream.
default long[]	readVarLongs()	Reads an array of Variable length longs from the stream.
default net.minecraft.world.phys.Vec3	readVec3d()	Reads a Vec3 from the stream.
default org.joml.Vector3f	readVec3f()	Reads a Vector3f from the stream.
default net.minecraft.core.Vec3i	readVec3i()	Reads a Vec3i from the stream.
default Vector3	readVector()	Reads a Vector3 from the stream.
default DataInput	toDataInput()	Wraps this stream into a DataInput stream.
default InputStream	toInputStream()	Wraps this stream into an InputStream.

Method Details

readByte

byte readByte()

Reads a byte from the stream.

Returns:

The byte.

readUByte

short readUByte()

Reads an Unsigned byte from the stream.

Returns:

The Unsigned byte.

readChar

char readChar()

Reads a char from the stream.

Returns:

The char.

readShort

short readShort()

Reads a Short from the stream.

Returns:

The short.

readUShort

int readUShort()

Reads an Unsigned short from the stream.

Returns:

The Unsigned short.

readInt

int readInt()

Reads an int from the stream.

Returns:

The int.

readLong

long readLong()

Reads a long from the stream.

Returns:

The long.

readFloat

float readFloat()

Reads a float from the stream.

Returns:

The float.

readDouble

double readDouble()

Reads a double from the stream.

Returns:

The double.

readBoolean

boolean readBoolean()

Reads a boolean from the stream.

Returns:

The boolean.

readBytes

default byte[] readBytes()

Reads a block of bytes written with, MCDataOutput.writeBytes(byte[]), MCDataOutput.writeBytes(byte[], int, int), or MCDataOutput.writeByteBuffer(ByteBuffer)

Returns:

The bytes.

readChars

default char[] readChars()

Reads a block of chars written with, MCDataOutput.writeChars(char[]), MCDataOutput.writeChars(char[], int, int), or MCDataOutput.writeCharBuffer(CharBuffer)

Returns:

The chars.

readShorts

default short[] readShorts()

Reads a block of shorts written with, MCDataOutput.writeShorts(short[]), MCDataOutput.writeShorts(short[], int, int), or MCDataOutput.writeShortBuffer(ShortBuffer).

Returns:

The shorts.

readInts

default int[] readInts()

Reads a block of ints written with, MCDataOutput.writeInts(int[]), MCDataOutput.writeInts(int[], int, int), or MCDataOutput.writeIntBuffer(IntBuffer).

Returns:

The ints.

readLongs

default long[] readLongs()

Reads a block of longs written with, MCDataOutput.writeLongs(long[]), MCDataOutput.writeLongs(long[], int, int), or MCDataOutput.writeLongBuffer(LongBuffer).

Returns:

The longs.

readFloats

default float[] readFloats()

Reads a block of floats written with, MCDataOutput.writeFloats(float[]), MCDataOutput.writeFloats(float[], int, int), or MCDataOutput.writeFloatBuffer(FloatBuffer).

Returns:

The floats.

readDoubles

default double[] readDoubles()

Reads a block of doubles written with, MCDataOutput.writeDoubles(double[]), MCDataOutput.writeDoubles(double[], int, int), or MCDataOutput.writeDoubleBuffer(DoubleBuffer).

Returns:

The doubles.

readBooleans

default boolean[] readBooleans()

Reads a block of booleans written with, MCDataOutput.writeBooleans(boolean[]), or MCDataOutput.writeBooleans(boolean[], int, int)

Returns:

The booleans.

readVarInt

default int readVarInt()

Reads a Variable length int from the stream.

Returns:

The int.

readVarLong

default long readVarLong()

Reads a Variable length long from the stream.

Returns:

The long.

readSignedVarInt

default int readSignedVarInt()

Reads a Variable length signed int.

Returns:

The int.

See Also:

• MCDataOutput.writeSignedVarInt(int)

readSignedVarLong

default long readSignedVarLong()

Reads a Variable length signed long.

Returns:

The long.

See Also:

• MCDataOutput.writeSignedVarLong(long)

readVarInts

default int[] readVarInts()

Reads an array of Variable length ints from the stream.

Returns:

The ints.

readVarLongs

default long[] readVarLongs()

Reads an array of Variable length longs from the stream.

Returns:

The longs.

readSignedVarInts

default int[] readSignedVarInts()

Reads an array of Variable length Signed ints from the stream.

Returns:

The ints.

readSignedVarLongs

default long[] readSignedVarLongs()

Reads an array of Variable length Signed longs from the stream.

Returns:

The longs.

readString

default String readString()

Reads a UTF-8 encoded String from the stream.

Returns:

The String.

readUUID

default UUID readUUID()

Reads a UUID from the stream.

Returns:

The UUID.

readEnum

default <T extends Enum<T>> T readEnum(Class<T> clazz)

Reads an Enum value from the stream.

Parameters:

clazz - The Class of the enum.

Returns:

The Enum value.

readByteBuffer

default ByteBuffer readByteBuffer()

Reads a block of bytes written with, MCDataOutput.writeBytes(byte[]), MCDataOutput.writeBytes(byte[], int, int), MCDataOutput.writeByteBuffer(ByteBuffer), or MCDataOutput.writeByteBuf(ByteBuf)

Returns:

The bytes.

readCharBuffer

default CharBuffer readCharBuffer()

Reads a block of chars written with, MCDataOutput.writeChars(char[]), MCDataOutput.writeChars(char[], int, int), or MCDataOutput.writeCharBuffer(CharBuffer)

Returns:

The chars.

readShortBuffer

default ShortBuffer readShortBuffer()

Reads a block of shorts written with, MCDataOutput.writeShorts(short[]), MCDataOutput.writeShorts(short[], int, int), or MCDataOutput.writeShortBuffer(ShortBuffer).

Returns:

The shorts.

readIntBuffer

default IntBuffer readIntBuffer()

Reads a block of ints written with, MCDataOutput.writeInts(int[]), MCDataOutput.writeInts(int[], int, int), or MCDataOutput.writeIntBuffer(IntBuffer).

Returns:

The ints.

readLongBuffer

default LongBuffer readLongBuffer()

Reads a block of longs written with, MCDataOutput.writeLongs(long[]), MCDataOutput.writeLongs(long[], int, int), or MCDataOutput.writeLongBuffer(LongBuffer).

Returns:

The longs.

readFloatBuffer

default FloatBuffer readFloatBuffer()

Reads a block of floats written with, MCDataOutput.writeFloats(float[]), MCDataOutput.writeFloats(float[], int, int), or MCDataOutput.writeFloatBuffer(FloatBuffer).

Returns:

The floats.

readDoubleBuffer

default DoubleBuffer readDoubleBuffer()

Reads a block of doubles written with, MCDataOutput.writeDoubles(double[]), MCDataOutput.writeDoubles(double[], int, int), or MCDataOutput.writeDoubleBuffer(DoubleBuffer).

Returns:

The doubles.

readVector

default Vector3 readVector()

Reads a Vector3 from the stream.

Returns:

The Vector3.

readCuboid

default Cuboid6 readCuboid()

Reads a Cuboid6 from the stream.

Returns:

The Cuboid6.

readResourceLocation

default net.minecraft.resources.ResourceLocation readResourceLocation()

Reads a ResourceLocation from the stream.

Returns:

The ResourceLocation.

readDirection

default net.minecraft.core.Direction readDirection()

Reads a Direction from the stream.

Returns:

The Direction.

readPos

default net.minecraft.core.BlockPos readPos()

Reads a BlockPos from the stream.

Returns:

The BlockPos.

readVec3i

default net.minecraft.core.Vec3i readVec3i()

Reads a Vec3i from the stream.

Returns:

The Vec3i.

readVec3d

default net.minecraft.world.phys.Vec3 readVec3d()

Reads a Vec3 from the stream.

Returns:

The Vec3.

readVec3f

default org.joml.Vector3f readVec3f()

Reads a Vector3f from the stream.

Returns:

The Vector3f.

readCompoundNBT

@Nullable
default net.minecraft.nbt.CompoundTag readCompoundNBT()

Reads a CompoundTag from the stream.

Returns:

The CompoundTag.

readItemStack

default net.minecraft.world.item.ItemStack readItemStack()

Reads an ItemStack from the stream. It should also be noted that this implementation reads the ItemStack.getCount() as a varInt opposed to a byte, as that is favourable in some cases.

Returns:

The ItemStack.

readFluidStack

default net.minecraftforge.fluids.FluidStack readFluidStack()

Reads a FluidStack from the stream.

Returns:

The FluidStack.

readTextComponent

default net.minecraft.network.chat.MutableComponent readTextComponent()

Reads an Component from the stream.

Returns:

The Component.

readRegistryIdDirect

default <T> T readRegistryIdDirect(net.minecraftforge.registries.IForgeRegistry<T> registry)

Reads a registry object from the stream.

Parameters:

registry - The IForgeRegistry to load the entry from.

Returns:

The registry object..

See Also:

• MCDataOutput.writeRegistryIdDirect(IForgeRegistry, Object)
• MCDataOutput.writeRegistryIdDirect(IForgeRegistry, ResourceLocation)

readRegistryId

default <T> T readRegistryId()

Reads a registry object from the stream.

Returns:

The registry object.

See Also:

• MCDataOutput.writeRegistryId(IForgeRegistry, Object)
• MCDataOutput.writeRegistryId(IForgeRegistry, ResourceLocation)

readByteBuf

default io.netty.buffer.ByteBuf readByteBuf()

Reads a block of bytes written with, MCDataOutput.writeBytes(byte[]), MCDataOutput.writeBytes(byte[], int, int), MCDataOutput.writeByteBuffer(ByteBuffer), or MCDataOutput.writeByteBuf(ByteBuf)

Returns:

The bytes.

toDataInput

default DataInput toDataInput()

Wraps this stream into a DataInput stream. any data read from the returned DataInput is read from this stream.

Returns:

The DataInput.

toInputStream

default InputStream toInputStream()

Wraps this stream into an InputStream. any data read from the returned InputStream is read from this stream.

Returns:

The InputStream.