net.minecraftforge.common.util

Class BlockSnapshot

java.lang.Object

net.minecraftforge.common.util.BlockSnapshot

public class BlockSnapshot
extends java.lang.Object

Represents a captured snapshot of a block which will not change automatically.

Unlike Block, which only one object can exist per coordinate, BlockSnapshot can exist multiple times for any given Block.

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	DEBUG
private int	dimId
private int	flag
private int	meta
private CompoundNBT	nbt
private BlockPos	pos
private ResourceLocation	registryName
private BlockState	replacedBlock
private java.lang.ref.WeakReference<IWorld>	world

Constructor Summary

Constructors

Constructor and Description
BlockSnapshot(int dimension, BlockPos pos, ResourceLocation registryName, int meta, int flag, CompoundNBT nbt) Raw constructor designed for serialization usages.
BlockSnapshot(IWorld world, BlockPos pos, BlockState state)
BlockSnapshot(IWorld world, BlockPos pos, BlockState state, CompoundNBT nbt)
BlockSnapshot(IWorld world, BlockPos pos, BlockState state, int flag)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static BlockSnapshot	getBlockSnapshot(IWorld world, BlockPos pos)
static BlockSnapshot	getBlockSnapshot(IWorld world, BlockPos pos, int flag)
BlockState	getCurrentBlock()
int	getDimId()
int	getFlag()
int	getMeta()
CompoundNBT	getNbt()
BlockPos	getPos()
ResourceLocation	getRegistryName()
BlockState	getReplacedBlock()
TileEntity	getTileEntity()
private static CompoundNBT	getTileNBT(TileEntity te)
IWorld	getWorld()
int	hashCode()
static BlockSnapshot	readFromNBT(CompoundNBT tag)
boolean	restore()
boolean	restore(boolean force)
boolean	restore(boolean force, boolean notifyNeighbors)
boolean	restoreToLocation(IWorld world, BlockPos pos, boolean force, boolean notifyNeighbors)
void	setFlag(int flag)
void	setReplacedBlock(BlockState replacedBlock)
void	setWorld(IWorld world)
void	writeToNBT(CompoundNBT compound)

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

private static final boolean DEBUG

pos

private final BlockPos pos

dimId

private final int dimId

replacedBlock

@Nullable
private BlockState replacedBlock

flag

private int flag

nbt

@Nullable
private final CompoundNBT nbt

world

@Nullable
private java.lang.ref.WeakReference<IWorld> world

registryName

private final ResourceLocation registryName

meta

private final int meta

See Also:

Constant Field Values

Constructor Detail

BlockSnapshot

public BlockSnapshot(IWorld world,
                     BlockPos pos,
                     BlockState state)

BlockSnapshot

public BlockSnapshot(IWorld world,
                     BlockPos pos,
                     BlockState state,
                     @Nullable
                     CompoundNBT nbt)

BlockSnapshot

public BlockSnapshot(IWorld world,
                     BlockPos pos,
                     BlockState state,
                     int flag)

BlockSnapshot

public BlockSnapshot(int dimension,
                     BlockPos pos,
                     ResourceLocation registryName,
                     int meta,
                     int flag,
                     @Nullable
                     CompoundNBT nbt)

Raw constructor designed for serialization usages.

Method Detail

getBlockSnapshot

public static BlockSnapshot getBlockSnapshot(IWorld world,
                                             BlockPos pos)

getBlockSnapshot

public static BlockSnapshot getBlockSnapshot(IWorld world,
                                             BlockPos pos,
                                             int flag)

readFromNBT

public static BlockSnapshot readFromNBT(CompoundNBT tag)

getTileNBT

@Nullable
private static CompoundNBT getTileNBT(@Nullable
                                                TileEntity te)

getCurrentBlock

public BlockState getCurrentBlock()

getWorld

public IWorld getWorld()

getReplacedBlock

public BlockState getReplacedBlock()

getTileEntity

@Nullable
public TileEntity getTileEntity()

restore

public boolean restore()

restore

public boolean restore(boolean force)

restore

public boolean restore(boolean force,
                       boolean notifyNeighbors)

restoreToLocation

public boolean restoreToLocation(IWorld world,
                                 BlockPos pos,
                                 boolean force,
                                 boolean notifyNeighbors)

writeToNBT

public void writeToNBT(CompoundNBT compound)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getPos

public BlockPos getPos()

getDimId

public int getDimId()

setReplacedBlock

public void setReplacedBlock(BlockState replacedBlock)

getFlag

public int getFlag()

setFlag

public void setFlag(int flag)

getNbt

@Nullable
public CompoundNBT getNbt()

setWorld

public void setWorld(IWorld world)

getRegistryName

public ResourceLocation getRegistryName()

getMeta

public int getMeta()