Upstream/bentobox
1
0
Fork 0
mirror of https://github.com/BentoBoxWorld/BentoBox.git synced 2024-11-17 16:25:12 +01:00
Code Issues Projects Releases Wiki Activity

Documented #getRange() and #setRange(int) in Island

Browse Source
This commit is contained in:
Florian CUNY 2018-07-19 12:23:22 +02:00
parent b37df7ef7c
commit d75cc70083
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/main/java/us/tastybento/bskyblock/database/objects/Island.java
View File

@ -22,6 +22,7 @@ import com.google.common.collect.ImmutableSet.Builder;
import com.google.gson.annotations.Expose;
import us.tastybento.bskyblock.BSkyBlock;
import us.tastybento.bskyblock.Settings;
import us.tastybento.bskyblock.api.flags.Flag;
import us.tastybento.bskyblock.api.user.User;
import us.tastybento.bskyblock.database.objects.adapters.Adapter;
@ -276,7 +277,10 @@ public class Island implements DataObject {
}
/**
* Returns the island range.
* It is a convenience method that returns the exact same value than {@link Settings#getIslandDistance()}, although it has been saved into the Island object for easier access.
* @return the island range
* @see #getProtectionRange()
*/
public int getRange(){
return range;
@ -587,7 +591,12 @@ public class Island implements DataObject {
}
/**
* @param range - the range to set
* Sets the island range.
* This method should <u><strong>NEVER</strong></u> be used except for testing purposes.
* <br>
* The range value is a copy of {@link Settings#getIslandDistance()} made when the Island got created in order to allow easier access to this value and must therefore remain <u><strong>AS IS</strong></u>.
* @param range the range to set
* @see #setProtectionRange(int)
*/
public void setRange(int range){
this.range = range;