blob: eb7a5363da8ddd89cb28c3d9bdb986f81e6add02 (
plain)
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
package org.bukkit.block;
import org.bukkit.block.structure.Mirror;
import org.bukkit.block.structure.StructureRotation;
import org.bukkit.block.structure.UsageMode;
import org.bukkit.entity.LivingEntity;
import org.bukkit.util.BlockVector;
/**
* Represents a structure block that can save and load blocks from a file. They
* can only be used by OPs, and are not obtainable in survival.
*/
public interface Structure extends BlockState {
/**
* The name of this structure.
*
* @return structure name
*/
String getStructureName();
/**
* Set the name of this structure. This is case-sensitive. The name of the
* structure in the {@link UsageMode#SAVE} structure block MUST match the
* name within the {@link UsageMode#CORNER} block or the size calculation
* will fail.
*
* @param name the case-sensitive name of this structure
*/
void setStructureName(String name);
/**
* Get the name of who created this structure.
*
* @return the name of whoever created this structure.
*/
String getAuthor();
/**
* Set the name of whoever created this structure.
*
* @param author whoever created this structure
*/
void setAuthor(String author);
/**
* Set the name of whoever created this structure using a
* {@link LivingEntity}.
*
* @param livingEntity the entity who created this structure
*/
void setAuthor(LivingEntity livingEntity);
/**
* The relative position of the structure outline based on the position of
* the structure block. Maximum allowed distance is 32 blocks in any
* direction.
*
* @return a Location which contains the relative distance this structure is
* from the structure block.
*/
BlockVector getRelativePosition();
/**
* Set the relative position from the structure block. Maximum allowed
* distance is 32 blocks in any direction.
*
* @param vector the {@link BlockVector} containing the relative origin
* coordinates of this structure.
*/
void setRelativePosition(BlockVector vector);
/**
* The distance to the opposite corner of this structure. The maximum
* structure size is 32x32x32. When a structure has successfully been
* calculated (i.e. it is within the maximum allowed distance) a white
* border surrounds the structure.
*
* @return a {@link BlockVector} which contains the total size of the
* structure.
*/
BlockVector getStructureSize();
/**
* Set the maximum size of this structure from the origin point. Maximum
* allowed size is 32x32x32.
*
* @param vector the {@link BlockVector} containing the size of this
* structure, based off of the origin coordinates.
*/
void setStructureSize(BlockVector vector);
/**
* Sets the mirroring of the structure.
*
* @param mirror the new mirroring method
*/
void setMirror(Mirror mirror);
/**
* How this structure is mirrored.
*
* @return the current mirroring method
*/
Mirror getMirror();
/**
* Set how this structure is rotated.
*
* @param rotation the new rotation
*/
void setRotation(StructureRotation rotation);
/**
* Get how this structure is rotated.
*
* @return the new rotation
*/
StructureRotation getRotation();
/**
* Set the {@link UsageMode} of this structure block.
*
* @param mode the new mode to set.
*/
void setUsageMode(UsageMode mode);
/**
* Get the {@link UsageMode} of this structure block.
*
* @return the mode this block is currently in.
*/
UsageMode getUsageMode();
/**
* While in {@link UsageMode#SAVE} mode, this will ignore any entities when
* saving the structure.
* <br>
* While in {@link UsageMode#LOAD} mode this will ignore any entities that
* were saved to file.
*
* @param ignoreEntities the flag to set
*/
void setIgnoreEntities(boolean ignoreEntities);
/**
* Get if this structure block should ignore entities.
*
* @return true if the appropriate {@link UsageMode} should ignore entities.
*/
boolean isIgnoreEntities();
/**
* Set if the structure outline should show air blocks.
*
* @param showAir if the structure block should show air blocks
*/
void setShowAir(boolean showAir);
/**
* Check if this structure block is currently showing all air blocks
*
* @return true if the structure block is showing all air blocks
*/
boolean isShowAir();
/**
* Set if this structure box should show the bounding box.
*
* @param showBoundingBox if the structure box should be shown
*/
void setBoundingBoxVisible(boolean showBoundingBox);
/**
* Get if this structure block is currently showing the bounding box.
*
* @return true if the bounding box is shown
*/
boolean isBoundingBoxVisible();
/**
* Set the integrity of the structure. Integrity must be between 0.0 and 1.0
* Lower integrity values will result in more blocks being removed when
* loading a structure. Integrity and {@link #getSeed()} are used together
* to determine which blocks are randomly removed to mimic "decay."
*
* @param integrity the integrity of this structure
*/
void setIntegrity(float integrity);
/**
* Get the integrity of this structure.
*
* @return the integrity of this structure
*/
float getIntegrity();
/**
* The seed used to determine which blocks will be removed upon loading.
* {@link #getIntegrity()} and seed are used together to determine which
* blocks are randomly removed to mimic "decay."
*
* @param seed the seed used to determine how many blocks will be removed
*/
void setSeed(long seed);
/**
* The seed used to determine how many blocks are removed upon loading of
* this structure.
*
* @return the seed used
*/
long getSeed();
/**
* Only applicable while in {@link UsageMode#DATA}. Metadata are specific
* functions that can be applied to the structure location. Consult the
* <a href="https://minecraft.gamepedia.com/Structure_Block#Data">Minecraft
* wiki</a> for more information.
*
* @param metadata the function to perform on the selected location
*/
void setMetadata(String metadata);
/**
* Get the metadata function this structure block will perform when
* activated. Consult the
* <a href="https://minecraft.gamepedia.com/Structure_Block#Data">Minecraft
* Wiki</a> for more information.
*
* @return the function that will be performed when this block is activated
*/
String getMetadata();
}
|
