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
|
package org.bukkit;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableMap;
import org.apache.commons.lang.Validate;
import org.bukkit.map.MapCursor;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
/**
* This class handles the creation and storage of all structure types for
* Bukkit. Structure Types are the different kinds of structures that can be
* generated during world/chunk generation. These include Villages, Mineshafts,
* Mansions, etc.
* <br>
* The registration of new {@link StructureType}s is case-sensitive.
*/
// Order is retrieved from WorldGenFactory
public class StructureType {
private static final Map<String, StructureType> structureTypeMap = new HashMap<>();
/**
* Mineshafts are underground structures which consist of branching mining
* tunnels with wooden supports and broken rails.
* <br>
* They are the only place where cave spider spawners and minecarts with
* chests can be found naturally.
*/
public static final StructureType MINESHAFT = register(new StructureType("Mineshaft", MapCursor.Type.RED_X));
/**
* Villages are naturally generating structures that form above ground.
* <br>
* They are usually generated in desert, plains, taiga, and savanna biomes
* and are a site for villager spawns, with whom the player can trade.
*/
public static final StructureType VILLAGE = register(new StructureType("Village", MapCursor.Type.MANSION));
/**
* Nether fortresses are very large complexes that mainly consist of
* netherbricks.
* <br>
* They contain blaze spawners, nether wart farms, and loot chests. They are
* only generated in the nether dimension.
*/
public static final StructureType NETHER_FORTRESS = register(new StructureType("Fortress", MapCursor.Type.RED_X));
/**
* Strongholds are underground structures that consist of many rooms,
* libraries, and an end portal room.
* <br>
* They can be found using an {@link Material#ENDER_EYE}.
*/
public static final StructureType STRONGHOLD = register(new StructureType("Stronghold", MapCursor.Type.MANSION));
/**
* Jungle pyramids (also known as jungle temples) are found in jungles.
* <br>
* They are usually composed of cobblestone and mossy cobblestone. They
* consist of three floors, with the bottom floor containing treasure
* chests.
*/
public static final StructureType JUNGLE_PYRAMID = register(new StructureType("Jungle_Pyramid", MapCursor.Type.RED_X));
/**
* Ocean ruins are clusters of many different blocks that generate
* underwater in ocean biomes (as well as on the surface of beaches).
* <br>
* They come in my different variations. The cold variants consist primarily
* of stone brick, and the warm variants consist of sandstone.
*/
public static final StructureType OCEAN_RUIN = register(new StructureType("Ocean_Ruin", MapCursor.Type.TEMPLE));
/**
* Desert pyramids (also known as desert temples) are found in deserts.
* <br>
* They are usually composed of sandstone and stained terracotta.
*/
public static final StructureType DESERT_PYRAMID = register(new StructureType("Desert_Pyramid", MapCursor.Type.RED_X));
/**
* Igloos are structures that generate in snowy biomes.
* <br>
* They consist of the house, as well as a basement.
*/
public static final StructureType IGLOO = register(new StructureType("Igloo", MapCursor.Type.RED_X));
/**
* Swamp huts (also known as witch huts) generate in swamp biomes and have
* the ability to spawn witches.
*/
public static final StructureType SWAMP_HUT = register(new StructureType("Swamp_Hut", MapCursor.Type.RED_X));
/**
* Ocean monuments are underwater structures.
* <br>
* They are usually composed on all three different prismarine types and sea
* lanterns. They are the only place guardians and elder guardians spawn
* naturally.
*/
public static final StructureType OCEAN_MONUMENT = register(new StructureType("Monument", MapCursor.Type.TEMPLE));
/**
* End Cities are tall castle-like structures that generate in the outer
* island of the End dimension.
* <br>
* They consist primarily of end stone bricks, purpur blocks, and end rods.
* They are the only place where shulkers can be found.
*/
public static final StructureType END_CITY = register(new StructureType("EndCity", MapCursor.Type.RED_X));
/**
* Mansions (also known as woodland mansions) are massive house structures
* that generate in dark forests, containing a wide variety of rooms.
* <br>
* They are the only place where evokers, vindicators, and vexes spawn
* naturally (but only once)
*/
public static final StructureType WOODLAND_MANSION = register(new StructureType("Mansion", MapCursor.Type.MANSION));
/**
* Buried treasure consists of a single chest buried in the beach sand or
* gravel, with random loot in it.
*/
public static final StructureType BURIED_TREASURE = register(new StructureType("Buried_Treasure", MapCursor.Type.RED_X));
/**
* Shipwrecks are structures that generate on the floor of oceans or
* beaches.
* <br>
* They are made up of wood materials, and contain 1-3 loot chests. They can
* generate sideways, upside-down, or upright.
*/
public static final StructureType SHIPWRECK = register(new StructureType("Shipwreck", MapCursor.Type.RED_X));
/* ****************
* STRUCTURE TYPES REGISTERED ABOVE THIS
* ****************
*/
private final String name;
private final MapCursor.Type mapCursor;
/**
* Create a new StructureType with a given name and map cursor. To indicate
* this structure should not be compatible with explorer maps, use null for
* <i>mapIcon</i>.
*
* @param name the name of the structure, case-sensitive
* @param mapIcon the {@link MapCursor.Type} this structure type should use
* when creating explorer maps. Use null to indicate this structure should
* not be compatible with explorer maps.
*/
private StructureType(String name, MapCursor.Type mapIcon) {
Validate.notEmpty(name, "Structure name cannot be empty");
this.name = name;
this.mapCursor = mapIcon;
}
/**
* Get the name of this structure. This is case-sensitive when used in
* commands.
*
* @return the name of this structure
*/
public String getName() {
return name;
}
/**
* Get the {@link MapCursor.Type} that this structure can use on maps. If
* this is null, this structure will not appear on explorer maps.
*
* @return the {@link MapCursor.Type} or null.
*/
public MapCursor.Type getMapIcon() {
return mapCursor;
}
@Override
public boolean equals(Object other) {
if (this == other) {
return true;
}
if (!(other instanceof StructureType)) {
return false;
}
StructureType that = (StructureType) other;
return this.name.equals(that.name) && this.mapCursor == that.mapCursor;
}
@Override
public int hashCode() {
int hash = 7;
hash = 71 * hash + Objects.hashCode(this.name);
hash = 71 * hash + Objects.hashCode(this.mapCursor);
return hash;
}
@Override
public String toString() {
return "StructureType{name=" + this.name + ", cursor=" + this.mapCursor + "}";
}
private static <T extends StructureType> T register(T type) {
Preconditions.checkNotNull(type, "Cannot register null StructureType.");
Preconditions.checkArgument(!structureTypeMap.containsKey(type.getName()), "Cannot register same StructureType twice. %s", type.getName());
StructureType.structureTypeMap.put(type.getName(), type);
return type;
}
/**
* Get all registered {@link StructureType}s.
*
* @return an immutable copy of registered structure types.
*/
public static Map<String, StructureType> getStructureTypes() {
return ImmutableMap.copyOf(structureTypeMap);
}
}
|
