net.malisis.core.util.blockdata

Class BlockDataHandler

java.lang.Object

net.malisis.core.util.blockdata.BlockDataHandler

@AutoLoad
public class BlockDataHandler
extends java.lang.Object

BlockDataHandler handles custom data being stored for a specific BlockPos.

Custom data is identified by a String identifier, and a way to convert from and into a ByteBuf using registerBlockData(String, Function, Function).

Custom data is then stored and retrieved using setData(String, IBlockAccess, BlockPos, Object), getData(String, IBlockAccess, BlockPos) and removeData(String, IBlockAccess, BlockPos) with the corresponding identifier.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlockDataHandler.HandlerInfo<T> Internal container for custom data identifier and conversion from/to ByteBuf.

Method Summary

Modifier and Type	Method and Description
static BlockDataHandler	get()
static <T> T	getData(java.lang.String identifier, net.minecraft.world.IBlockAccess world, net.minecraft.util.math.BlockPos pos) Gets the custom data stored at the BlockPos for the specified identifier.
java.util.Map<java.lang.String,BlockDataHandler.HandlerInfo<?>>	getHandlerInfos()
void	onChunkWatched(net.minecraftforge.event.world.ChunkWatchEvent.Watch event) Server only.
void	onDataLoad(net.minecraftforge.event.world.ChunkDataEvent.Load event) Saves the data in NBT for the Chunk.
void	onDataSave(net.minecraftforge.event.world.ChunkDataEvent.Save event) On data save.
void	onDataUnload(net.minecraftforge.event.world.ChunkEvent.Unload event) Unloads the data for the Chunk.
static <T> void	registerBlockData(java.lang.String identifier, com.google.common.base.Function<io.netty.buffer.ByteBuf,T> fromBytes, com.google.common.base.Function<T,io.netty.buffer.ByteBuf> toBytes) Registers a custom block data with the specified identifier.
static <T> void	removeData(java.lang.String identifier, net.minecraft.world.IBlockAccess world, net.minecraft.util.math.BlockPos pos) Removes the custom data stored at the BlockPos for the specified identifier.
static <T> void	removeData(java.lang.String identifier, net.minecraft.world.IBlockAccess world, net.minecraft.util.math.BlockPos pos, boolean sendToClients) Removes the custom data stored at the BlockPos for the specified identifier and eventually sends it to clients watching the chunk.
static <T> void	setData(java.lang.String identifier, net.minecraft.world.IBlockAccess world, net.minecraft.util.math.BlockPos pos, T data) Sets the custom data to be stored at the BlockPos for the specified identifier.
static <T> void	setData(java.lang.String identifier, net.minecraft.world.IBlockAccess world, net.minecraft.util.math.BlockPos pos, T data, boolean sendToClients) Sets the custom data to be stored at the BlockPos for the specified identifier and eventually sends the data to the clients watching the chunk.

Methods inherited from class java.lang.Object

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

Method Detail

getHandlerInfos

public java.util.Map<java.lang.String,BlockDataHandler.HandlerInfo<?>> getHandlerInfos()

onDataLoad

public void onDataLoad(net.minecraftforge.event.world.ChunkDataEvent.Load event)

Saves the data in NBT for the Chunk.
Also unloads the data if the Chunk is marked as unloaded.

Parameters:

event - the event

onDataSave

public void onDataSave(net.minecraftforge.event.world.ChunkDataEvent.Save event)

On data save.

Parameters:

event - the event

onDataUnload

public void onDataUnload(net.minecraftforge.event.world.ChunkEvent.Unload event)

Unloads the data for the Chunk.
Does the process client side only because unloading happens before saving on the server.

Parameters:

event - the event

onChunkWatched

public void onChunkWatched(net.minecraftforge.event.world.ChunkWatchEvent.Watch event)

Server only.
Sends the chunks coordinates to the client when they get watched by them.

Parameters:

event - the event

registerBlockData

public static <T> void registerBlockData(java.lang.String identifier,
                                         com.google.common.base.Function<io.netty.buffer.ByteBuf,T> fromBytes,
                                         com.google.common.base.Function<T,io.netty.buffer.ByteBuf> toBytes)

Registers a custom block data with the specified identifier.

Type Parameters:

T - the generic type

Parameters:

identifier - the identifier

fromBytes - the from bytes

toBytes - the to bytes

getData

public static <T> T getData(java.lang.String identifier,
                            net.minecraft.world.IBlockAccess world,
                            net.minecraft.util.math.BlockPos pos)

Gets the custom data stored at the BlockPos for the specified identifier.

Type Parameters:

T - the generic type

Parameters:

identifier - the identifier

world - the world

pos - the pos

Returns:

the data

setData

public static <T> void setData(java.lang.String identifier,
                               net.minecraft.world.IBlockAccess world,
                               net.minecraft.util.math.BlockPos pos,
                               T data)

Sets the custom data to be stored at the BlockPos for the specified identifier.

Type Parameters:

T - the generic type

Parameters:

identifier - the identifier

world - the world

pos - the pos

data - the data

setData

public static <T> void setData(java.lang.String identifier,
                               net.minecraft.world.IBlockAccess world,
                               net.minecraft.util.math.BlockPos pos,
                               T data,
                               boolean sendToClients)

Sets the custom data to be stored at the BlockPos for the specified identifier and eventually sends the data to the clients watching the chunk.

Type Parameters:

T - the generic type

Parameters:

identifier - the identifier

world - the world

pos - the pos

data - the data

sendToClients - the send to clients

removeData

public static <T> void removeData(java.lang.String identifier,
                                  net.minecraft.world.IBlockAccess world,
                                  net.minecraft.util.math.BlockPos pos)

Removes the custom data stored at the BlockPos for the specified identifier.

Type Parameters:

T - the generic type

Parameters:

identifier - the identifier

world - the world

pos - the pos

removeData

public static <T> void removeData(java.lang.String identifier,
                                  net.minecraft.world.IBlockAccess world,
                                  net.minecraft.util.math.BlockPos pos,
                                  boolean sendToClients)

Removes the custom data stored at the BlockPos for the specified identifier and eventually sends it to clients watching the chunk.

Type Parameters:

T - the generic type

Parameters:

identifier - the identifier

world - the world

pos - the pos

sendToClients - the send to clients

get

public static BlockDataHandler get()