com.sk89q.worldedit.bukkit

Class DefaultNmsBlock

java.lang.Object

com.sk89q.worldedit.foundation.Block

com.sk89q.worldedit.blocks.BaseBlock

com.sk89q.worldedit.bukkit.NmsBlock

com.sk89q.worldedit.bukkit.DefaultNmsBlock

All Implemented Interfaces:

TileEntityBlock, NbtValued

public class DefaultNmsBlock
extends NmsBlock

A blind handler of blocks with TileEntity data that directly access Minecraft's classes through CraftBukkit.

Usage of this class may break terribly in the future, and therefore usage should be trapped in a handler for Throwable.

Field Summary

Fields inherited from class com.sk89q.worldedit.foundation.Block

MAX_DATA, MAX_ID

Constructor Summary

Constructors

Constructor and Description
DefaultNmsBlock(int type, int data, net.minecraft.server.v1_7_R2.NBTTagCompound nbtData) Create a new instance with a given type ID, data value, and raw NBTTagCompound copy.
DefaultNmsBlock(int type, int data, TileEntityBlock tileEntityBlock) Create a new instance with a given type ID, data value, and previous TileEntityBlock-implementing object.

Method Summary

Methods

Modifier and Type	Method and Description
static DefaultNmsBlock	get(org.bukkit.World world, Vector position, int type, int data) Build an instance from the given information.
CompoundTag	getNbtData() Get the object's NBT data (tile entity data).
String	getNbtId() Return the name of the title entity ID.
static net.minecraft.server.v1_7_R2.Block	getNmsBlock(int type)
boolean	hasNbtData() Returns whether the block contains NBT data.
static boolean	hasTileEntity(int type)
static boolean	isValidBlockType(int type)
static boolean	set(org.bukkit.World world, Vector position, BaseBlock block) Set an instance or a TileEntityBlock to the given position.
void	setNbtData(CompoundTag tag) Set the object's NBT data (tile entity data).
static boolean	setSafely(BukkitWorld world, Vector position, Block block, boolean notifyAdjacent) Tries to set a block 'safely', as in setting the block data to the location, and then triggering physics only at the end.
static boolean	verify()

Methods inherited from class com.sk89q.worldedit.bukkit.NmsBlock

set, setSafely

Methods inherited from class com.sk89q.worldedit.blocks.BaseBlock

containsFuzzy, cycleData, equals, equalsFuzzy, flip, flip, getType, inIterable, isAir, rotate90, rotate90Reverse, setType

Methods inherited from class com.sk89q.worldedit.foundation.Block

getData, getId, hashCode, hasWildcardData, setData, setId, setIdAndData, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultNmsBlock

public DefaultNmsBlock(int type,
               int data,
               TileEntityBlock tileEntityBlock)

Create a new instance with a given type ID, data value, and previous TileEntityBlock-implementing object.

Parameters:

type - block type ID

data - data value

tileEntityBlock - tile entity block

DefaultNmsBlock

public DefaultNmsBlock(int type,
               int data,
               net.minecraft.server.v1_7_R2.NBTTagCompound nbtData)

Create a new instance with a given type ID, data value, and raw NBTTagCompound copy.

Parameters:

type - block type ID

data - data value

nbtData - raw NBT data

Method Detail

verify

public static boolean verify()

hasNbtData

public boolean hasNbtData()

Description copied from interface: NbtValued

Returns whether the block contains NBT data. NbtValued.getNbtData() must not return null if this method returns true.

Specified by:

hasNbtData in interface NbtValued

Overrides:

hasNbtData in class Block

Returns:

true if there is NBT data

getNbtId

public String getNbtId()

Description copied from interface: TileEntityBlock

Return the name of the title entity ID.

Specified by:

getNbtId in interface TileEntityBlock

Overrides:

getNbtId in class Block

Returns:

tile entity ID, non-null string

getNbtData

public CompoundTag getNbtData()

Description copied from interface: NbtValued

Get the object's NBT data (tile entity data). The returned tag, if modified in any way, should be sent to NbtValued.setNbtData(CompoundTag) so that the instance knows of the changes. Making changes without calling NbtValued.setNbtData(CompoundTag) could have unintended consequences.

NbtValued.hasNbtData() must return true if and only if method does not return null.

Specified by:

getNbtData in interface NbtValued

Overrides:

getNbtData in class Block

Returns:

compound tag, or null

setNbtData

public void setNbtData(CompoundTag tag)
                throws DataException

Description copied from interface: NbtValued

Set the object's NBT data (tile entity data).

Specified by:

setNbtData in interface NbtValued

Overrides:

setNbtData in class Block

Parameters:

tag - NBT data, or null if no data

Throws:

DataException - if possibly the data is invalid

get

public static DefaultNmsBlock get(org.bukkit.World world,
                  Vector position,
                  int type,
                  int data)

Build an instance from the given information.

Parameters:

world - world to get the block from

position - position to get the block at

type - type ID of block

data - data value of block

Returns:

the block, or null

set

public static boolean set(org.bukkit.World world,
          Vector position,
          BaseBlock block)

Set an instance or a TileEntityBlock to the given position.

Parameters:

world - world to set the block in

position - position to set the block at

block - the block to set

Returns:

true if tile entity data was copied to the world

setSafely

public static boolean setSafely(BukkitWorld world,
                Vector position,
                Block block,
                boolean notifyAdjacent)

Tries to set a block 'safely', as in setting the block data to the location, and then triggering physics only at the end.

Parameters:

world - world to set the block in

position - position to set the block at

block - the block to set

notifyAdjacent - true to notify physics and what not

Returns:

true if block id or data was changed

hasTileEntity

public static boolean hasTileEntity(int type)

getNmsBlock

public static net.minecraft.server.v1_7_R2.Block getNmsBlock(int type)

isValidBlockType

public static boolean isValidBlockType(int type)
                                throws NoClassDefFoundError

Throws:

NoClassDefFoundError