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 NBTTagCompound	nbt
private BlockPos	pos
private ResourceLocation	registryName
private IBlockState	replacedBlock
private java.lang.ref.WeakReference<World>	world

Constructor Summary

Constructors

Constructor and Description
BlockSnapshot(int dimension, BlockPos pos, ResourceLocation registryName, int meta, int flag, NBTTagCompound nbt) Raw constructor designed for serialization usages.
BlockSnapshot(int dimension, BlockPos pos, java.lang.String modId, java.lang.String blockName, int meta, int flag, NBTTagCompound nbt) Deprecated. use BlockSnapshot(int, BlockPos, ResourceLocation, int, int, NBTTagCompound)
BlockSnapshot(World world, BlockPos pos, IBlockState state)
BlockSnapshot(World world, BlockPos pos, IBlockState state, int flag)
BlockSnapshot(World world, BlockPos pos, IBlockState state, NBTTagCompound nbt)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static BlockSnapshot	getBlockSnapshot(World world, BlockPos pos)
static BlockSnapshot	getBlockSnapshot(World world, BlockPos pos, int flag)
IBlockState	getCurrentBlock()
int	getDimId()
int	getFlag()
int	getMeta()
NBTTagCompound	getNbt()
BlockPos	getPos()
ResourceLocation	getRegistryName()
IBlockState	getReplacedBlock()
TileEntity	getTileEntity()
private static NBTTagCompound	getTileNBT(TileEntity te)
World	getWorld()
int	hashCode()
static BlockSnapshot	readFromNBT(NBTTagCompound tag)
boolean	restore()
boolean	restore(boolean force)
boolean	restore(boolean force, boolean notifyNeighbors)
boolean	restoreToLocation(World world, BlockPos pos, boolean force, boolean notifyNeighbors)
void	setFlag(int flag)
void	setReplacedBlock(IBlockState replacedBlock)
void	setWorld(World world)
void	writeToNBT(NBTTagCompound 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 IBlockState replacedBlock

flag

private int flag

nbt

@Nullable
private final NBTTagCompound nbt

world

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

registryName

private final ResourceLocation registryName

meta

private final int meta

Constructor Detail

BlockSnapshot

public BlockSnapshot(World world,
                     BlockPos pos,
                     IBlockState state)

BlockSnapshot

public BlockSnapshot(World world,
                     BlockPos pos,
                     IBlockState state,
                     @Nullable
                     NBTTagCompound nbt)

BlockSnapshot

public BlockSnapshot(World world,
                     BlockPos pos,
                     IBlockState state,
                     int flag)

BlockSnapshot

@Deprecated
public BlockSnapshot(int dimension,
                                 BlockPos pos,
                                 java.lang.String modId,
                                 java.lang.String blockName,
                                 int meta,
                                 int flag,
                                 @Nullable
                                 NBTTagCompound nbt)

Deprecated. use BlockSnapshot(int, BlockPos, ResourceLocation, int, int, NBTTagCompound)

BlockSnapshot

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

Raw constructor designed for serialization usages.

Method Detail

getBlockSnapshot

public static BlockSnapshot getBlockSnapshot(World world,
                                             BlockPos pos)

getBlockSnapshot

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

readFromNBT

public static BlockSnapshot readFromNBT(NBTTagCompound tag)

getTileNBT

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

getCurrentBlock

public IBlockState getCurrentBlock()

getWorld

public World getWorld()

getReplacedBlock

public IBlockState 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(World world,
                                 BlockPos pos,
                                 boolean force,
                                 boolean notifyNeighbors)

writeToNBT

public void writeToNBT(NBTTagCompound 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(IBlockState replacedBlock)

getFlag

public int getFlag()

setFlag

public void setFlag(int flag)

getNbt

@Nullable
public NBTTagCompound getNbt()

setWorld

public void setWorld(World world)

getRegistryName

public ResourceLocation getRegistryName()

getMeta

public int getMeta()