Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-27 11:27:35 +01:00
Code Issues Projects Releases Wiki Activity

Add view distance API

Browse Source 
Add per player no-tick, tick, and send view distances.

Also add send/no-tick view distance to World.
This commit is contained in:
Byteflux 2016-02-29 18:05:37 -06:00
parent 0cf4a9a62e
commit 5fe2709f4c
2 changed files with 136 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
paper-api/src/main/java/org/bukkit/World.java
View File

@ -2968,6 +2968,66 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient
@NotNull
public Set<FeatureFlag> getFeatureFlags();
// 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.
* <p>
* No-tick view distance is the view distance where chunks will load, however the chunks and their entities will not
* be set to tick.
* </p>
* @return The no-tick view distance for this world.
* @deprecated Use {@link #getViewDistance()}
*/
@Deprecated
default int getNoTickViewDistance() {
return this.getViewDistance();
}
/**
* Sets the no-tick view distance for this world.
* <p>
* No-tick view distance is the view distance where chunks will load, however the chunks and their entities will not
* be set to tick.
* </p>
* @param viewDistance view distance in [2, 32]
* @deprecated Use {@link #setViewDistance(int)}
*/
@Deprecated
default void setNoTickViewDistance(int viewDistance) {
this.setViewDistance(viewDistance);
}
/**
* Gets the sending view distance for this world.
* <p>
* Sending view distance is the view distance where chunks will load in for players in this world.
* </p>
* @return The sending view distance for this world.
*/
int getSendViewDistance();
/**
* Sets the sending view distance for this world.
* <p>
* Sending view distance is the view distance where chunks will load in for players in this world.
* </p>
* @param viewDistance view distance in [2, 32] or -1
*/
void setSendViewDistance(int viewDistance);
// Paper end - view distance api
/**
* Gets all generated structures that intersect the chunk at the given
* coordinates. <br>

76
paper-api/src/main/java/org/bukkit/entity/Player.java
View File

@ -2637,6 +2637,82 @@ 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.
* <p>
* No-tick view distance is the view distance where chunks will load, however the chunks and their entities will not
* be set to tick.
* </p>
* @return The no-tick view distance for this player.
* @deprecated Use {@link #getViewDistance()}
*/
@Deprecated
default int getNoTickViewDistance() {
return this.getViewDistance();
}
/**
* Sets the no-ticking view distance for this player.
* <p>
* No-tick view distance is the view distance where chunks will load, however the chunks and their entities will not
* be set to tick.
* </p>
* @param viewDistance view distance in [2, 32] or -1
* @deprecated Use {@link #setViewDistance(int)}
*/
@Deprecated
default void setNoTickViewDistance(int viewDistance) {
this.setViewDistance(viewDistance);
}
/**
* Gets the sending view distance for this player.
* <p>
* Sending view distance is the view distance where chunks will load in for players.
* </p>
* @return The sending view distance for this player.
*/
public int getSendViewDistance();
/**
* Sets the sending view distance for this player.
* <p>
* Sending view distance is the view distance where chunks will load in for players.
* </p>
* @param viewDistance view distance in [2, 32] or -1
*/
public void setSendViewDistance(int viewDistance);
// Paper end
/**