diff options
| -rw-r--r-- | src/main/java/org/bukkit/block/CreatureSpawner.java | 143 |
1 files changed, 143 insertions, 0 deletions
diff --git a/src/main/java/org/bukkit/block/CreatureSpawner.java b/src/main/java/org/bukkit/block/CreatureSpawner.java index 23a6dd86..0a7d81e8 100644 --- a/src/main/java/org/bukkit/block/CreatureSpawner.java +++ b/src/main/java/org/bukkit/block/CreatureSpawner.java @@ -42,6 +42,8 @@ public interface CreatureSpawner extends BlockState { /** * Get the spawner's delay. + * <br> + * This is the delay, in ticks, until the spawner will spawn its next mob. * * @return The delay. */ @@ -49,8 +51,149 @@ public interface CreatureSpawner extends BlockState { /** * 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); + + /** + * This 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); } |