com.pixelmonmod.pixelmon.api.util

Class PixelBlockSnapshot

java.lang.Object

com.pixelmonmod.pixelmon.api.util.PixelBlockSnapshot

public class PixelBlockSnapshot
extends java.lang.Object

Created by clienthax on 15/3/2015. Massively modified by MrM.

Field Summary

Fields

Modifier and Type	Field and Description
net.minecraft.util.ResourceLocation	blockIdentifier The mod ID of the block.
static java.lang.String	PIXEL_SNAPSHOT_BLOCK_NAME The NBT tag for a block's name
net.minecraft.util.math.BlockPos	pos The position of the block snapshot.
net.minecraft.block.BlockState	replacedBlock The block represented by the snapshot.
net.minecraft.world.World	world The world that the block snapshot is in.

Constructor Summary

Constructors

Constructor and Description
PixelBlockSnapshot(net.minecraft.util.math.BlockPos pos, net.minecraft.block.BlockState state, net.minecraft.nbt.CompoundNBT nbt) Raw constructor designed for serialization usages.
PixelBlockSnapshot(net.minecraft.util.math.BlockPos pos, java.lang.String modid, java.lang.String blockName, net.minecraft.nbt.CompoundNBT nbt) Raw constructor designed for serialization usages.
PixelBlockSnapshot(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.block.BlockState state) Initializes a block snapshot.
PixelBlockSnapshot(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.block.BlockState state, net.minecraft.nbt.CompoundNBT nbt) Initializes a block snapshot.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static PixelBlockSnapshot	getBlockSnapshot(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Creates a block snapshot for a position.
net.minecraft.block.BlockState	getCurrentBlock() Gets the block in the snapshot's position.
net.minecraft.block.BlockState	getReplacedBlock() Gets the block stored in the snapshot.
net.minecraft.tileentity.TileEntity	getTileEntity() Gets the tile entity in the snapshot.
int	hashCode()
static PixelBlockSnapshot	readFromNBT(net.minecraft.nbt.CompoundNBT tag) Reads a block snapshot from NBT data.
static PixelBlockSnapshot	readFromNBT(net.minecraft.world.World newWorld, net.minecraft.nbt.CompoundNBT tag) Reads a block snapshot from NBT data.
boolean	restore() Restores the block in the snapshot.
boolean	restore(boolean force) Restores the block in the snapshot.
boolean	restore(boolean force, boolean applyPhysics) Restores the block in the snapshot.
boolean	restoreToLocation(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, boolean force, boolean applyPhysics) Restores the block in the snapshot to a specific position.
void	restoreToLocationWithRotation(net.minecraft.util.math.BlockPos pos, net.minecraft.util.Direction facing, int yLevel, boolean recreateTechnicalBlocks) Restores the block in the snapshot to a position with a specific rotation.
void	restoreToLocationWithRotation(net.minecraft.util.math.BlockPos pos, net.minecraft.util.Direction facing, int yLevel, boolean recreateTechnicalBlocks, net.minecraft.item.ItemStack replacement)
void	writeToNBT(net.minecraft.nbt.CompoundNBT compound) Writes the block snapshot to NBT.

Methods inherited from class java.lang.Object

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

Field Detail

PIXEL_SNAPSHOT_BLOCK_NAME

public static final java.lang.String PIXEL_SNAPSHOT_BLOCK_NAME

The NBT tag for a block's name

See Also:

Constant Field Values

pos

public final net.minecraft.util.math.BlockPos pos

The position of the block snapshot.

replacedBlock

public transient net.minecraft.block.BlockState replacedBlock

The block represented by the snapshot.

world

public transient net.minecraft.world.World world

The world that the block snapshot is in.

blockIdentifier

public final net.minecraft.util.ResourceLocation blockIdentifier

The mod ID of the block.

Constructor Detail

PixelBlockSnapshot

public PixelBlockSnapshot(net.minecraft.world.World world,
                          net.minecraft.util.math.BlockPos pos,
                          net.minecraft.block.BlockState state)

Initializes a block snapshot.

Parameters:

world - The world the block snapshot is in.

pos - The position of the block snapshot.

state - The block.

PixelBlockSnapshot

public PixelBlockSnapshot(net.minecraft.world.World world,
                          net.minecraft.util.math.BlockPos pos,
                          net.minecraft.block.BlockState state,
                          net.minecraft.nbt.CompoundNBT nbt)

Initializes a block snapshot.

Parameters:

world - The world the block snapshot is in.

pos - The position of the block snapshot.

state - The block.

nbt - The NBT data for the block.

PixelBlockSnapshot

public PixelBlockSnapshot(net.minecraft.util.math.BlockPos pos,
                          java.lang.String modid,
                          java.lang.String blockName,
                          net.minecraft.nbt.CompoundNBT nbt)

Raw constructor designed for serialization usages.

Parameters:

pos - The position of the block snapshot.

modid - The mod ID of the block.

blockName - The name of the block.

nbt - The NBT data for the block.

PixelBlockSnapshot

public PixelBlockSnapshot(net.minecraft.util.math.BlockPos pos,
                          net.minecraft.block.BlockState state,
                          net.minecraft.nbt.CompoundNBT nbt)

Raw constructor designed for serialization usages.

Parameters:

pos - The position of the block snapshot.

state - The block state.

nbt - The NBT data for the block.

Method Detail

readFromNBT

public static PixelBlockSnapshot readFromNBT(net.minecraft.world.World newWorld,
                                             net.minecraft.nbt.CompoundNBT tag)

Reads a block snapshot from NBT data.

Parameters:

newWorld - The world the block snapshot is to be loaded in.

tag - The block snapshot's NBT data.

Returns:

The block snapshot loaded from NBT data.

getBlockSnapshot

public static PixelBlockSnapshot getBlockSnapshot(net.minecraft.world.World world,
                                                  net.minecraft.util.math.BlockPos pos)

Creates a block snapshot for a position.

Parameters:

world - The world to create a block snapshot for.

pos - The position to create a block snapshot for.

Returns:

A block snapshot of the specified position.

readFromNBT

public static PixelBlockSnapshot readFromNBT(net.minecraft.nbt.CompoundNBT tag)

Reads a block snapshot from NBT data.

Parameters:

tag - The block snapshot's NBT data.

Returns:

The block snapshot loaded from NBT data.

getCurrentBlock

public net.minecraft.block.BlockState getCurrentBlock()

Gets the block in the snapshot's position.

Returns:

The block in the snapshot's position.

getTileEntity

public net.minecraft.tileentity.TileEntity getTileEntity()

Gets the tile entity in the snapshot.

Returns:

The tile entity in the snapshot, or null if the snapshot does not represent one.

restore

public boolean restore()

Restores the block in the snapshot.

Returns:

Whether the block was restored.

restore

public boolean restore(boolean force)

Restores the block in the snapshot.

Parameters:

force - Whether to force the block to be restored if the existing block at the position does not match it.

Returns:

Whether the block was restored.

restore

public boolean restore(boolean force,
                       boolean applyPhysics)

Restores the block in the snapshot.

Parameters:

force - Whether to force the block to be restored if the existing block at the position does not match it.

applyPhysics - Whether gravity-affected blocks should fall.

Returns:

Whether the block was restored.

restoreToLocation

public boolean restoreToLocation(net.minecraft.world.World world,
                                 net.minecraft.util.math.BlockPos pos,
                                 boolean force,
                                 boolean applyPhysics)

Restores the block in the snapshot to a specific position.

Parameters:

world - The world to restore the block to.

pos - The position to restore the block to.

force - Whether to force the block to be restored if the existing block at the position does not match it.

applyPhysics - Whether gravity-affected blocks should fall.

Returns:

Whether the block was restored.

writeToNBT

public void writeToNBT(net.minecraft.nbt.CompoundNBT compound)

Writes the block snapshot to NBT.

Parameters:

compound - The NBT tag to write to.

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

getReplacedBlock

public net.minecraft.block.BlockState getReplacedBlock()

Gets the block stored in the snapshot.

Returns:

The block stored in the snapshot.

restoreToLocationWithRotation

public void restoreToLocationWithRotation(net.minecraft.util.math.BlockPos pos,
                                          net.minecraft.util.Direction facing,
                                          int yLevel,
                                          boolean recreateTechnicalBlocks)

Restores the block in the snapshot to a position with a specific rotation.

Parameters:

pos - The position to restore the block to.

facing - The direction that the block will face.

restoreToLocationWithRotation

public void restoreToLocationWithRotation(net.minecraft.util.math.BlockPos pos,
                                          net.minecraft.util.Direction facing,
                                          int yLevel,
                                          boolean recreateTechnicalBlocks,
                                          net.minecraft.item.ItemStack replacement)