Bukkit/Spigot
dd1bee786b
This metadata implementation has the following features: - All metadata is lazy. Metadata values are not actually computed until another plugin requests them. Memory and CPU are conserved by not computing and storing unnecessary metadata values. - All metadata is cached. Once a metadata value is computed its value is cached in the metadata store to prevent further unnecessary computation. An invalidation mechanism is provided to flush the cache and force recompilation of metadata values. - All metadata is stored in basic data types. Convenience methods in the MetadataValue class allow for the conversion of metadata data types when possible. Restricting metadata to basic data types prevents the accidental linking of large object graphs into metadata. Metadata is persistent across the lifetime of the application and adding large object graphs would damage garbage collector performance. - Metadata access is thread safe. Care has been taken to protect the internal data structures and access them in a thread safe manner. - Metadata is exposed for all objects that descend from Entity, Block, and World. All Entity and World metadata is stored at the Server level and all Block metadata is stored at the World level. - Metadata is NOT keyed on references to original objects - instead metadata is keyed off of unique fields within those objects. Doing this allows metadata to exist for blocks that are in chunks not currently in memory. Additionally, Player objects are keyed off of player name so that Player metadata remains consistent between logins. - Metadata convenience methods have been added to all Entities, Players, Blocks, BlockStates, and World allowing direct access to an individual instance's metadata. - Players and OfflinePlayers share a single metadata store, allowing player metadata to be manipulated regardless of the player's current online status. By: rmichela <deltahat@gmail.com>
328 lines
8.2 KiB
Java
328 lines
8.2 KiB
Java
package org.bukkit.block;
|
|
|
|
import java.util.Collection;
|
|
|
|
import org.bukkit.Chunk;
|
|
import org.bukkit.Material;
|
|
import org.bukkit.World;
|
|
import org.bukkit.Location;
|
|
import org.bukkit.inventory.ItemStack;
|
|
import org.bukkit.metadata.Metadatable;
|
|
|
|
/**
|
|
* Represents a block. This is a live object, and only one Block may exist for
|
|
* any given location in a world. The state of the block may change concurrently
|
|
* to your own handling of it; use block.getState() to get a snapshot state of a
|
|
* block which will not be modified.
|
|
*/
|
|
public interface Block extends Metadatable {
|
|
|
|
/**
|
|
* Gets the metadata for this block
|
|
*
|
|
* @return block specific metadata
|
|
*/
|
|
byte getData();
|
|
|
|
/**
|
|
* Gets the block at the given offsets
|
|
*
|
|
* @param modX X-coordinate offset
|
|
* @param modY Y-coordinate offset
|
|
* @param modZ Z-coordinate offset
|
|
* @return Block at the given offsets
|
|
*/
|
|
Block getRelative(int modX, int modY, int modZ);
|
|
|
|
/**
|
|
* Gets the block at the given face<br />
|
|
* <br />
|
|
* This method is equal to getRelative(face, 1)
|
|
*
|
|
* @param face Face of this block to return
|
|
* @return Block at the given face
|
|
* @see #getRelative(BlockFace, int)
|
|
*/
|
|
Block getRelative(BlockFace face);
|
|
|
|
/**
|
|
* Gets the block at the given distance of the given face<br />
|
|
* <br />
|
|
* For example, the following method places water at 100,102,100; two blocks
|
|
* above 100,100,100.
|
|
*
|
|
* <pre>
|
|
* Block block = world.getBlockAt(100, 100, 100);
|
|
* Block shower = block.getFace(BlockFace.UP, 2);
|
|
* shower.setType(Material.WATER);
|
|
* </pre>
|
|
*
|
|
* @param face Face of this block to return
|
|
* @param distance Distance to get the block at
|
|
* @return Block at the given face
|
|
*/
|
|
Block getRelative(BlockFace face, int distance);
|
|
|
|
/**
|
|
* Gets the type of this block
|
|
*
|
|
* @return block type
|
|
*/
|
|
Material getType();
|
|
|
|
/**
|
|
* Gets the type-id of this block
|
|
*
|
|
* @return block type-id
|
|
*/
|
|
int getTypeId();
|
|
|
|
/**
|
|
* Gets the light level between 0-15
|
|
*
|
|
* @return light level
|
|
*/
|
|
byte getLightLevel();
|
|
|
|
/**
|
|
* Get the amount of light at this block from the sky.
|
|
* <p>
|
|
* Any light given from other sources (such as blocks like torches) will be ignored.
|
|
*
|
|
* @return Sky light level
|
|
*/
|
|
byte getLightFromSky();
|
|
|
|
/**
|
|
* Get the amount of light at this block from nearby blocks.
|
|
* <p>
|
|
* Any light given from other sources (such as the sun) will be ignored.
|
|
*
|
|
* @return Block light level
|
|
*/
|
|
byte getLightFromBlocks();
|
|
|
|
/**
|
|
* Gets the world which contains this Block
|
|
*
|
|
* @return World containing this block
|
|
*/
|
|
World getWorld();
|
|
|
|
/**
|
|
* Gets the x-coordinate of this block
|
|
*
|
|
* @return x-coordinate
|
|
*/
|
|
int getX();
|
|
|
|
/**
|
|
* Gets the y-coordinate of this block
|
|
*
|
|
* @return y-coordinate
|
|
*/
|
|
int getY();
|
|
|
|
/**
|
|
* Gets the z-coordinate of this block
|
|
*
|
|
* @return z-coordinate
|
|
*/
|
|
int getZ();
|
|
|
|
/**
|
|
* Gets the Location of the block
|
|
*
|
|
* @return Location of block
|
|
*/
|
|
Location getLocation();
|
|
|
|
/**
|
|
* Gets the chunk which contains this block
|
|
*
|
|
* @return Containing Chunk
|
|
*/
|
|
Chunk getChunk();
|
|
|
|
/**
|
|
* Sets the metadata for this block
|
|
*
|
|
* @param data New block specific metadata
|
|
*/
|
|
void setData(byte data);
|
|
|
|
void setData(byte data, boolean applyPhysics);
|
|
|
|
/**
|
|
* Sets the type of this block
|
|
*
|
|
* @param type Material to change this block to
|
|
*/
|
|
void setType(Material type);
|
|
|
|
/**
|
|
* Sets the type-id of this block
|
|
*
|
|
* @param type Type-Id to change this block to
|
|
* @return whether the block was changed
|
|
*/
|
|
boolean setTypeId(int type);
|
|
|
|
boolean setTypeId(int type, boolean applyPhysics);
|
|
|
|
boolean setTypeIdAndData(int type, byte data, boolean applyPhysics);
|
|
|
|
/**
|
|
* Gets the face relation of this block compared to the given block<br />
|
|
* <br />
|
|
* For example:
|
|
*
|
|
* <pre>
|
|
* Block current = world.getBlockAt(100, 100, 100);
|
|
* Block target = world.getBlockAt(100, 101, 100);
|
|
*
|
|
* current.getFace(target) == BlockFace.Up;
|
|
* </pre>
|
|
*
|
|
* <br />
|
|
* If the given block is not connected to this block, null may be returned
|
|
*
|
|
* @param block Block to compare against this block
|
|
* @return BlockFace of this block which has the requested block, or null
|
|
*/
|
|
BlockFace getFace(Block block);
|
|
|
|
/**
|
|
* Captures the current state of this block. You may then cast that state
|
|
* into any accepted type, such as Furnace or Sign.
|
|
* <p />
|
|
* The returned object will never be updated, and you are not guaranteed that
|
|
* (for example) a sign is still a sign after you capture its state.
|
|
*
|
|
* @return BlockState with the current state of this block.
|
|
*/
|
|
BlockState getState();
|
|
|
|
/**
|
|
* Returns the biome that this block resides in
|
|
*
|
|
* @return Biome type containing this block
|
|
*/
|
|
Biome getBiome();
|
|
|
|
/**
|
|
* Returns true if the block is being powered by Redstone.
|
|
*
|
|
* @return True if the block is powered.
|
|
*/
|
|
boolean isBlockPowered();
|
|
|
|
/**
|
|
* Returns true if the block is being indirectly powered by Redstone.
|
|
*
|
|
* @return True if the block is indirectly powered.
|
|
*/
|
|
boolean isBlockIndirectlyPowered();
|
|
|
|
/**
|
|
* Returns true if the block face is being powered by Redstone.
|
|
*
|
|
* @param face The block face
|
|
* @return True if the block face is powered.
|
|
*/
|
|
boolean isBlockFacePowered(BlockFace face);
|
|
|
|
/**
|
|
* Returns true if the block face is being indirectly powered by Redstone.
|
|
*
|
|
* @param face The block face
|
|
* @return True if the block face is indirectly powered.
|
|
*/
|
|
boolean isBlockFaceIndirectlyPowered(BlockFace face);
|
|
|
|
/**
|
|
* Returns the redstone power being provided to this block face
|
|
*
|
|
* @param face the face of the block to query or BlockFace.SELF for the block itself
|
|
* @return The power level.
|
|
*/
|
|
int getBlockPower(BlockFace face);
|
|
|
|
/**
|
|
* Returns the redstone power being provided to this block
|
|
*
|
|
* @return The power level.
|
|
*/
|
|
int getBlockPower();
|
|
|
|
/**
|
|
* Checks if this block is empty.
|
|
* <p />
|
|
* A block is considered empty when {@link #getType()} returns {@link Material#AIR}.
|
|
*
|
|
* @return true if this block is empty
|
|
*/
|
|
boolean isEmpty();
|
|
|
|
/**
|
|
* Checks if this block is liquid.
|
|
* <p />
|
|
* A block is considered liquid when {@link #getType()} returns {@link Material#WATER}, {@link Material#STATIONARY_WATER}, {@link Material#LAVA} or {@link Material#STATIONARY_LAVA}.
|
|
*
|
|
* @return true if this block is liquid
|
|
*/
|
|
boolean isLiquid();
|
|
|
|
/**
|
|
* Gets the temperature of the biome of this block
|
|
*
|
|
* @return Temperature of this block
|
|
*/
|
|
double getTemperature();
|
|
|
|
/**
|
|
* Gets the humidity of the biome of this block
|
|
*
|
|
* @return Humidity of this block
|
|
*/
|
|
double getHumidity();
|
|
|
|
/**
|
|
* Returns the reaction of the block when moved by a piston
|
|
*
|
|
* @return reaction
|
|
*/
|
|
PistonMoveReaction getPistonMoveReaction();
|
|
|
|
/**
|
|
* Breaks the block and spawns items as if a player had digged it
|
|
*
|
|
* @return true if the block was destroyed
|
|
*/
|
|
boolean breakNaturally();
|
|
|
|
/**
|
|
* Breaks the block and spawns items as if a player had digged it with a specific tool
|
|
*
|
|
* @param tool The tool or item in hand used for digging
|
|
* @return true if the block was destroyed
|
|
*/
|
|
boolean breakNaturally(ItemStack tool);
|
|
|
|
/**
|
|
* Returns a list of items which would drop by destroying this block
|
|
*
|
|
* @return a list of dropped items for this type of block
|
|
*/
|
|
Collection<ItemStack> getDrops();
|
|
|
|
/**
|
|
* Returns a list of items which would drop by destroying this block with a specific tool
|
|
*
|
|
* @param tool The tool or item in hand used for digging
|
|
* @return a list of dropped items for this type of block
|
|
*/
|
|
Collection<ItemStack> getDrops(ItemStack tool);
|
|
|
|
}
|