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
|
package org.bukkit.block;
import org.bukkit.entity.EntityType;
/**
* Represents a captured state of a creature spawner.
*/
public interface CreatureSpawner extends BlockState {
/**
* Get the spawner's creature type.
*
* @return The creature type.
*/
public EntityType getSpawnedType();
/**
* Set the spawner's creature type.
*
* @param creatureType The creature type.
*/
public void setSpawnedType(EntityType creatureType);
/**
* Set the spawner mob type.
*
* @param creatureType The creature type's name.
* @deprecated magic value, use
* {@link #setSpawnedType(org.bukkit.entity.EntityType)}.
*/
@Deprecated
public void setCreatureTypeByName(String creatureType);
/**
* Get the spawner's creature type.
*
* @return The creature type's name.
* @deprecated magic value, use {@link #getSpawnedType()}.
*/
@Deprecated
public String getCreatureTypeName();
/**
* Get the spawner's delay.
* <br>
* This is the delay, in ticks, until the spawner will spawn its next mob.
*
* @return The delay.
*/
public int getDelay();
/**
* Set the spawner's delay.
* <br>
* If set to -1, the spawn delay will be reset to a random value between
* {@link #getMinSpawnDelay} and {@link #getMaxSpawnDelay()}.
*
* @param delay The delay.
*/
public void setDelay(int delay);
/**
* The minimum spawn delay amount (in ticks).
* <br>
* This value is used when the spawner resets its delay (for any reason).
* It will choose a random number between {@link #getMinSpawnDelay()}
* and {@link #getMaxSpawnDelay()} for its next {@link #getDelay()}.
*
* Default value is 200 ticks.
*
* @return the minimum spawn delay amount
*/
public int getMinSpawnDelay();
/**
* Set the minimum spawn delay amount (in ticks).
*
* @see #getMinSpawnDelay()
* @param delay the minimum spawn delay amount
*/
public void setMinSpawnDelay(int delay);
/**
* The maximum spawn delay amount (in ticks).
* <br>
* This value is used when the spawner resets its delay (for any reason).
* It will choose a random number between {@link #getMinSpawnDelay()}
* and {@link #getMaxSpawnDelay()} for its next {@link #getDelay()}.
* <br>
* This value <b>must</b> be greater than 0 and less than or equal to
* {@link #getMaxSpawnDelay()}.
*
* Default value is 800 ticks.
*
* @return the maximum spawn delay amount
*/
public int getMaxSpawnDelay();
/**
* Set the maximum spawn delay amount (in ticks).
* <br>
* This value <b>must</b> be greater than 0, as well as greater than or
* equal to {@link #getMinSpawnDelay()}
*
* @see #getMaxSpawnDelay()
* @param delay the new maximum spawn delay amount
*/
public void setMaxSpawnDelay(int delay);
/**
* Get how many mobs attempt to spawn.
* <br>
* Default value is 4.
*
* @return the current spawn count
*/
public int getSpawnCount();
/**
* Set how many mobs attempt to spawn.
*
* @param spawnCount the new spawn count
*/
public void setSpawnCount(int spawnCount);
/**
* Set the new maximum amount of similar entities that are allowed to be
* within spawning range of this spawner.
* <br>
* If more than the maximum number of entities are within range, the spawner
* will not spawn and try again with a new {@link #getDelay()}.
* <br>
* Default value is 16.
*
* @return the maximum number of nearby, similar, entities
*/
public int getMaxNearbyEntities();
/**
* Set the maximum number of similar entities that are allowed to be within
* spawning range of this spawner.
* <br>
* Similar entities are entities that are of the same {@link EntityType}
*
* @param maxNearbyEntities the maximum number of nearby, similar, entities
*/
public void setMaxNearbyEntities(int maxNearbyEntities);
/**
* Get the maximum distance(squared) a player can be in order for this
* spawner to be active.
* <br>
* If this value is less than or equal to 0, this spawner is always active
* (given that there are players online).
* <br>
* Default value is 16.
*
* @return the maximum distance(squared) a player can be in order for this
* spawner to be active.
*/
public int getRequiredPlayerRange();
/**
* Set the maximum distance (squared) a player can be in order for this
* spawner to be active.
* <br>
* Setting this value to less than or equal to 0 will make this spawner
* always active (given that there are players online).
*
* @param requiredPlayerRange the maximum distance (squared) a player can be
* in order for this spawner to be active.
*/
public void setRequiredPlayerRange(int requiredPlayerRange);
/**
* Get the radius around which the spawner will attempt to spawn mobs in.
* <br>
* This area is square, includes the block the spawner is in, and is
* centered on the spawner's x,z coordinates - not the spawner itself.
* <br>
* It is 2 blocks high, centered on the spawner's y-coordinate (its bottom);
* thus allowing mobs to spawn as high as its top surface and as low
* as 1 block below its bottom surface.
* <br>
* Default value is 4.
*
* @return the spawn range
*/
public int getSpawnRange();
/**
* Set the new spawn range.
* <br>
*
* @see #getSpawnRange()
* @param spawnRange the new spawn range
*/
public void setSpawnRange(int spawnRange);
}
|
