spigot-mirror/bukkit
1
0
Fork 0
mirror of https://hub.spigotmc.org/stash/scm/spigot/bukkit.git synced 2025-04-13 09:41:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update spawner/vault documentation to clarify distance value is not squared

Browse source
This commit is contained in:
md_5 2024-12-14 11:39:29 +11:00
parent c0302c1911
commit 8c69edd891
No known key found for this signature in database
GPG key ID: E8E901AC7C617C11
3 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/main/java/org/bukkit/block/TrialSpawner.java
View file

@ -28,7 +28,7 @@ public interface TrialSpawner extends TileState {
public void setCooldownLength(int ticks);
/**
* Get the maximum distance(squared) a player can be in order for this
* Get the maximum distance 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
@ -36,19 +36,19 @@ public interface TrialSpawner extends TileState {
* <br>
* Default value is 16.
*
* @return the maximum distance(squared) a player can be in order for this
* @return the maximum distance 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
* Set the maximum distance 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
* @param requiredPlayerRange the maximum distance a player can be
* in order for this spawner to be active.
*/
public void setRequiredPlayerRange(int requiredPlayerRange);

16
src/main/java/org/bukkit/block/Vault.java
View file

@ -13,37 +13,37 @@ import org.jetbrains.annotations.Nullable;
public interface Vault extends TileState {
/**
* Gets the distance(squared) at which a player must enter for this vault to
* Gets the distance at which a player must enter for this vault to
* activate.
*
* @return the distance(squared) at which a player must enter for this vault
* @return the distance at which a player must enter for this vault
* to activate.
*/
double getActivationRange();
/**
* Sets the distance(squared) at which a player must enter for this vault to
* Sets the distance at which a player must enter for this vault to
* activate.
*
* @param range the distance(squared) at which a player must enter for this
* @param range the distance at which a player must enter for this
* vault to activate.
*/
void setActivationRange(double range);
/**
* Gets the distance(squared) at which a player must exit for the vault to
* Gets the distance at which a player must exit for the vault to
* deactivate.
*
* @return the distance(squared) at which a player must exit for the vault
* @return the distance at which a player must exit for the vault
* to deactivate.
*/
double getDeactivationRange();
/**
* Sets the distance(squared) at which a player must exit for this vault to
* Sets the distance at which a player must exit for this vault to
* deactivate.
*
* @param range the distance(squared) at which a player must exit for this
* @param range the distance at which a player must exit for this
* vault to deactivate.
*/
void setDeactivationRange(double range);

8
src/main/java/org/bukkit/spawner/BaseSpawner.java
View file

@ -50,7 +50,7 @@ public interface BaseSpawner {
public void setDelay(int delay);
/**
* Get the maximum distance(squared) a player can be in order for this
* Get the maximum distance 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
@ -58,19 +58,19 @@ public interface BaseSpawner {
* <br>
* Default value is 16.
*
* @return the maximum distance(squared) a player can be in order for this
* @return the maximum distance 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
* Set the maximum distance 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
* @param requiredPlayerRange the maximum distance a player can be
* in order for this spawner to be active.
*/
public void setRequiredPlayerRange(int requiredPlayerRange);