PocketMine
Public Member Functions | Static Public Member Functions | Data Fields | Static Public Attributes | Protected Member Functions | Protected Attributes
Block Class Reference
Inheritance diagram for Block:
Position Metadatable Vector3 Solid Transparent Bedrock Bookshelf Bricks BurningFurnace Clay Coal CoalOre Cobblestone Diamond DiamondOre Dirt DoubleSlab DoubleWoodSlab Emerald EmeraldOre EndPortalFrame EndStone Fallable Farmland GlowingObsidian GlowingRedstoneOre Gold GoldOre Grass HardenedClay HayBale Iron IronOre Lapis LapisOre LitPumpkin MonsterSpawner MossStone Mycelium NetherBrick Netherrack Obsidian PackedIce Planks Podzol Pumpkin Quartz Redstone RedstoneOre Sandstone Snow SoulSand Sponge StainedClay Stone StoneBricks Stonecutter TNT Wood Wool Workbench Air Bed BrewingStand Cactus Cake Chest Door EnchantingTable Fence FenceGate Flowable FlowerPot Glass Glowstone GrassPath Ice IronTrapdoor Ladder Leaves Liquid Melon NetherBrickFence SignPost Slab Stair StoneWall Thin Trapdoor TrappedChest Vine WoodSlab

Public Member Functions

 __get ($key)
 
 __construct ($id, $meta=0)
 
 place (Item $item, Block $block, Block $target, $face, $fx, $fy, $fz, Player $player=null)
 
 isBreakable (Item $item)
 
 onBreak (Item $item)
 
 onUpdate ($type)
 
 onActivate (Item $item, Player $player=null)
 
 getHardness ()
 
 getResistance ()
 
 getToolType ()
 
 getFrictionFactor ()
 
 getLightLevel ()
 
 canBePlaced ()
 
 canBeReplaced ()
 
 isTransparent ()
 
 isSolid ()
 
 canBeFlowedInto ()
 
 canBeActivated ()
 
 hasEntityCollision ()
 
 canPassThrough ()
 
 getName ()
 
 getId ()
 
 addVelocityToEntity (Entity $entity, Vector3 $vector)
 
 getDamage ()
 
 setDamage ($meta)
 
 position (Position $v)
 
 getDrops (Item $item)
 
 getBreakTime (Item $item)
 
 canBeBrokenWith (Item $item)
 
 getSide ($side, $step=1)
 
 __toString ()
 
 collidesWithBB (AxisAlignedBB $bb)
 
 onEntityCollide (Entity $entity)
 
 getBoundingBox ()
 
 calculateIntercept (Vector3 $pos1, Vector3 $pos2)
 
 setMetadata ($metadataKey, MetadataValue $metadataValue)
 
 getMetadata ($metadataKey)
 
 hasMetadata ($metadataKey)
 
 removeMetadata ($metadataKey, Plugin $plugin)
 
- Public Member Functions inherited from Position
 __construct ($x=0, $y=0, $z=0, Level $level=null)
 
 getLevel ()
 
 setLevel (Level $level)
 
 isValid ()
 
 setStrong ()
 
 setWeak ()
 
 getSide ($side, $step=1)
 
 __toString ()
 
 setComponents ($x, $y, $z)
 
- Public Member Functions inherited from Vector3
 __construct ($x=0, $y=0, $z=0)
 
 getX ()
 
 getY ()
 
 getZ ()
 
 getFloorX ()
 
 getFloorY ()
 
 getFloorZ ()
 
 getRight ()
 
 getUp ()
 
 getForward ()
 
 getSouth ()
 
 getWest ()
 
 add ($x, $y=0, $z=0)
 
 subtract ($x=0, $y=0, $z=0)
 
 multiply ($number)
 
 divide ($number)
 
 ceil ()
 
 floor ()
 
 round ()
 
 abs ()
 
 getSide ($side, $step=1)
 
 distance (Vector3 $pos)
 
 distanceSquared (Vector3 $pos)
 
 maxPlainDistance ($x=0, $z=0)
 
 length ()
 
 lengthSquared ()
 
 normalize ()
 
 dot (Vector3 $v)
 
 cross (Vector3 $v)
 
 equals (Vector3 $v)
 
 getIntermediateWithXValue (Vector3 $v, $x)
 
 getIntermediateWithYValue (Vector3 $v, $y)
 
 getIntermediateWithZValue (Vector3 $v, $z)
 
 setComponents ($x, $y, $z)
 
 __toString ()
 

Static Public Member Functions

static get ($id, $meta=0, Position $pos=null)
 
- Static Public Member Functions inherited from Position
static fromObject (Vector3 $pos, Level $level=null)
 
- Static Public Member Functions inherited from Vector3
static getOppositeSide ($side)
 

Data Fields

const AIR = 0
 
const STONE = 1
 
const GRASS = 2
 
const DIRT = 3
 
const COBBLESTONE = 4
 
const COBBLE = 4
 
const PLANK = 5
 
const PLANKS = 5
 
const WOODEN_PLANK = 5
 
const WOODEN_PLANKS = 5
 
const SAPLING = 6
 
const SAPLINGS = 6
 
const BEDROCK = 7
 
const WATER = 8
 
const STILL_WATER = 9
 
const LAVA = 10
 
const STILL_LAVA = 11
 
const SAND = 12
 
const GRAVEL = 13
 
const GOLD_ORE = 14
 
const IRON_ORE = 15
 
const COAL_ORE = 16
 
const WOOD = 17
 
const TRUNK = 17
 
const LOG = 17
 
const LEAVES = 18
 
const LEAVE = 18
 
const SPONGE = 19
 
const GLASS = 20
 
const LAPIS_ORE = 21
 
const LAPIS_BLOCK = 22
 
const SANDSTONE = 24
 
const BED_BLOCK = 26
 
const COBWEB = 30
 
const TALL_GRASS = 31
 
const BUSH = 32
 
const DEAD_BUSH = 32
 
const WOOL = 35
 
const DANDELION = 37
 
const ROSE = 38
 
const POPPY = 38
 
const RED_FLOWER = 38
 
const BROWN_MUSHROOM = 39
 
const RED_MUSHROOM = 40
 
const GOLD_BLOCK = 41
 
const IRON_BLOCK = 42
 
const DOUBLE_SLAB = 43
 
const DOUBLE_SLABS = 43
 
const SLAB = 44
 
const SLABS = 44
 
const BRICKS = 45
 
const BRICKS_BLOCK = 45
 
const TNT = 46
 
const BOOKSHELF = 47
 
const MOSS_STONE = 48
 
const MOSSY_STONE = 48
 
const OBSIDIAN = 49
 
const TORCH = 50
 
const FIRE = 51
 
const MONSTER_SPAWNER = 52
 
const WOOD_STAIRS = 53
 
const WOODEN_STAIRS = 53
 
const OAK_WOOD_STAIRS = 53
 
const OAK_WOODEN_STAIRS = 53
 
const CHEST = 54
 
const DIAMOND_ORE = 56
 
const DIAMOND_BLOCK = 57
 
const CRAFTING_TABLE = 58
 
const WORKBENCH = 58
 
const WHEAT_BLOCK = 59
 
const FARMLAND = 60
 
const FURNACE = 61
 
const BURNING_FURNACE = 62
 
const LIT_FURNACE = 62
 
const SIGN_POST = 63
 
const DOOR_BLOCK = 64
 
const WOODEN_DOOR_BLOCK = 64
 
const WOOD_DOOR_BLOCK = 64
 
const LADDER = 65
 
const COBBLE_STAIRS = 67
 
const COBBLESTONE_STAIRS = 67
 
const WALL_SIGN = 68
 
const IRON_DOOR_BLOCK = 71
 
const REDSTONE_ORE = 73
 
const GLOWING_REDSTONE_ORE = 74
 
const LIT_REDSTONE_ORE = 74
 
const SNOW = 78
 
const SNOW_LAYER = 78
 
const ICE = 79
 
const SNOW_BLOCK = 80
 
const CACTUS = 81
 
const CLAY_BLOCK = 82
 
const REEDS = 83
 
const SUGARCANE_BLOCK = 83
 
const FENCE = 85
 
const PUMPKIN = 86
 
const NETHERRACK = 87
 
const SOUL_SAND = 88
 
const GLOWSTONE = 89
 
const GLOWSTONE_BLOCK = 89
 
const LIT_PUMPKIN = 91
 
const JACK_O_LANTERN = 91
 
const CAKE_BLOCK = 92
 
const TRAPDOOR = 96
 
const WOODEN_TRAPDOOR = 96
 
const WOOD_TRAPDOOR = 96
 
const STONE_BRICKS = 98
 
const STONE_BRICK = 98
 
const IRON_BAR = 101
 
const IRON_BARS = 101
 
const GLASS_PANE = 102
 
const GLASS_PANEL = 102
 
const MELON_BLOCK = 103
 
const PUMPKIN_STEM = 104
 
const MELON_STEM = 105
 
const VINE = 106
 
const VINES = 106
 
const FENCE_GATE = 107
 
const BRICK_STAIRS = 108
 
const STONE_BRICK_STAIRS = 109
 
const MYCELIUM = 110
 
const WATER_LILY = 111
 
const LILY_PAD = 111
 
const NETHER_BRICKS = 112
 
const NETHER_BRICK_BLOCK = 112
 
const NETHER_BRICK_FENCE = 113
 
const NETHER_BRICKS_STAIRS = 114
 
const ENCHANTING_TABLE = 116
 
const ENCHANT_TABLE = 116
 
const ENCHANTMENT_TABLE = 116
 
const BREWING_STAND = 117
 
const END_PORTAL_FRAME = 120
 
const END_STONE = 121
 
const SANDSTONE_STAIRS = 128
 
const EMERALD_ORE = 129
 
const EMERALD_BLOCK = 133
 
const SPRUCE_WOOD_STAIRS = 134
 
const SPRUCE_WOODEN_STAIRS = 134
 
const BIRCH_WOOD_STAIRS = 135
 
const BIRCH_WOODEN_STAIRS = 135
 
const JUNGLE_WOOD_STAIRS = 136
 
const JUNGLE_WOODEN_STAIRS = 136
 
const COBBLE_WALL = 139
 
const STONE_WALL = 139
 
const COBBLESTONE_WALL = 139
 
const FLOWER_POT_BLOCK = 140
 
const CARROT_BLOCK = 141
 
const POTATO_BLOCK = 142
 
const ANVIL = 145
 
const TRAPPED_CHEST = 146
 
const REDSTONE_BLOCK = 152
 
const QUARTZ_BLOCK = 155
 
const QUARTZ_STAIRS = 156
 
const DOUBLE_WOOD_SLAB = 157
 
const DOUBLE_WOODEN_SLAB = 157
 
const DOUBLE_WOOD_SLABS = 157
 
const DOUBLE_WOODEN_SLABS = 157
 
const WOOD_SLAB = 158
 
const WOODEN_SLAB = 158
 
const WOOD_SLABS = 158
 
const WOODEN_SLABS = 158
 
const STAINED_CLAY = 159
 
const STAINED_HARDENED_CLAY = 159
 
const LEAVES2 = 161
 
const LEAVE2 = 161
 
const WOOD2 = 162
 
const TRUNK2 = 162
 
const LOG2 = 162
 
const ACACIA_WOOD_STAIRS = 163
 
const ACACIA_WOODEN_STAIRS = 163
 
const DARK_OAK_WOOD_STAIRS = 164
 
const DARK_OAK_WOODEN_STAIRS = 164
 
const IRON_TRAPDOOR = 167
 
const HAY_BALE = 170
 
const CARPET = 171
 
const HARDENED_CLAY = 172
 
const COAL_BLOCK = 173
 
const PACKED_ICE = 174
 
const DOUBLE_PLANT = 175
 
const FENCE_GATE_SPRUCE = 183
 
const FENCE_GATE_BIRCH = 184
 
const FENCE_GATE_JUNGLE = 185
 
const FENCE_GATE_DARK_OAK = 186
 
const FENCE_GATE_ACACIA = 187
 
const GRASS_PATH = 198
 
const PODZOL = 243
 
const BEETROOT_BLOCK = 244
 
const STONECUTTER = 245
 
const GLOWING_OBSIDIAN = 246
 
 $boundingBox = null
 
- Data Fields inherited from Position
 $level = null
 
- Data Fields inherited from Vector3
const SIDE_DOWN = 0
 
const SIDE_UP = 1
 
const SIDE_NORTH = 2
 
const SIDE_SOUTH = 3
 
const SIDE_WEST = 4
 
const SIDE_EAST = 5
 
 $x
 
 $y
 
 $z
 

Static Public Attributes

static $list = null
 
static $fullList = null
 
static $light = null
 
static $lightFilter = null
 
static $solid = null
 
static $hardness = null
 
static $transparent = null
 

Protected Member Functions

 recalculateBoundingBox ()
 

Protected Attributes

 $id
 
 $meta = 0
 

Constructor & Destructor Documentation

__construct (   $id,
  $meta = 0 
)
Parameters
int$id
int$meta

Member Function Documentation

__get (   $key)

Backwards-compatibility with old way to define block properties

Deprecated:
Parameters
string$key
Returns
mixed
__toString ( )
Returns
string
calculateIntercept ( Vector3  $pos1,
Vector3  $pos2 
)
Parameters
Vector3$pos1
Vector3$pos2
Returns
MovingObjectPosition
canBeActivated ( )

AKA: Block->isActivable

Returns
bool
canBeFlowedInto ( )

AKA: Block->isFlowable

Returns
bool
canBePlaced ( )

AKA: Block->isPlaceable

Returns
bool
canBeReplaced ( )

AKA: Block->canBeReplaced()

Returns
bool
collidesWithBB ( AxisAlignedBB  $bb)

Checks for collision against an AxisAlignedBB

Parameters
AxisAlignedBB$bb
Returns
bool
static get (   $id,
  $meta = 0,
Position  $pos = null 
)
static
Parameters
int$id
int$meta
Position$pos
Returns
Block
getBoundingBox ( )
Returns
AxisAlignedBB
getBreakTime ( Item  $item)

Returns the seconds that this block takes to be broken using an specific Item

Parameters
Item$item
Returns
float
getDamage ( )
final
Returns
int
getDrops ( Item  $item)

Returns an array of Item objects to be dropped

Parameters
Item$item
Returns
array
getFrictionFactor ( )
Returns
float
getHardness ( )
Returns
int
getId ( )
final
Returns
int
getLightLevel ( )
Returns
int 0-15
getMetadata (   $metadataKey)

Returns a list of previously set metadata values from the implementing object's metadata store.

Parameters
string$metadataKey
Returns
MetadataValue[]

Implements Metadatable.

getName ( )
Returns
string
getResistance ( )
Returns
int
getSide (   $side,
  $step = 1 
)

Returns the Block on the side $side, works like Vector3::side()

Parameters
int$side
int$step
Returns
Block
getToolType ( )
Returns
int
hasMetadata (   $metadataKey)

Tests to see whether the implementing object contains the given metadata value in its metadata store.

Parameters
string$metadataKey
Returns
boolean

Implements Metadatable.

isBreakable ( Item  $item)

Returns if the item can be broken with an specific Item

Parameters
Item$item
Returns
bool
isTransparent ( )
Returns
bool
onActivate ( Item  $item,
Player  $player = null 
)

Do actions when activated by Item. Returns if it has done anything

Parameters
Item$item
Player$player
Returns
bool
onBreak ( Item  $item)

Do the actions needed so the block is broken with the Item

Parameters
Item$item
Returns
mixed
onEntityCollide ( Entity  $entity)
Parameters
Entity$entity
onUpdate (   $type)

Fires a block update on the Block

Parameters
int$type
Returns
void
place ( Item  $item,
Block  $block,
Block  $target,
  $face,
  $fx,
  $fy,
  $fz,
Player  $player = null 
)

Places the Block, using block space and block target, and side. Returns if the block has been placed.

Parameters
Item$item
Block$block
Block$target
int$face
float$fx
float$fy
float$fz
Player$player= null
Returns
bool
position ( Position  $v)
final

Sets the block position to a new Position object

Parameters
Position$v
recalculateBoundingBox ( )
protected
Returns
AxisAlignedBB
removeMetadata (   $metadataKey,
Plugin  $owningPlugin 
)

Removes the given metadata value from the implementing object's metadata store.

Parameters
string$metadataKey
Plugin$owningPlugin
Returns
void

Implements Metadatable.

setDamage (   $meta)
final
Parameters
int$meta
setMetadata (   $metadataKey,
MetadataValue  $newMetadataValue 
)

Sets a metadata value in the implementing object's metadata store.

Parameters
string$metadataKey
MetadataValue$newMetadataValue
Returns
void

Implements Metadatable.

The documentation for this class was generated from the following file: