From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: Byteflux Date: Mon, 29 Feb 2016 18:05:37 -0600 Subject: [PATCH] Add view distance API Add per player no-tick, tick, and send view distances. Also add send/no-tick view distance to World. diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java index ed57cd69d88504b78782271c9a3d423a29471674..8a6a548314eef8d486be908e38e3a4562f26bdb4 100644 --- a/src/main/java/org/bukkit/World.java +++ b/src/main/java/org/bukkit/World.java @@ -2698,6 +2698,62 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient int getSimulationDistance(); // Spigot end + // Paper start - view distance api + /** + * Sets the view distance for this world. + * @param viewDistance view distance in [2, 32] + */ + void setViewDistance(int viewDistance); + + /** + * Sets the simulation distance for this world. + * @param simulationDistance simulation distance in [2, 32] + */ + void setSimulationDistance(int simulationDistance); + + /** + * Returns the no-tick view distance for this world. + *

+ * No-tick view distance is the view distance where chunks will load, however the chunks and their entities will not + * be set to tick. + *

+ * @return The no-tick view distance for this world. + * @deprecated Use {@link #getViewDistance()} + */ + @Deprecated + int getNoTickViewDistance(); + + /** + * Sets the no-tick view distance for this world. + *

+ * No-tick view distance is the view distance where chunks will load, however the chunks and their entities will not + * be set to tick. + *

+ * @param viewDistance view distance in [2, 32] + * @deprecated Use {@link #setViewDistance(int)} + */ + @Deprecated + void setNoTickViewDistance(int viewDistance); + + /** + * Gets the sending view distance for this world. + *

+ * Sending view distance is the view distance where chunks will load in for players in this world. + *

+ * @return The sending view distance for this world. + */ + int getSendViewDistance(); + + /** + * Sets the sending view distance for this world. + *

+ * Sending view distance is the view distance where chunks will load in for players in this world. + *

+ * @param viewDistance view distance in [2, 32] or -1 + */ + void setSendViewDistance(int viewDistance); + // Paper end - view distance api + // Spigot start public class Spigot { diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java index 1c3d9ac922c189adc139c2646b4bdc97dbfadb43..7efbc8540d3a42ae8ec9b4e4343e1352e0cfa993 100644 --- a/src/main/java/org/bukkit/entity/Player.java +++ b/src/main/java/org/bukkit/entity/Player.java @@ -1889,6 +1889,78 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM * @param affects Whether the player can affect mob spawning */ public void setAffectsSpawning(boolean affects); + + /** + * Gets the view distance for this player + * + * @return the player's view distance + * @see org.bukkit.World#getViewDistance() + */ + public int getViewDistance(); + + /** + * Sets the view distance for this player + * + * @param viewDistance the player's view distance + * @see org.bukkit.World#setViewDistance(int) + */ + public void setViewDistance(int viewDistance); + + /** + * Gets the simulation distance for this player + * + * @return the player's simulation distance + */ + public int getSimulationDistance(); + + /** + * Sets the simulation distance for this player + * + * @param simulationDistance the player's new simulation distance + */ + public void setSimulationDistance(int simulationDistance); + + /** + * Gets the no-ticking view distance for this player. + *

+ * No-tick view distance is the view distance where chunks will load, however the chunks and their entities will not + * be set to tick. + *

+ * @return The no-tick view distance for this player. + * @deprecated Use {@link #getViewDistance()} + */ + @Deprecated + public int getNoTickViewDistance(); + + /** + * Sets the no-ticking view distance for this player. + *

+ * No-tick view distance is the view distance where chunks will load, however the chunks and their entities will not + * be set to tick. + *

+ * @param viewDistance view distance in [2, 32] or -1 + * @deprecated Use {@link #setViewDistance(int)} + */ + @Deprecated + public void setNoTickViewDistance(int viewDistance); + + /** + * Gets the sending view distance for this player. + *

+ * Sending view distance is the view distance where chunks will load in for players. + *

+ * @return The sending view distance for this player. + */ + public int getSendViewDistance(); + + /** + * Sets the sending view distance for this player. + *

+ * Sending view distance is the view distance where chunks will load in for players. + *

+ * @param viewDistance view distance in [2, 32] or -1 + */ + public void setSendViewDistance(int viewDistance); // Paper end /**