Commits

md_5 authored 8c69edd891b
Update spawner/vault documentation to clarify distance value is not squared
No tags

src/main/java/org/bukkit/block/TrialSpawner.java

Modified
21 21 public int getCooldownLength();
22 22
23 23 /**
24 24 * Sets the length in ticks the spawner will stay in cooldown for.
25 25 *
26 26 * @param ticks the number of ticks
27 27 */
28 28 public void setCooldownLength(int ticks);
29 29
30 30 /**
31 - * Get the maximum distance(squared) a player can be in order for this
31 + * Get the maximum distance a player can be in order for this
32 32 * spawner to be active.
33 33 * <br>
34 34 * If this value is less than or equal to 0, this spawner is always active
35 35 * (given that there are players online).
36 36 * <br>
37 37 * Default value is 16.
38 38 *
39 - * @return the maximum distance(squared) a player can be in order for this
39 + * @return the maximum distance a player can be in order for this
40 40 * spawner to be active.
41 41 */
42 42 public int getRequiredPlayerRange();
43 43
44 44 /**
45 - * Set the maximum distance (squared) a player can be in order for this
45 + * Set the maximum distance a player can be in order for this
46 46 * spawner to be active.
47 47 * <br>
48 48 * Setting this value to less than or equal to 0 will make this spawner
49 49 * always active (given that there are players online).
50 50 *
51 - * @param requiredPlayerRange the maximum distance (squared) a player can be
51 + * @param requiredPlayerRange the maximum distance a player can be
52 52 * in order for this spawner to be active.
53 53 */
54 54 public void setRequiredPlayerRange(int requiredPlayerRange);
55 55
56 56 /**
57 57 * Gets the players this spawner is currently tracking.
58 58 * <p>
59 59 * <b>Note:</b> the returned collection is immutable, use
60 60 * {@link #startTrackingPlayer(Player)} or {@link #stopTrackingPlayer(Player)}
61 61 * instead.

Everything looks good. We'll let you know here if there's anything you should know about.

Add shortcut