ByteBufUtils (Forge API 1.12.2-14.23.5.2859)

java.lang.Object
- net.minecraftforge.fml.common.network.ByteBufUtils

public class ByteBufUtils
extends java.lang.Object

Utilities for interacting with ByteBuf.

Constructor Summary

Constructors
Constructor and Description

ByteBufUtils()

Constructors
Constructor and Description
`ByteBufUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getContentDump(ByteBuf buffer)`
`static ItemStack`	`readItemStack(ByteBuf from)` Read an `ItemStack` from the byte buffer provided.
`static <T extends IForgeRegistryEntry<T>> java.util.List<T>`	`readRegistryEntries(ByteBuf in, IForgeRegistry<T> registry)` Read multiple registry entries from the same registries from the stream.
`static <T extends IForgeRegistryEntry<T>> T`	`readRegistryEntry(ByteBuf in, IForgeRegistry<T> registry)` Read a registry entry from the stream.
`static NBTTagCompound`	`readTag(ByteBuf from)` Read an `NBTTagCompound` from the byte buffer.
`static java.lang.String`	`readUTF8String(ByteBuf from)` Read a UTF8 string from the byte buffer.
`static int`	`readVarInt(ByteBuf buf, int maxSize)` Read a varint from the supplied buffer.
`static int`	`readVarShort(ByteBuf buf)` An extended length short.
`static int`	`varIntByteCount(int toCount)` The number of bytes to write the supplied int using the 7 bit varint encoding.
`static void`	`writeItemStack(ByteBuf to, ItemStack stack)` Write an `ItemStack` using minecraft compatible encoding.
`static <T extends IForgeRegistryEntry<T>> void`	`writeRegistryEntries(ByteBuf out, java.util.Collection<T> entries)` Write multiple registry entries from the same registry to the stream.
`static <T extends IForgeRegistryEntry<T>> void`	`writeRegistryEntry(ByteBuf out, T entry)` Write a registry entry to the stream.
`static void`	`writeTag(ByteBuf to, NBTTagCompound tag)` Write an `NBTTagCompound` to the byte buffer.
`static void`	`writeUTF8String(ByteBuf to, java.lang.String string)` Write a String with UTF8 byte encoding to the buffer.
`static void`	`writeVarInt(ByteBuf to, int toWrite, int maxSize)` Write an integer to the buffer using variable length encoding.
`static void`	`writeVarShort(ByteBuf buf, int toWrite)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ByteBufUtils
```
public ByteBufUtils()
```
- Method Detail
  - varIntByteCount
```
public static int varIntByteCount(int toCount)
```
    The number of bytes to write the supplied int using the 7 bit varint encoding.
    
    Parameters:
    
    toCount - The number to analyse
    
    Returns:
    
    The number of bytes it will take to write it (maximum of 5)
  - readVarInt
```
public static int readVarInt(ByteBuf buf,
                             int maxSize)
```
    Read a varint from the supplied buffer.
    
    Parameters:
    
    buf - The buffer to read from
    
    maxSize - The maximum length of bytes to read
    
    Returns:
    
    The integer
  - readVarShort
```
public static int readVarShort(ByteBuf buf)
```
    An extended length short. Used by custom payload packets to extend size.
    
    Parameters:
    
    buf -
    
    Returns:
  - writeVarShort
```
public static void writeVarShort(ByteBuf buf,
                                 int toWrite)
```
  - writeVarInt
```
public static void writeVarInt(ByteBuf to,
                               int toWrite,
                               int maxSize)
```
    Write an integer to the buffer using variable length encoding. The maxSize constrains how many bytes (and therefore the maximum number) that will be written.
    
    Parameters:
    
    to - The buffer to write to
    
    toWrite - The integer to write
    
    maxSize - The maximum number of bytes to use
  - readUTF8String
```
public static java.lang.String readUTF8String(ByteBuf from)
```
    Read a UTF8 string from the byte buffer. It is encoded as []
    
    Parameters:
    
    from - The buffer to read from
    
    Returns:
    
    The string
  - writeUTF8String
```
public static void writeUTF8String(ByteBuf to,
                                   java.lang.String string)
```
    Write a String with UTF8 byte encoding to the buffer. It is encoded as []
    
    Parameters:
    
    to - the buffer to write to
    
    string - The string to write
  - writeItemStack
```
public static void writeItemStack(ByteBuf to,
                                  ItemStack stack)
```
    Write an ItemStack using minecraft compatible encoding.
    
    Parameters:
    
    to - The buffer to write to
    
    stack - The itemstack to write
  - readItemStack
```
public static ItemStack readItemStack(ByteBuf from)
```
    Read an ItemStack from the byte buffer provided. It uses the minecraft encoding.
    
    Parameters:
    
    from - The buffer to read from
    
    Returns:
    
    The itemstack read
  - writeTag
```
public static void writeTag(ByteBuf to,
                            NBTTagCompound tag)
```
    Write an NBTTagCompound to the byte buffer. It uses the minecraft encoding.
    
    Parameters:
    
    to - The buffer to write to
    
    tag - The tag to write
  - readTag
```
public static NBTTagCompound readTag(ByteBuf from)
```
    Read an NBTTagCompound from the byte buffer. It uses the minecraft encoding.
    
    Parameters:
    
    from - The buffer to read from
    
    Returns:
    
    The read tag
  - writeRegistryEntry
```
public static <T extends IForgeRegistryEntry<T>> void writeRegistryEntry(ByteBuf out,
                                                                         T entry)
```
    Write a registry entry to the stream. The serialized format is not specified and must not be relied upon. Do not use this to write to a file, it is used for client-server communication only.
    
    Parameters:
    
    out - the buffer to write to
    
    entry - the registry entry
  - readRegistryEntry
```
public static <T extends IForgeRegistryEntry<T>> T readRegistryEntry(ByteBuf in,
                                                                     IForgeRegistry<T> registry)
```
    Read a registry entry from the stream. The same format as in writeRegistryEntry(ByteBuf, IForgeRegistryEntry) is used.
    
    Parameters:
    
    in - the buffer to read from
    
    registry - the registry the entry belongs to
    
    Returns:
    
    the read registry entry
  - writeRegistryEntries
```
public static <T extends IForgeRegistryEntry<T>> void writeRegistryEntries(ByteBuf out,
                                                                           java.util.Collection<T> entries)
```
    Write multiple registry entries from the same registry to the stream. The serialized format may be more compact than using writeRegistryEntry(ByteBuf, IForgeRegistryEntry) multiple times.
    
    Parameters:
    
    out - the buffer to write to
    
    entries - the entries to write
  - readRegistryEntries
```
public static <T extends IForgeRegistryEntry<T>> java.util.List<T> readRegistryEntries(ByteBuf in,
                                                                                       IForgeRegistry<T> registry)
```
    Read multiple registry entries from the same registries from the stream. The list of entries must have been written by writeRegistryEntries(ByteBuf, Collection).
    
    Parameters:
    
    in - the buffer to read from
    
    registry - the registry the entries belong to
    
    Returns:
    
    the immutable list of entries
  - getContentDump
```
public static java.lang.String getContentDump(ByteBuf buffer)
```

Class ByteBufUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByteBufUtils

Method Detail

varIntByteCount

readVarInt

readVarShort

writeVarShort

writeVarInt

readUTF8String

writeUTF8String

writeItemStack

readItemStack

writeTag

readTag

writeRegistryEntry

readRegistryEntry

writeRegistryEntries

readRegistryEntries

getContentDump