1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
package org.bukkit.block;
import org.bukkit.Chunk;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.World;
import org.bukkit.block.data.BlockData;
import org.bukkit.material.MaterialData;
import org.bukkit.metadata.Metadatable;
/**
* Represents a captured state of a block, which will not change
* automatically.
* <p>
* Unlike Block, which only one object can exist per coordinate, BlockState
* can exist multiple times for any given Block. Note that another plugin may
* change the state of the block and you will not know, or they may change the
* block to another type entirely, causing your BlockState to become invalid.
*/
public interface BlockState extends Metadatable {
/**
* Gets the block represented by this block state.
*
* @return the block represented by this block state
* @throws IllegalStateException if this block state is not placed
*/
Block getBlock();
/**
* Gets the metadata for this block state.
*
* @return block specific metadata
*/
MaterialData getData();
/**
* Gets the data for this block state.
*
* @return block specific data
*/
BlockData getBlockData();
/**
* Gets the type of this block state.
*
* @return block type
*/
Material getType();
/**
* Gets the current light level of the block represented by this block state.
*
* @return the light level between 0-15
* @throws IllegalStateException if this block state is not placed
*/
byte getLightLevel();
/**
* Gets the world which contains the block represented by this block state.
*
* @return the world containing the block represented by this block state
* @throws IllegalStateException if this block state is not placed
*/
World getWorld();
/**
* Gets the x-coordinate of this block state.
*
* @return x-coordinate
*/
int getX();
/**
* Gets the y-coordinate of this block state.
*
* @return y-coordinate
*/
int getY();
/**
* Gets the z-coordinate of this block state.
*
* @return z-coordinate
*/
int getZ();
/**
* Gets the location of this block state.
* <p>
* If this block state is not placed the location's world will be null!
*
* @return the location
*/
Location getLocation();
/**
* Stores the location of this block state in the provided Location object.
* <p>
* If the provided Location is null this method does nothing and returns
* null.
* <p>
* If this block state is not placed the location's world will be null!
*
* @param loc the location to copy into
* @return The Location object provided or null
*/
Location getLocation(Location loc);
/**
* Gets the chunk which contains the block represented by this block state.
*
* @return the containing Chunk
* @throws IllegalStateException if this block state is not placed
*/
Chunk getChunk();
/**
* Sets the metadata for this block state.
*
* @param data New block specific metadata
*/
void setData(MaterialData data);
/**
* Sets the data for this block state.
*
* @param data New block specific data
*/
void setBlockData(BlockData data);
/**
* Sets the type of this block state.
*
* @param type Material to change this block state to
*/
void setType(Material type);
/**
* Attempts to update the block represented by this state, setting it to
* the new values as defined by this state.
* <p>
* This has the same effect as calling update(false). That is to say,
* this will not modify the state of a block if it is no longer the same
* type as it was when this state was taken. It will return false in this
* eventuality.
*
* @return true if the update was successful, otherwise false
* @see #update(boolean)
*/
boolean update();
/**
* Attempts to update the block represented by this state, setting it to
* the new values as defined by this state.
* <p>
* This has the same effect as calling update(force, true). That is to
* say, this will trigger a physics update to surrounding blocks.
*
* @param force true to forcefully set the state
* @return true if the update was successful, otherwise false
*/
boolean update(boolean force);
/**
* Attempts to update the block represented by this state, setting it to
* the new values as defined by this state.
* <p>
* If this state is not placed, this will have no effect and return true.
* <p>
* Unless force is true, this will not modify the state of a block if it
* is no longer the same type as it was when this state was taken. It will
* return false in this eventuality.
* <p>
* If force is true, it will set the type of the block to match the new
* state, set the state data and then return true.
* <p>
* If applyPhysics is true, it will trigger a physics update on
* surrounding blocks which could cause them to update or disappear.
*
* @param force true to forcefully set the state
* @param applyPhysics false to cancel updating physics on surrounding
* blocks
* @return true if the update was successful, otherwise false
*/
boolean update(boolean force, boolean applyPhysics);
/**
* @return The data as a raw byte.
* @deprecated Magic value
*/
@Deprecated
public byte getRawData();
/**
* @param data The new data value for the block.
* @deprecated Magic value
*/
@Deprecated
public void setRawData(byte data);
/**
* Returns whether this state is placed in the world.
* <p>
* Some methods will not work if the block state isn't
* placed in the world.
*
* @return whether the state is placed in the world
* or 'virtual' (e.g. on an itemstack)
*/
boolean isPlaced();
}
|
