BlockSnapshot (Forge API)

java.lang.Object
-
- net.minecraftforge.common.util.BlockSnapshot
-

-
-
All Implemented Interfaces:
-
java.io.Serializable
-
-
-
-
```
public class BlockSnapshot
-extends java.lang.Object
-implements java.io.Serializable
```
-
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.
-
See Also:
Serialized Form
-

- -

- - -
Field Summary
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
Modifier and Type Field and Description
GameRegistry.UniqueIdentifier blockIdentifier
int dimId
int flag
int meta
Block replacedBlock
World world
int x
int y
int z
-

Fields
Modifier and Type	Field and Description
`GameRegistry.UniqueIdentifier`	`blockIdentifier`
`int`	`dimId`
`int`	`flag`
`int`	`meta`
`Block`	`replacedBlock`
`World`	`world`
`int`	`x`
`int`	`y`
`int`	`z`

- -

Constructor Summary

- - - - - - - - - - - - - - - - - -

Constructors
Constructor and Description
`BlockSnapshot(int dimension, - int x, - int y, - int z, - java.lang.String modid, - java.lang.String blockName, - int meta, - int flag, - NBTTagCompound nbt)` - Raw constructor designed for serialization usages. -
`BlockSnapshot(World world, - int x, - int y, - int z, - Block block, - int meta)`
`BlockSnapshot(World world, - int x, - int y, - int z, - Block block, - int meta, - int flag)`
`BlockSnapshot(World world, - int x, - int y, - int z, - Block block, - int meta, - NBTTagCompound nbt)`

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`static BlockSnapshot`	`getBlockSnapshot(World world, - int x, - int y, - int z)`
`static BlockSnapshot`	`getBlockSnapshot(World world, - int x, - int y, - int z, - int flag)`
`Block`	`getCurrentBlock()`
`Block`	`getReplacedBlock()`
`TileEntity`	`getTileEntity()`
`World`	`getWorld()`
`int`	`hashCode()`
`static BlockSnapshot`	`readFromNBT(NBTTagCompound tag)`
`boolean`	`restore()`
`boolean`	`restore(boolean force)`
`boolean`	`restore(boolean force, - boolean applyPhysics)`
`boolean`	`restoreToLocation(World world, - int x, - int y, - int z, - boolean force, - boolean applyPhysics)`
`void`	`writeToNBT(NBTTagCompound compound)`

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

- -

- - -

Field Detail

- - - -

-
x
-
```
public final int x
```
-

- - - -

-
y
-
```
public final int y
```
-

- - - -

-
z
-
```
public final int z
```
-

- - - -

-
dimId
-
```
public final int dimId
```
-

- - - -

-
replacedBlock
-
```
public transient Block replacedBlock
```
-

- - - -

-
meta
-
```
public final int meta
```
-

- - - -

-
flag
-
```
public int flag
```
-

- - - -

-
world
-
```
public transient World world
```
-

- - - -

blockIdentifier

public final GameRegistry.UniqueIdentifier blockIdentifier

- -

- - -

Constructor Detail

- - - -

BlockSnapshot

public BlockSnapshot(World world,
-             int x,
-             int y,
-             int z,
-             Block block,
-             int meta)

- - - -

BlockSnapshot

public BlockSnapshot(World world,
-             int x,
-             int y,
-             int z,
-             Block block,
-             int meta,
-             NBTTagCompound nbt)

- - - -

BlockSnapshot

public BlockSnapshot(World world,
-             int x,
-             int y,
-             int z,
-             Block block,
-             int meta,
-             int flag)

- - - -

BlockSnapshot

public BlockSnapshot(int dimension,
-             int x,
-             int y,
-             int z,
-             java.lang.String modid,
-             java.lang.String blockName,
-             int meta,
-             int flag,
-             NBTTagCompound nbt)

Raw constructor designed for serialization usages.

- -

- - -

Method Detail

- - - -

getBlockSnapshot

public static BlockSnapshot getBlockSnapshot(World world,
-                             int x,
-                             int y,
-                             int z)

- - - -

getBlockSnapshot

public static BlockSnapshot getBlockSnapshot(World world,
-                             int x,
-                             int y,
-                             int z,
-                             int flag)

- - - -

readFromNBT

public static BlockSnapshot readFromNBT(NBTTagCompound tag)

- - - -

-
getCurrentBlock
-
```
public Block getCurrentBlock()
```
-

- - - -

-
getWorld
-
```
public World getWorld()
```
-

- - - -

-
getReplacedBlock
-
```
public Block getReplacedBlock()
```
-

- - - -

-
getTileEntity
-
```
public TileEntity getTileEntity()
```
-

- - - -

-
restore
-
```
public boolean restore()
```
-

- - - -

restore

public boolean restore(boolean force)

- - - -

restore

public boolean restore(boolean force,
-              boolean applyPhysics)

- - - -

restoreToLocation

public boolean restoreToLocation(World world,
-                        int x,
-                        int y,
-                        int z,
-                        boolean force,
-                        boolean applyPhysics)

- - - -

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
-
-

Class BlockSnapshot

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

x

y

z

dimId

replacedBlock

meta

flag

world

blockIdentifier

Constructor Detail

BlockSnapshot

BlockSnapshot

BlockSnapshot

BlockSnapshot

Method Detail

getBlockSnapshot

getBlockSnapshot

readFromNBT

getCurrentBlock

getWorld

getReplacedBlock

getTileEntity

restore

restore

restore

restoreToLocation

writeToNBT

equals

hashCode