twin/paper-mc
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-08-04 14:12:20 -07:00
Code Issues Packages Projects Releases Wiki Activity

Interface for changing the view distance.

Browse Source 
Can be changed server wide, per world and per player.
Only server wide changes are kept between server restarts.

Setting the server or world view distance should fail if the
view distance is not between 3 and 15

By: Andrew Ardill <andrew.ardill@gmail.com>
This commit is contained in:
Bukkit/Spigot
2011-08-12 00:19:52 +10:00
parent cd7da9630a
commit 741f5e69ae
3 changed files with 83 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
paper-api/src/main/java/org/bukkit/Server.java
View File

@@ -57,13 +57,6 @@ public interface Server {
*/
public int getPort();
/**
* Get the view distance from this server.
*
* @return The view distance from this server.
*/
public int getViewDistance();
/**
* Get the IP that this server is bound to or empty string if not specified
*
@@ -247,18 +240,18 @@ public interface Server {
* @return World with the given Unique ID, or null if none exists.
*/
public World getWorld(UUID uid);
/**
* Gets the map from the given item ID.
*
*
* @param id ID of the map to get.
* @return The MapView if it exists, or null otherwise.
*/
public MapView getMap(short id);
/**
* Create a new map with an automatically assigned ID.
*
*
* @param world The world the map will belong to.
* @return The MapView just created.
*/
@@ -346,4 +339,26 @@ public interface Server {
* @return Whether this server allows flying or not.
*/
public boolean getAllowFlight();
/**
* Get the default view distance of this server.
*
* The view distance is a measure of how far a player can see.
* It affects the number of chunks loaded and updated around every player.
*
* @return The default view distance of the server.
*/
public int getViewDistance();
/**
* Set the default view distance for this server.
*
* The view distance is a measure of how far a player can see.
* It affects the number of chunks loaded and updated around every player.
* The view distance must be in the range [3,15].
*
* @param viewDistance an integer between 3 and 15 inclusive
* @throws IllegalArgumentException If view distance is less than 3 or greater than 15
*/
public void setViewDistance(int viewDistance) throws IllegalArgumentException;
}