Improvements to Random Teleport#4271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JRoy merged 20 commits into from
Nov 24, 2024
Merged

Improvements to Random Teleport #4271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
be8bb92
Random teleport improvements
pop4959 Jun 25, 2021
7991c13
Merge
pop4959 Jul 5, 2021
6d3340e
Merge branch '2.x' into randomteleport-improvements
pop4959 Dec 11, 2021
e4e1bbb
Merge branch '2.x' of https://github.com/EssentialsX/Essentials into …
pop4959 Dec 28, 2021
26ff6ec
Merge branch '2.x' into randomteleport-improvements
pop4959 Feb 13, 2022
55fb0b2
Merge branch '2.x' into randomteleport-improvements
pop4959 May 17, 2022
36d1cf7
Merge branch '2.x' into randomteleport-improvements
pop4959 May 28, 2022
29597f2
Merge branch '2.x' into randomteleport-improvements
pop4959 Jun 4, 2022
51ab2af
Merge branch '2.x' into randomteleport-improvements
triagonal Jun 12, 2022
571fb8d
random spawn option
pop4959 Jul 2, 2022
f8f4002
avoid teleporting onto bedrock
pop4959 Jul 2, 2022
fbc5bc5
Merge branch '2.x' into randomteleport-improvements
pop4959 Jul 2, 2022
7e2b877
Merge branch '2.x' into randomteleport-improvements
JRoy Jul 5, 2022
eca91b2
Merge remote-tracking branch 'upstream/2.x' into fork/pop4959/randomt…
JRoy Nov 24, 2024
04defb1
fix compile issues
JRoy Nov 24, 2024
e9445c7
Move upgrades to EssentialsUpgrade
JRoy Nov 24, 2024
168ce3b
get rid of InvalidWorldException
JRoy Nov 24, 2024
20f66a8
Don't Reload RTP Config in /settpr
JRoy Nov 24, 2024
b9d9a24
Remove unused UserRandomTeleportEvent constructor
JRoy Nov 24, 2024
f8a659a
Merge branch '2.x' into randomteleport-improvements
JRoy Nov 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions Essentials/src/main/java/com/earth2me/essentials/AsyncTeleport.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@
import io.papermc.lib.PaperLib;
import net.ess3.api.IEssentials;
import net.ess3.api.IUser;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import net.ess3.api.events.UserWarpEvent;
import net.ess3.api.events.teleport.PreTeleportEvent;
Expand DownExpand Up@@ -424,7 +423,7 @@ public void warp(final IUser otherUser, String warp, final Trade chargeFor, fina
final Location loc;
try {
loc = ess.getWarps().getWarp(warp);
} catch (final WarpNotFoundException | InvalidWorldException e) {
} catch (final WarpNotFoundException e) {
future.completeExceptionally(e);
return;
}
Expand Down
11 changes: 4 additions & 7 deletions Essentials/src/main/java/com/earth2me/essentials/Essentials.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -358,6 +358,10 @@ public void onEnable() {
upgrade.convertKits();
execTimer.mark("Kits");

randomTeleport = new RandomTeleport(this);
confList.add(randomTeleport);
execTimer.mark("Init(RandomTeleport)");

upgrade.afterSettings();
execTimer.mark("Upgrade3");

Expand All@@ -373,13 +377,6 @@ public void onEnable() {
confList.add(itemDb);
execTimer.mark("Init(ItemDB)");

randomTeleport = new RandomTeleport(this);
if (randomTeleport.getPreCache()) {
randomTeleport.cacheRandomLocations(randomTeleport.getCenter(), randomTeleport.getMinRange(), randomTeleport.getMaxRange());
}
confList.add(randomTeleport);
execTimer.mark("Init(RandomTeleport)");

customItemResolver = new CustomItemResolver(this);
try {
itemDb.registerResolver(this, "custom_items", customItemResolver);
Expand Down
35 changes: 35 additions & 0 deletions Essentials/src/main/java/com/earth2me/essentials/EssentialsUpgrade.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.EssentialsUserConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.craftbukkit.BanLookup;
import com.earth2me.essentials.userstorage.ModernUUIDCache;
import com.earth2me.essentials.utils.AdventureUtil;
Expand DownExpand Up@@ -156,6 +157,39 @@ public static void uuidFileConvert(final IEssentials ess, final Boolean ignoreUF
ess.getLogger().info("To rerun the conversion type /essentials uuidconvert");
}

public void updateRandomTeleport() {
if (doneFile.getBoolean("updateRandomTeleport", false)) {
return;
}

final EssentialsConfiguration config = ess.getRandomTeleport().getConfig();

final LazyLocation center = config.getLocation("center");
final Location centerLoc = center != null ? center.location() : null;
if (center != null && centerLoc != null) {
final double minRange = config.getDouble("min-range", Double.MIN_VALUE);
final double maxRange = config.getDouble("max-range", Double.MIN_VALUE);
for (final World world : ess.getServer().getWorlds()) {
final String propPrefix = "locations." + world.getName() + ".";
config.setProperty(propPrefix + "center", centerLoc);

if (minRange != Double.MIN_VALUE) {
config.setProperty(propPrefix + "min-range", minRange);
}
if (maxRange != Double.MIN_VALUE) {
config.setProperty(propPrefix + "max-range", maxRange);
}
}
}
config.removeProperty("center");

config.blockingSave();

doneFile.setProperty("updateRandomTeleport", true);
doneFile.save();
ess.getLogger().info("Done converting random teleport config.");
}

public void convertMailList() {
if (doneFile.getBoolean("updateUsersMailList", false)) {
return;
Expand DownExpand Up@@ -1068,5 +1102,6 @@ public void afterSettings() {
convertStupidCamelCaseUserdataKeys();
convertMailList();
purgeBrokenNpcAccounts();
updateRandomTeleport();
}
}
4 changes: 4 additions & 0 deletions Essentials/src/main/java/com/earth2me/essentials/ISettings.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,10 @@ public interface ISettings extends IConf {

boolean getRespawnAtHome();

String getRandomSpawnLocation();

String getRandomRespawnLocation();

boolean isRespawnAtAnchor();

Set getMultipleHomes();
Expand Down
124 changes: 80 additions & 44 deletions Essentials/src/main/java/com/earth2me/essentials/RandomTeleport.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
package com.earth2me.essentials;

import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.utils.LocationUtil;
import com.earth2me.essentials.utils.VersionUtil;
import io.papermc.lib.PaperLib;
import net.ess3.api.InvalidWorldException;
import net.ess3.provider.BiomeKeyProvider;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.World;

import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import java.util.Random;
import java.util.Set;
Expand All@@ -23,58 +28,72 @@ public class RandomTeleport implements IConf {
private static final int HIGHEST_BLOCK_Y_OFFSET = VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_15_R01) ? 1 : 0;
private final IEssentials ess;
private final EssentialsConfiguration config;
private final ConcurrentLinkedQueue<Location> cachedLocations = new ConcurrentLinkedQueue<>();
private final Map<String, ConcurrentLinkedQueue<Location>> cachedLocations = new HashMap<>();

public RandomTeleport(final IEssentials essentials) {
this.ess = essentials;
config = new EssentialsConfiguration(new File(essentials.getDataFolder(), "tpr.yml"), "/tpr.yml",
"Configuration for the random teleport command.\nSome settings may be defaulted, and can be changed via the /settpr command in-game.");
"Configuration for the random teleport command.\nUse the /settpr command in-game to set random teleport locations.");
reloadConfig();
}

public EssentialsConfiguration getConfig() {
return config;
}

@Override
public void reloadConfig() {
config.load();
cachedLocations.clear();
}

public Location getCenter() {
try {
final LazyLocation center = config.getLocation("center");
if (center != null && center.location() != null) {
return center.location();
}
} catch (final InvalidWorldException ignored) {
public boolean hasLocation(final String name) {
return config.hasProperty("locations." + name);
}

public Location getCenter(final String name) {
final LazyLocation center = config.getLocation(locationKey(name, "center"));
if (center != null && center.location() != null) {
return center.location();
}
final Location center = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
center.setY(center.getWorld().getHighestBlockYAt(center) + HIGHEST_BLOCK_Y_OFFSET);
setCenter(center);
return center;

final Location worldCenter = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
worldCenter.setY(worldCenter.getWorld().getHighestBlockYAt(worldCenter) + HIGHEST_BLOCK_Y_OFFSET);
setCenter(name, worldCenter);
return worldCenter;
}

public void setCenter(final Location center) {
config.setProperty("center", center);
public void setCenter(final String name, final Location center) {
config.setProperty(locationKey(name, "center"), center);
config.save();
}

public double getMinRange() {
return config.getDouble("min-range", 0d);
public double getMinRange(final String name) {
return config.getDouble(locationKey(name, "min-range"), 0d);
}

public void setMinRange(final double minRange) {
config.setProperty("min-range", minRange);
public void setMinRange(final String name, final double minRange) {
config.setProperty(locationKey(name, "min-range"), minRange);
config.save();
}

public double getMaxRange() {
return config.getDouble("max-range", getCenter().getWorld().getWorldBorder().getSize() / 2);
public double getMaxRange(final String name) {
return config.getDouble(locationKey(name, "max-range"), getCenter(name).getWorld().getWorldBorder().getSize() / 2);
}

public void setMaxRange(final double maxRange) {
config.setProperty("max-range", maxRange);
public void setMaxRange(final String name, final double maxRange) {
config.setProperty(locationKey(name, "max-range"), maxRange);
config.save();
}

public String getDefaultLocation() {
return config.getString("default-location", "{world}");
}

public boolean isPerLocationPermission() {
return config.getBoolean("per-location-permission", false);
}

public Set<String> getExcludedBiomes() {
final Set<String> excludedBiomes = new HashSet<>();
for (final String key : config.getList("excluded-biomes", String.class)) {
Expand All@@ -91,39 +110,48 @@ public int getCacheThreshold() {
return config.getInt("cache-threshold", 10);
}

public boolean getPreCache() {
return config.getBoolean("pre-cache", false);
public List<String> listLocations() {
return new ArrayList<>(ConfigurateUtil.getKeys(config.getRootNode().node("locations")));
}

public Queue<Location> getCachedLocations() {
return cachedLocations;
public Queue<Location> getCachedLocations(final String name) {
this.cachedLocations.computeIfAbsent(name, x -> new ConcurrentLinkedQueue<>());
return cachedLocations.get(name);
}

// Get a random location; cached if possible. Otherwise on demand.
public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
final int findAttempts = this.getFindAttempts();
final Queue<Location> cachedLocations = this.getCachedLocations();
// Get a named random teleport location; cached if possible, otherwise on demand.
public CompletableFuture<Location> getRandomLocation(final String name) {
final Queue<Location> cached = this.getCachedLocations(name);
// Try to build up the cache if it is below the threshold
if (cachedLocations.size() < this.getCacheThreshold()) {
cacheRandomLocations(center, minRange, maxRange);
if (cached.size() < this.getCacheThreshold()) {
cacheRandomLocations(name);
}
final CompletableFuture<Location> future = new CompletableFuture<>();
// Return a random location immediately if one is available, otherwise try to find one now
if (cachedLocations.isEmpty()) {
if (cached.isEmpty()) {
final int findAttempts = this.getFindAttempts();
final Location center = this.getCenter(name);
final double minRange = this.getMinRange(name);
final double maxRange = this.getMaxRange(name);
attemptRandomLocation(findAttempts, center, minRange, maxRange).thenAccept(future::complete);
} else {
future.complete(cachedLocations.poll());
future.complete(cached.poll());
}
return future;
}

// Prompts caching random valid locations, up to a maximum number of attempts
public void cacheRandomLocations(final Location center, final double minRange, final double maxRange) {
// Get a random location with specific parameters (note: not cached).
public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
return attemptRandomLocation(this.getFindAttempts(), center, minRange, maxRange);
}

// Prompts caching random valid locations, up to a maximum number of attempts.
public void cacheRandomLocations(final String name) {
ess.getServer().getScheduler().scheduleSyncDelayedTask(ess, () -> {
for (int i = 0; i < this.getFindAttempts(); ++i) {
calculateRandomLocation(center, minRange, maxRange).thenAccept(location -> {
calculateRandomLocation(getCenter(name), getMinRange(name), getMaxRange(name)).thenAccept(location -> {
if (isValidRandomLocation(location)) {
this.getCachedLocations().add(location);
this.getCachedLocations(name).add(location);
}
});
}
Expand DownExpand Up@@ -188,14 +216,18 @@ private CompletableFuture<Location> calculateRandomLocation(final Location cente
return future;
}

// Returns an appropriate elevation for a given location in the nether, or -1 if none is found
// Returns an appropriate elevation for a given location in the nether, or MIN_VALUE if none is found
private double getNetherYAt(final Location location) {
for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(location.getWorld()); ++y) {
if (!LocationUtil.isBlockUnsafe(ess, location.getWorld(), location.getBlockX(), y, location.getBlockZ())) {
final World world = location.getWorld();
for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(world); ++y) {
if (Material.BEDROCK.equals(world.getBlockAt(location.getBlockX(), y, location.getBlockZ()).getType())) {
break;
}
if (!LocationUtil.isBlockUnsafe(ess, world, location.getBlockX(), y, location.getBlockZ())) {
return y;
}
}
return -1;
return Double.MIN_VALUE;
}

private boolean isValidRandomLocation(final Location location) {
Expand DownExpand Up@@ -226,6 +258,10 @@ private boolean isExcludedBiome(final Location location) {
return excluded.contains(biomeKey);
}

private String locationKey(final String name, final String key) {
return "locations." + name + "." + key;
}

public File getFile() {
return config.getFile();
}
Expand Down
10 changes: 10 additions & 0 deletions Essentials/src/main/java/com/earth2me/essentials/Settings.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ public boolean getRespawnAtHome() {
return config.getBoolean("respawn-at-home", false);
}

@Override
public String getRandomSpawnLocation() {
return config.getString("random-spawn-location", "none");
}

@Override
public String getRandomRespawnLocation() {
return config.getString("random-respawn-location", "none");
}

@Override
public boolean isRespawnAtAnchor() {
return config.getBoolean("respawn-at-anchor", false);
Expand Down
3 changes: 1 addition & 2 deletions Essentials/src/main/java/com/earth2me/essentials/Warps.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,6 @@
import com.earth2me.essentials.utils.AdventureUtil;
import com.earth2me.essentials.utils.StringUtil;
import net.ess3.api.InvalidNameException;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import org.bukkit.Location;

Expand DownExpand Up@@ -54,7 +53,7 @@ public Collection<String> getList() {
}

@Override
public Location getWarp(final String warp) throws WarpNotFoundException, InvalidWorldException {
public Location getWarp(final String warp) throws WarpNotFoundException {
final EssentialsConfiguration conf = warpPoints.get(new StringIgnoreCase(warp));
if (conf == null) {
throw new WarpNotFoundException();
Expand Down
3 changes: 1 addition & 2 deletions Essentials/src/main/java/com/earth2me/essentials/api/IWarps.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,8 @@ public interface IWarps extends IConf {
* @param warp - Warp name
* @return - Location the warp is set to
* @throws WarpNotFoundException When the warp is not found
* @throws net.ess3.api.InvalidWorldException When the world the warp is in is not found
*/
Location getWarp(String warp) throws WarpNotFoundException, net.ess3.api.InvalidWorldException;
Location getWarp(String warp) throws WarpNotFoundException;

/**
* Checks if the provided name is a warp.
Expand Down
20 changes: 0 additions & 20 deletions Essentials/src/main/java/com/earth2me/essentials/api/InvalidWorldException.java
View file
Open in desktop

This file was deleted.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Improvements to Random Teleport#4271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

JRoy
merged 20 commits into

from

Nov 24, 2024
 Merged


Improvements to Random Teleport
#4271
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


20 commits


Select commit
Hold shift + click to select a range
be8bb92

Random teleport improvements


pop4959 Jun 25, 2021
7991c13

Merge


pop4959 Jul 5, 2021
6d3340e

Merge branch '2.x' into randomteleport-improvements


pop4959 Dec 11, 2021
e4e1bbb

Merge branch '2.x' of https://github.com/EssentialsX/Essentials into …


pop4959 Dec 28, 2021
26ff6ec

Merge branch '2.x' into randomteleport-improvements


pop4959 Feb 13, 2022
55fb0b2

Merge branch '2.x' into randomteleport-improvements


pop4959 May 17, 2022
36d1cf7

Merge branch '2.x' into randomteleport-improvements


pop4959 May 28, 2022
29597f2

Merge branch '2.x' into randomteleport-improvements


pop4959 Jun 4, 2022
51ab2af

Merge branch '2.x' into randomteleport-improvements


triagonal Jun 12, 2022
571fb8d

random spawn option


pop4959 Jul 2, 2022
f8f4002

avoid teleporting onto bedrock


pop4959 Jul 2, 2022
fbc5bc5

Merge branch '2.x' into randomteleport-improvements


pop4959 Jul 2, 2022
7e2b877

Merge branch '2.x' into randomteleport-improvements


JRoy Jul 5, 2022
eca91b2

Merge remote-tracking branch 'upstream/2.x' into fork/pop4959/randomt…


JRoy Nov 24, 2024
04defb1

fix compile issues


JRoy Nov 24, 2024
e9445c7

Move upgrades to EssentialsUpgrade


JRoy Nov 24, 2024
168ce3b

get rid of InvalidWorldException


JRoy Nov 24, 2024
20f66a8

Don't Reload RTP Config in /settpr


JRoy Nov 24, 2024
b9d9a24

Remove unused UserRandomTeleportEvent constructor


JRoy Nov 24, 2024
f8a659a

Merge branch '2.x' into randomteleport-improvements


JRoy Nov 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/AsyncTeleport.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@
import io.papermc.lib.PaperLib;
import net.ess3.api.IEssentials;
import net.ess3.api.IUser;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import net.ess3.api.events.UserWarpEvent;
import net.ess3.api.events.teleport.PreTeleportEvent;
Expand DownExpand Up@@ -424,7 +423,7 @@ public void warp(final IUser otherUser, String warp, final Trade chargeFor, fina
 final Location loc;
 try {
 loc = ess.getWarps().getWarp(warp);
 } catch (final WarpNotFoundException | InvalidWorldException e) {
 } catch (final WarpNotFoundException e) {
 future.completeExceptionally(e);
 return;
 }
Expand Down

11 changes: 4 additions & 7 deletions
Essentials/src/main/java/com/earth2me/essentials/Essentials.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -358,6 +358,10 @@ public void onEnable() {
 upgrade.convertKits();
 execTimer.mark("Kits");

 randomTeleport = new RandomTeleport(this);
 confList.add(randomTeleport);
 execTimer.mark("Init(RandomTeleport)");

 upgrade.afterSettings();
 execTimer.mark("Upgrade3");

Expand All@@ -373,13 +377,6 @@ public void onEnable() {
 confList.add(itemDb);
 execTimer.mark("Init(ItemDB)");

 randomTeleport = new RandomTeleport(this);
 if (randomTeleport.getPreCache()) {
 randomTeleport.cacheRandomLocations(randomTeleport.getCenter(), randomTeleport.getMinRange(), randomTeleport.getMaxRange());
 }
 confList.add(randomTeleport);
 execTimer.mark("Init(RandomTeleport)");

 customItemResolver = new CustomItemResolver(this);
 try {
 itemDb.registerResolver(this, "custom_items", customItemResolver);
Expand Down

35 changes: 35 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/EssentialsUpgrade.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.EssentialsUserConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.craftbukkit.BanLookup;
import com.earth2me.essentials.userstorage.ModernUUIDCache;
import com.earth2me.essentials.utils.AdventureUtil;
Expand DownExpand Up@@ -156,6 +157,39 @@ public static void uuidFileConvert(final IEssentials ess, final Boolean ignoreUF
 ess.getLogger().info("To rerun the conversion type /essentials uuidconvert");
 }

 public void updateRandomTeleport() {
 if (doneFile.getBoolean("updateRandomTeleport", false)) {
 return;
 }

 final EssentialsConfiguration config = ess.getRandomTeleport().getConfig();

 final LazyLocation center = config.getLocation("center");
 final Location centerLoc = center != null ? center.location() : null;
 if (center != null && centerLoc != null) {
 final double minRange = config.getDouble("min-range", Double.MIN_VALUE);
 final double maxRange = config.getDouble("max-range", Double.MIN_VALUE);
 for (final World world : ess.getServer().getWorlds()) {
 final String propPrefix = "locations." + world.getName() + ".";
 config.setProperty(propPrefix + "center", centerLoc);

 if (minRange != Double.MIN_VALUE) {
 config.setProperty(propPrefix + "min-range", minRange);
 }
 if (maxRange != Double.MIN_VALUE) {
 config.setProperty(propPrefix + "max-range", maxRange);
 }
 }
 }
 config.removeProperty("center");

 config.blockingSave();

 doneFile.setProperty("updateRandomTeleport", true);
 doneFile.save();
 ess.getLogger().info("Done converting random teleport config.");
 }

 public void convertMailList() {
 if (doneFile.getBoolean("updateUsersMailList", false)) {
 return;
Expand DownExpand Up@@ -1068,5 +1102,6 @@ public void afterSettings() {
 convertStupidCamelCaseUserdataKeys();
 convertMailList();
 purgeBrokenNpcAccounts();
 updateRandomTeleport();
 }
}

4 changes: 4 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/ISettings.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,10 @@ public interface ISettings extends IConf {

 boolean getRespawnAtHome();

 String getRandomSpawnLocation();

 String getRandomRespawnLocation();

 boolean isRespawnAtAnchor();

 Set getMultipleHomes();
Expand Down

124 changes: 80 additions & 44 deletions
Essentials/src/main/java/com/earth2me/essentials/RandomTeleport.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
package com.earth2me.essentials;

import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.utils.LocationUtil;
import com.earth2me.essentials.utils.VersionUtil;
import io.papermc.lib.PaperLib;
import net.ess3.api.InvalidWorldException;
import net.ess3.provider.BiomeKeyProvider;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.World;

import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import java.util.Random;
import java.util.Set;
Expand All@@ -23,58 +28,72 @@ public class RandomTeleport implements IConf {
 private static final int HIGHEST_BLOCK_Y_OFFSET = VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_15_R01) ? 1 : 0;
 private final IEssentials ess;
 private final EssentialsConfiguration config;
 private final ConcurrentLinkedQueue<Location> cachedLocations = new ConcurrentLinkedQueue<>();
 private final Map<String, ConcurrentLinkedQueue<Location>> cachedLocations = new HashMap<>();

 public RandomTeleport(final IEssentials essentials) {
 this.ess = essentials;
 config = new EssentialsConfiguration(new File(essentials.getDataFolder(), "tpr.yml"), "/tpr.yml",
 "Configuration for the random teleport command.\nSome settings may be defaulted, and can be changed via the /settpr command in-game.");
 "Configuration for the random teleport command.\nUse the /settpr command in-game to set random teleport locations.");
 reloadConfig();
 }

 public EssentialsConfiguration getConfig() {
 return config;
 }

 @Override
 public void reloadConfig() {
 config.load();
 cachedLocations.clear();
 }

 public Location getCenter() {
 try {
 final LazyLocation center = config.getLocation("center");
 if (center != null && center.location() != null) {
 return center.location();
 }
 } catch (final InvalidWorldException ignored) {
 public boolean hasLocation(final String name) {
 return config.hasProperty("locations." + name);
 }

 public Location getCenter(final String name) {
 final LazyLocation center = config.getLocation(locationKey(name, "center"));
 if (center != null && center.location() != null) {
 return center.location();
 }
 final Location center = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
 center.setY(center.getWorld().getHighestBlockYAt(center) + HIGHEST_BLOCK_Y_OFFSET);
 setCenter(center);
 return center;

 final Location worldCenter = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
 worldCenter.setY(worldCenter.getWorld().getHighestBlockYAt(worldCenter) + HIGHEST_BLOCK_Y_OFFSET);
 setCenter(name, worldCenter);
 return worldCenter;
 }

 public void setCenter(final Location center) {
 config.setProperty("center", center);
 public void setCenter(final String name, final Location center) {
 config.setProperty(locationKey(name, "center"), center);
 config.save();
 }

 public double getMinRange() {
 return config.getDouble("min-range", 0d);
 public double getMinRange(final String name) {
 return config.getDouble(locationKey(name, "min-range"), 0d);
 }

 public void setMinRange(final double minRange) {
 config.setProperty("min-range", minRange);
 public void setMinRange(final String name, final double minRange) {
 config.setProperty(locationKey(name, "min-range"), minRange);
 config.save();
 }

 public double getMaxRange() {
 return config.getDouble("max-range", getCenter().getWorld().getWorldBorder().getSize() / 2);
 public double getMaxRange(final String name) {
 return config.getDouble(locationKey(name, "max-range"), getCenter(name).getWorld().getWorldBorder().getSize() / 2);
 }

 public void setMaxRange(final double maxRange) {
 config.setProperty("max-range", maxRange);
 public void setMaxRange(final String name, final double maxRange) {
 config.setProperty(locationKey(name, "max-range"), maxRange);
 config.save();
 }

 public String getDefaultLocation() {
 return config.getString("default-location", "{world}");
 }

 public boolean isPerLocationPermission() {
 return config.getBoolean("per-location-permission", false);
 }

 public Set<String> getExcludedBiomes() {
 final Set<String> excludedBiomes = new HashSet<>();
 for (final String key : config.getList("excluded-biomes", String.class)) {
Expand All@@ -91,39 +110,48 @@ public int getCacheThreshold() {
 return config.getInt("cache-threshold", 10);
 }

 public boolean getPreCache() {
 return config.getBoolean("pre-cache", false);
 public List<String> listLocations() {
 return new ArrayList<>(ConfigurateUtil.getKeys(config.getRootNode().node("locations")));
 }

 public Queue<Location> getCachedLocations() {
 return cachedLocations;
 public Queue<Location> getCachedLocations(final String name) {
 this.cachedLocations.computeIfAbsent(name, x -> new ConcurrentLinkedQueue<>());
 return cachedLocations.get(name);
 }

 // Get a random location; cached if possible. Otherwise on demand.
 public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
 final int findAttempts = this.getFindAttempts();
 final Queue<Location> cachedLocations = this.getCachedLocations();
 // Get a named random teleport location; cached if possible, otherwise on demand.
 public CompletableFuture<Location> getRandomLocation(final String name) {
 final Queue<Location> cached = this.getCachedLocations(name);
 // Try to build up the cache if it is below the threshold
 if (cachedLocations.size() < this.getCacheThreshold()) {
 cacheRandomLocations(center, minRange, maxRange);
 if (cached.size() < this.getCacheThreshold()) {
 cacheRandomLocations(name);
 }
 final CompletableFuture<Location> future = new CompletableFuture<>();
 // Return a random location immediately if one is available, otherwise try to find one now
 if (cachedLocations.isEmpty()) {
 if (cached.isEmpty()) {
 final int findAttempts = this.getFindAttempts();
 final Location center = this.getCenter(name);
 final double minRange = this.getMinRange(name);
 final double maxRange = this.getMaxRange(name);
 attemptRandomLocation(findAttempts, center, minRange, maxRange).thenAccept(future::complete);
 } else {
 future.complete(cachedLocations.poll());
 future.complete(cached.poll());
 }
 return future;
 }

 // Prompts caching random valid locations, up to a maximum number of attempts
 public void cacheRandomLocations(final Location center, final double minRange, final double maxRange) {
 // Get a random location with specific parameters (note: not cached).
 public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
 return attemptRandomLocation(this.getFindAttempts(), center, minRange, maxRange);
 }

 // Prompts caching random valid locations, up to a maximum number of attempts.
 public void cacheRandomLocations(final String name) {
 ess.getServer().getScheduler().scheduleSyncDelayedTask(ess, () -> {
 for (int i = 0; i < this.getFindAttempts(); ++i) {
 calculateRandomLocation(center, minRange, maxRange).thenAccept(location -> {
 calculateRandomLocation(getCenter(name), getMinRange(name), getMaxRange(name)).thenAccept(location -> {
 if (isValidRandomLocation(location)) {
 this.getCachedLocations().add(location);
 this.getCachedLocations(name).add(location);
 }
 });
 }
Expand DownExpand Up@@ -188,14 +216,18 @@ private CompletableFuture<Location> calculateRandomLocation(final Location cente
 return future;
 }

 // Returns an appropriate elevation for a given location in the nether, or -1 if none is found
 // Returns an appropriate elevation for a given location in the nether, or MIN_VALUE if none is found
 private double getNetherYAt(final Location location) {
 for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(location.getWorld()); ++y) {
 if (!LocationUtil.isBlockUnsafe(ess, location.getWorld(), location.getBlockX(), y, location.getBlockZ())) {
 final World world = location.getWorld();
 for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(world); ++y) {
 if (Material.BEDROCK.equals(world.getBlockAt(location.getBlockX(), y, location.getBlockZ()).getType())) {
 break;
 }
 if (!LocationUtil.isBlockUnsafe(ess, world, location.getBlockX(), y, location.getBlockZ())) {
 return y;
 }
 }
 return -1;
 return Double.MIN_VALUE;
 }

 private boolean isValidRandomLocation(final Location location) {
Expand DownExpand Up@@ -226,6 +258,10 @@ private boolean isExcludedBiome(final Location location) {
 return excluded.contains(biomeKey);
 }

 private String locationKey(final String name, final String key) {
 return "locations." + name + "." + key;
 }

 public File getFile() {
 return config.getFile();
 }
Expand Down

10 changes: 10 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/Settings.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ public boolean getRespawnAtHome() {
 return config.getBoolean("respawn-at-home", false);
 }

 @Override
 public String getRandomSpawnLocation() {
 return config.getString("random-spawn-location", "none");
 }

 @Override
 public String getRandomRespawnLocation() {
 return config.getString("random-respawn-location", "none");
 }

 @Override
 public boolean isRespawnAtAnchor() {
 return config.getBoolean("respawn-at-anchor", false);
Expand Down

3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/Warps.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,6 @@
import com.earth2me.essentials.utils.AdventureUtil;
import com.earth2me.essentials.utils.StringUtil;
import net.ess3.api.InvalidNameException;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import org.bukkit.Location;

Expand DownExpand Up@@ -54,7 +53,7 @@ public Collection<String> getList() {
 }

 @Override
 public Location getWarp(final String warp) throws WarpNotFoundException, InvalidWorldException {
 public Location getWarp(final String warp) throws WarpNotFoundException {
 final EssentialsConfiguration conf = warpPoints.get(new StringIgnoreCase(warp));
 if (conf == null) {
 throw new WarpNotFoundException();
Expand Down

3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/api/IWarps.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,8 @@ public interface IWarps extends IConf {
 * @param warp - Warp name
 * @return - Location the warp is set to
 * @throws WarpNotFoundException When the warp is not found
 * @throws net.ess3.api.InvalidWorldException When the world the warp is in is not found
 */
 Location getWarp(String warp) throws WarpNotFoundException, net.ess3.api.InvalidWorldException;
 Location getWarp(String warp) throws WarpNotFoundException;

 /**
 * Checks if the provided name is a warp.
Expand Down

20 changes: 0 additions & 20 deletions
Essentials/src/main/java/com/earth2me/essentials/api/InvalidWorldException.java

View file


Open in desktop


This file was deleted.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Improvements to Random Teleport#4271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

JRoy
merged 20 commits into

from

Nov 24, 2024
 Merged


Improvements to Random Teleport
#4271
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


20 commits


Select commit
Hold shift + click to select a range
be8bb92

Random teleport improvements


pop4959 Jun 25, 2021
7991c13

Merge


pop4959 Jul 5, 2021
6d3340e

Merge branch '2.x' into randomteleport-improvements


pop4959 Dec 11, 2021
e4e1bbb

Merge branch '2.x' of https://github.com/EssentialsX/Essentials into …


pop4959 Dec 28, 2021
26ff6ec

Merge branch '2.x' into randomteleport-improvements


pop4959 Feb 13, 2022
55fb0b2

Merge branch '2.x' into randomteleport-improvements


pop4959 May 17, 2022
36d1cf7

Merge branch '2.x' into randomteleport-improvements


pop4959 May 28, 2022
29597f2

Merge branch '2.x' into randomteleport-improvements


pop4959 Jun 4, 2022
51ab2af

Merge branch '2.x' into randomteleport-improvements


triagonal Jun 12, 2022
571fb8d

random spawn option


pop4959 Jul 2, 2022
f8f4002

avoid teleporting onto bedrock


pop4959 Jul 2, 2022
fbc5bc5

Merge branch '2.x' into randomteleport-improvements


pop4959 Jul 2, 2022
7e2b877

Merge branch '2.x' into randomteleport-improvements


JRoy Jul 5, 2022
eca91b2

Merge remote-tracking branch 'upstream/2.x' into fork/pop4959/randomt…


JRoy Nov 24, 2024
04defb1

fix compile issues


JRoy Nov 24, 2024
e9445c7

Move upgrades to EssentialsUpgrade


JRoy Nov 24, 2024
168ce3b

get rid of InvalidWorldException


JRoy Nov 24, 2024
20f66a8

Don't Reload RTP Config in /settpr


JRoy Nov 24, 2024
b9d9a24

Remove unused UserRandomTeleportEvent constructor


JRoy Nov 24, 2024
f8a659a

Merge branch '2.x' into randomteleport-improvements


JRoy Nov 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/AsyncTeleport.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@
import io.papermc.lib.PaperLib;
import net.ess3.api.IEssentials;
import net.ess3.api.IUser;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import net.ess3.api.events.UserWarpEvent;
import net.ess3.api.events.teleport.PreTeleportEvent;
Expand DownExpand Up@@ -424,7 +423,7 @@ public void warp(final IUser otherUser, String warp, final Trade chargeFor, fina
 final Location loc;
 try {
 loc = ess.getWarps().getWarp(warp);
 } catch (final WarpNotFoundException | InvalidWorldException e) {
 } catch (final WarpNotFoundException e) {
 future.completeExceptionally(e);
 return;
 }
Expand Down

11 changes: 4 additions & 7 deletions
Essentials/src/main/java/com/earth2me/essentials/Essentials.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -358,6 +358,10 @@ public void onEnable() {
 upgrade.convertKits();
 execTimer.mark("Kits");

 randomTeleport = new RandomTeleport(this);
 confList.add(randomTeleport);
 execTimer.mark("Init(RandomTeleport)");

 upgrade.afterSettings();
 execTimer.mark("Upgrade3");

Expand All@@ -373,13 +377,6 @@ public void onEnable() {
 confList.add(itemDb);
 execTimer.mark("Init(ItemDB)");

 randomTeleport = new RandomTeleport(this);
 if (randomTeleport.getPreCache()) {
 randomTeleport.cacheRandomLocations(randomTeleport.getCenter(), randomTeleport.getMinRange(), randomTeleport.getMaxRange());
 }
 confList.add(randomTeleport);
 execTimer.mark("Init(RandomTeleport)");

 customItemResolver = new CustomItemResolver(this);
 try {
 itemDb.registerResolver(this, "custom_items", customItemResolver);
Expand Down

35 changes: 35 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/EssentialsUpgrade.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.EssentialsUserConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.craftbukkit.BanLookup;
import com.earth2me.essentials.userstorage.ModernUUIDCache;
import com.earth2me.essentials.utils.AdventureUtil;
Expand DownExpand Up@@ -156,6 +157,39 @@ public static void uuidFileConvert(final IEssentials ess, final Boolean ignoreUF
 ess.getLogger().info("To rerun the conversion type /essentials uuidconvert");
 }

 public void updateRandomTeleport() {
 if (doneFile.getBoolean("updateRandomTeleport", false)) {
 return;
 }

 final EssentialsConfiguration config = ess.getRandomTeleport().getConfig();

 final LazyLocation center = config.getLocation("center");
 final Location centerLoc = center != null ? center.location() : null;
 if (center != null && centerLoc != null) {
 final double minRange = config.getDouble("min-range", Double.MIN_VALUE);
 final double maxRange = config.getDouble("max-range", Double.MIN_VALUE);
 for (final World world : ess.getServer().getWorlds()) {
 final String propPrefix = "locations." + world.getName() + ".";
 config.setProperty(propPrefix + "center", centerLoc);

 if (minRange != Double.MIN_VALUE) {
 config.setProperty(propPrefix + "min-range", minRange);
 }
 if (maxRange != Double.MIN_VALUE) {
 config.setProperty(propPrefix + "max-range", maxRange);
 }
 }
 }
 config.removeProperty("center");

 config.blockingSave();

 doneFile.setProperty("updateRandomTeleport", true);
 doneFile.save();
 ess.getLogger().info("Done converting random teleport config.");
 }

 public void convertMailList() {
 if (doneFile.getBoolean("updateUsersMailList", false)) {
 return;
Expand DownExpand Up@@ -1068,5 +1102,6 @@ public void afterSettings() {
 convertStupidCamelCaseUserdataKeys();
 convertMailList();
 purgeBrokenNpcAccounts();
 updateRandomTeleport();
 }
}

4 changes: 4 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/ISettings.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,10 @@ public interface ISettings extends IConf {

 boolean getRespawnAtHome();

 String getRandomSpawnLocation();

 String getRandomRespawnLocation();

 boolean isRespawnAtAnchor();

 Set getMultipleHomes();
Expand Down

124 changes: 80 additions & 44 deletions
Essentials/src/main/java/com/earth2me/essentials/RandomTeleport.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
package com.earth2me.essentials;

import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.utils.LocationUtil;
import com.earth2me.essentials.utils.VersionUtil;
import io.papermc.lib.PaperLib;
import net.ess3.api.InvalidWorldException;
import net.ess3.provider.BiomeKeyProvider;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.World;

import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import java.util.Random;
import java.util.Set;
Expand All@@ -23,58 +28,72 @@ public class RandomTeleport implements IConf {
 private static final int HIGHEST_BLOCK_Y_OFFSET = VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_15_R01) ? 1 : 0;
 private final IEssentials ess;
 private final EssentialsConfiguration config;
 private final ConcurrentLinkedQueue<Location> cachedLocations = new ConcurrentLinkedQueue<>();
 private final Map<String, ConcurrentLinkedQueue<Location>> cachedLocations = new HashMap<>();

 public RandomTeleport(final IEssentials essentials) {
 this.ess = essentials;
 config = new EssentialsConfiguration(new File(essentials.getDataFolder(), "tpr.yml"), "/tpr.yml",
 "Configuration for the random teleport command.\nSome settings may be defaulted, and can be changed via the /settpr command in-game.");
 "Configuration for the random teleport command.\nUse the /settpr command in-game to set random teleport locations.");
 reloadConfig();
 }

 public EssentialsConfiguration getConfig() {
 return config;
 }

 @Override
 public void reloadConfig() {
 config.load();
 cachedLocations.clear();
 }

 public Location getCenter() {
 try {
 final LazyLocation center = config.getLocation("center");
 if (center != null && center.location() != null) {
 return center.location();
 }
 } catch (final InvalidWorldException ignored) {
 public boolean hasLocation(final String name) {
 return config.hasProperty("locations." + name);
 }

 public Location getCenter(final String name) {
 final LazyLocation center = config.getLocation(locationKey(name, "center"));
 if (center != null && center.location() != null) {
 return center.location();
 }
 final Location center = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
 center.setY(center.getWorld().getHighestBlockYAt(center) + HIGHEST_BLOCK_Y_OFFSET);
 setCenter(center);
 return center;

 final Location worldCenter = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
 worldCenter.setY(worldCenter.getWorld().getHighestBlockYAt(worldCenter) + HIGHEST_BLOCK_Y_OFFSET);
 setCenter(name, worldCenter);
 return worldCenter;
 }

 public void setCenter(final Location center) {
 config.setProperty("center", center);
 public void setCenter(final String name, final Location center) {
 config.setProperty(locationKey(name, "center"), center);
 config.save();
 }

 public double getMinRange() {
 return config.getDouble("min-range", 0d);
 public double getMinRange(final String name) {
 return config.getDouble(locationKey(name, "min-range"), 0d);
 }

 public void setMinRange(final double minRange) {
 config.setProperty("min-range", minRange);
 public void setMinRange(final String name, final double minRange) {
 config.setProperty(locationKey(name, "min-range"), minRange);
 config.save();
 }

 public double getMaxRange() {
 return config.getDouble("max-range", getCenter().getWorld().getWorldBorder().getSize() / 2);
 public double getMaxRange(final String name) {
 return config.getDouble(locationKey(name, "max-range"), getCenter(name).getWorld().getWorldBorder().getSize() / 2);
 }

 public void setMaxRange(final double maxRange) {
 config.setProperty("max-range", maxRange);
 public void setMaxRange(final String name, final double maxRange) {
 config.setProperty(locationKey(name, "max-range"), maxRange);
 config.save();
 }

 public String getDefaultLocation() {
 return config.getString("default-location", "{world}");
 }

 public boolean isPerLocationPermission() {
 return config.getBoolean("per-location-permission", false);
 }

 public Set<String> getExcludedBiomes() {
 final Set<String> excludedBiomes = new HashSet<>();
 for (final String key : config.getList("excluded-biomes", String.class)) {
Expand All@@ -91,39 +110,48 @@ public int getCacheThreshold() {
 return config.getInt("cache-threshold", 10);
 }

 public boolean getPreCache() {
 return config.getBoolean("pre-cache", false);
 public List<String> listLocations() {
 return new ArrayList<>(ConfigurateUtil.getKeys(config.getRootNode().node("locations")));
 }

 public Queue<Location> getCachedLocations() {
 return cachedLocations;
 public Queue<Location> getCachedLocations(final String name) {
 this.cachedLocations.computeIfAbsent(name, x -> new ConcurrentLinkedQueue<>());
 return cachedLocations.get(name);
 }

 // Get a random location; cached if possible. Otherwise on demand.
 public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
 final int findAttempts = this.getFindAttempts();
 final Queue<Location> cachedLocations = this.getCachedLocations();
 // Get a named random teleport location; cached if possible, otherwise on demand.
 public CompletableFuture<Location> getRandomLocation(final String name) {
 final Queue<Location> cached = this.getCachedLocations(name);
 // Try to build up the cache if it is below the threshold
 if (cachedLocations.size() < this.getCacheThreshold()) {
 cacheRandomLocations(center, minRange, maxRange);
 if (cached.size() < this.getCacheThreshold()) {
 cacheRandomLocations(name);
 }
 final CompletableFuture<Location> future = new CompletableFuture<>();
 // Return a random location immediately if one is available, otherwise try to find one now
 if (cachedLocations.isEmpty()) {
 if (cached.isEmpty()) {
 final int findAttempts = this.getFindAttempts();
 final Location center = this.getCenter(name);
 final double minRange = this.getMinRange(name);
 final double maxRange = this.getMaxRange(name);
 attemptRandomLocation(findAttempts, center, minRange, maxRange).thenAccept(future::complete);
 } else {
 future.complete(cachedLocations.poll());
 future.complete(cached.poll());
 }
 return future;
 }

 // Prompts caching random valid locations, up to a maximum number of attempts
 public void cacheRandomLocations(final Location center, final double minRange, final double maxRange) {
 // Get a random location with specific parameters (note: not cached).
 public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
 return attemptRandomLocation(this.getFindAttempts(), center, minRange, maxRange);
 }

 // Prompts caching random valid locations, up to a maximum number of attempts.
 public void cacheRandomLocations(final String name) {
 ess.getServer().getScheduler().scheduleSyncDelayedTask(ess, () -> {
 for (int i = 0; i < this.getFindAttempts(); ++i) {
 calculateRandomLocation(center, minRange, maxRange).thenAccept(location -> {
 calculateRandomLocation(getCenter(name), getMinRange(name), getMaxRange(name)).thenAccept(location -> {
 if (isValidRandomLocation(location)) {
 this.getCachedLocations().add(location);
 this.getCachedLocations(name).add(location);
 }
 });
 }
Expand DownExpand Up@@ -188,14 +216,18 @@ private CompletableFuture<Location> calculateRandomLocation(final Location cente
 return future;
 }

 // Returns an appropriate elevation for a given location in the nether, or -1 if none is found
 // Returns an appropriate elevation for a given location in the nether, or MIN_VALUE if none is found
 private double getNetherYAt(final Location location) {
 for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(location.getWorld()); ++y) {
 if (!LocationUtil.isBlockUnsafe(ess, location.getWorld(), location.getBlockX(), y, location.getBlockZ())) {
 final World world = location.getWorld();
 for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(world); ++y) {
 if (Material.BEDROCK.equals(world.getBlockAt(location.getBlockX(), y, location.getBlockZ()).getType())) {
 break;
 }
 if (!LocationUtil.isBlockUnsafe(ess, world, location.getBlockX(), y, location.getBlockZ())) {
 return y;
 }
 }
 return -1;
 return Double.MIN_VALUE;
 }

 private boolean isValidRandomLocation(final Location location) {
Expand DownExpand Up@@ -226,6 +258,10 @@ private boolean isExcludedBiome(final Location location) {
 return excluded.contains(biomeKey);
 }

 private String locationKey(final String name, final String key) {
 return "locations." + name + "." + key;
 }

 public File getFile() {
 return config.getFile();
 }
Expand Down

10 changes: 10 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/Settings.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ public boolean getRespawnAtHome() {
 return config.getBoolean("respawn-at-home", false);
 }

 @Override
 public String getRandomSpawnLocation() {
 return config.getString("random-spawn-location", "none");
 }

 @Override
 public String getRandomRespawnLocation() {
 return config.getString("random-respawn-location", "none");
 }

 @Override
 public boolean isRespawnAtAnchor() {
 return config.getBoolean("respawn-at-anchor", false);
Expand Down

3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/Warps.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,6 @@
import com.earth2me.essentials.utils.AdventureUtil;
import com.earth2me.essentials.utils.StringUtil;
import net.ess3.api.InvalidNameException;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import org.bukkit.Location;

Expand DownExpand Up@@ -54,7 +53,7 @@ public Collection<String> getList() {
 }

 @Override
 public Location getWarp(final String warp) throws WarpNotFoundException, InvalidWorldException {
 public Location getWarp(final String warp) throws WarpNotFoundException {
 final EssentialsConfiguration conf = warpPoints.get(new StringIgnoreCase(warp));
 if (conf == null) {
 throw new WarpNotFoundException();
Expand Down

3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/api/IWarps.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,8 @@ public interface IWarps extends IConf {
 * @param warp - Warp name
 * @return - Location the warp is set to
 * @throws WarpNotFoundException When the warp is not found
 * @throws net.ess3.api.InvalidWorldException When the world the warp is in is not found
 */
 Location getWarp(String warp) throws WarpNotFoundException, net.ess3.api.InvalidWorldException;
 Location getWarp(String warp) throws WarpNotFoundException;

 /**
 * Checks if the provided name is a warp.
Expand Down

20 changes: 0 additions & 20 deletions
Essentials/src/main/java/com/earth2me/essentials/api/InvalidWorldException.java

View file


Open in desktop


This file was deleted.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Improvements to Random Teleport#4271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

JRoy
merged 20 commits into

from

Nov 24, 2024
 Merged


Improvements to Random Teleport
#4271
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


20 commits


Select commit
Hold shift + click to select a range
be8bb92

Random teleport improvements


pop4959 Jun 25, 2021
7991c13

Merge


pop4959 Jul 5, 2021
6d3340e

Merge branch '2.x' into randomteleport-improvements


pop4959 Dec 11, 2021
e4e1bbb

Merge branch '2.x' of https://github.com/EssentialsX/Essentials into …


pop4959 Dec 28, 2021
26ff6ec

Merge branch '2.x' into randomteleport-improvements


pop4959 Feb 13, 2022
55fb0b2

Merge branch '2.x' into randomteleport-improvements


pop4959 May 17, 2022
36d1cf7

Merge branch '2.x' into randomteleport-improvements


pop4959 May 28, 2022
29597f2

Merge branch '2.x' into randomteleport-improvements


pop4959 Jun 4, 2022
51ab2af

Merge branch '2.x' into randomteleport-improvements


triagonal Jun 12, 2022
571fb8d

random spawn option


pop4959 Jul 2, 2022
f8f4002

avoid teleporting onto bedrock


pop4959 Jul 2, 2022
fbc5bc5

Merge branch '2.x' into randomteleport-improvements


pop4959 Jul 2, 2022
7e2b877

Merge branch '2.x' into randomteleport-improvements


JRoy Jul 5, 2022
eca91b2

Merge remote-tracking branch 'upstream/2.x' into fork/pop4959/randomt…


JRoy Nov 24, 2024
04defb1

fix compile issues


JRoy Nov 24, 2024
e9445c7

Move upgrades to EssentialsUpgrade


JRoy Nov 24, 2024
168ce3b

get rid of InvalidWorldException


JRoy Nov 24, 2024
20f66a8

Don't Reload RTP Config in /settpr


JRoy Nov 24, 2024
b9d9a24

Remove unused UserRandomTeleportEvent constructor


JRoy Nov 24, 2024
f8a659a

Merge branch '2.x' into randomteleport-improvements


JRoy Nov 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/AsyncTeleport.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@
import io.papermc.lib.PaperLib;
import net.ess3.api.IEssentials;
import net.ess3.api.IUser;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import net.ess3.api.events.UserWarpEvent;
import net.ess3.api.events.teleport.PreTeleportEvent;
Expand DownExpand Up@@ -424,7 +423,7 @@ public void warp(final IUser otherUser, String warp, final Trade chargeFor, fina
 final Location loc;
 try {
 loc = ess.getWarps().getWarp(warp);
 } catch (final WarpNotFoundException | InvalidWorldException e) {
 } catch (final WarpNotFoundException e) {
 future.completeExceptionally(e);
 return;
 }
Expand Down

11 changes: 4 additions & 7 deletions
Essentials/src/main/java/com/earth2me/essentials/Essentials.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -358,6 +358,10 @@ public void onEnable() {
 upgrade.convertKits();
 execTimer.mark("Kits");

 randomTeleport = new RandomTeleport(this);
 confList.add(randomTeleport);
 execTimer.mark("Init(RandomTeleport)");

 upgrade.afterSettings();
 execTimer.mark("Upgrade3");

Expand All@@ -373,13 +377,6 @@ public void onEnable() {
 confList.add(itemDb);
 execTimer.mark("Init(ItemDB)");

 randomTeleport = new RandomTeleport(this);
 if (randomTeleport.getPreCache()) {
 randomTeleport.cacheRandomLocations(randomTeleport.getCenter(), randomTeleport.getMinRange(), randomTeleport.getMaxRange());
 }
 confList.add(randomTeleport);
 execTimer.mark("Init(RandomTeleport)");

 customItemResolver = new CustomItemResolver(this);
 try {
 itemDb.registerResolver(this, "custom_items", customItemResolver);
Expand Down

35 changes: 35 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/EssentialsUpgrade.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.EssentialsUserConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.craftbukkit.BanLookup;
import com.earth2me.essentials.userstorage.ModernUUIDCache;
import com.earth2me.essentials.utils.AdventureUtil;
Expand DownExpand Up@@ -156,6 +157,39 @@ public static void uuidFileConvert(final IEssentials ess, final Boolean ignoreUF
 ess.getLogger().info("To rerun the conversion type /essentials uuidconvert");
 }

 public void updateRandomTeleport() {
 if (doneFile.getBoolean("updateRandomTeleport", false)) {
 return;
 }

 final EssentialsConfiguration config = ess.getRandomTeleport().getConfig();

 final LazyLocation center = config.getLocation("center");
 final Location centerLoc = center != null ? center.location() : null;
 if (center != null && centerLoc != null) {
 final double minRange = config.getDouble("min-range", Double.MIN_VALUE);
 final double maxRange = config.getDouble("max-range", Double.MIN_VALUE);
 for (final World world : ess.getServer().getWorlds()) {
 final String propPrefix = "locations." + world.getName() + ".";
 config.setProperty(propPrefix + "center", centerLoc);

 if (minRange != Double.MIN_VALUE) {
 config.setProperty(propPrefix + "min-range", minRange);
 }
 if (maxRange != Double.MIN_VALUE) {
 config.setProperty(propPrefix + "max-range", maxRange);
 }
 }
 }
 config.removeProperty("center");

 config.blockingSave();

 doneFile.setProperty("updateRandomTeleport", true);
 doneFile.save();
 ess.getLogger().info("Done converting random teleport config.");
 }

 public void convertMailList() {
 if (doneFile.getBoolean("updateUsersMailList", false)) {
 return;
Expand DownExpand Up@@ -1068,5 +1102,6 @@ public void afterSettings() {
 convertStupidCamelCaseUserdataKeys();
 convertMailList();
 purgeBrokenNpcAccounts();
 updateRandomTeleport();
 }
}

4 changes: 4 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/ISettings.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,10 @@ public interface ISettings extends IConf {

 boolean getRespawnAtHome();

 String getRandomSpawnLocation();

 String getRandomRespawnLocation();

 boolean isRespawnAtAnchor();

 Set getMultipleHomes();
Expand Down

124 changes: 80 additions & 44 deletions
Essentials/src/main/java/com/earth2me/essentials/RandomTeleport.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
package com.earth2me.essentials;

import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.utils.LocationUtil;
import com.earth2me.essentials.utils.VersionUtil;
import io.papermc.lib.PaperLib;
import net.ess3.api.InvalidWorldException;
import net.ess3.provider.BiomeKeyProvider;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.World;

import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import java.util.Random;
import java.util.Set;
Expand All@@ -23,58 +28,72 @@ public class RandomTeleport implements IConf {
 private static final int HIGHEST_BLOCK_Y_OFFSET = VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_15_R01) ? 1 : 0;
 private final IEssentials ess;
 private final EssentialsConfiguration config;
 private final ConcurrentLinkedQueue<Location> cachedLocations = new ConcurrentLinkedQueue<>();
 private final Map<String, ConcurrentLinkedQueue<Location>> cachedLocations = new HashMap<>();

 public RandomTeleport(final IEssentials essentials) {
 this.ess = essentials;
 config = new EssentialsConfiguration(new File(essentials.getDataFolder(), "tpr.yml"), "/tpr.yml",
 "Configuration for the random teleport command.\nSome settings may be defaulted, and can be changed via the /settpr command in-game.");
 "Configuration for the random teleport command.\nUse the /settpr command in-game to set random teleport locations.");
 reloadConfig();
 }

 public EssentialsConfiguration getConfig() {
 return config;
 }

 @Override
 public void reloadConfig() {
 config.load();
 cachedLocations.clear();
 }

 public Location getCenter() {
 try {
 final LazyLocation center = config.getLocation("center");
 if (center != null && center.location() != null) {
 return center.location();
 }
 } catch (final InvalidWorldException ignored) {
 public boolean hasLocation(final String name) {
 return config.hasProperty("locations." + name);
 }

 public Location getCenter(final String name) {
 final LazyLocation center = config.getLocation(locationKey(name, "center"));
 if (center != null && center.location() != null) {
 return center.location();
 }
 final Location center = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
 center.setY(center.getWorld().getHighestBlockYAt(center) + HIGHEST_BLOCK_Y_OFFSET);
 setCenter(center);
 return center;

 final Location worldCenter = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
 worldCenter.setY(worldCenter.getWorld().getHighestBlockYAt(worldCenter) + HIGHEST_BLOCK_Y_OFFSET);
 setCenter(name, worldCenter);
 return worldCenter;
 }

 public void setCenter(final Location center) {
 config.setProperty("center", center);
 public void setCenter(final String name, final Location center) {
 config.setProperty(locationKey(name, "center"), center);
 config.save();
 }

 public double getMinRange() {
 return config.getDouble("min-range", 0d);
 public double getMinRange(final String name) {
 return config.getDouble(locationKey(name, "min-range"), 0d);
 }

 public void setMinRange(final double minRange) {
 config.setProperty("min-range", minRange);
 public void setMinRange(final String name, final double minRange) {
 config.setProperty(locationKey(name, "min-range"), minRange);
 config.save();
 }

 public double getMaxRange() {
 return config.getDouble("max-range", getCenter().getWorld().getWorldBorder().getSize() / 2);
 public double getMaxRange(final String name) {
 return config.getDouble(locationKey(name, "max-range"), getCenter(name).getWorld().getWorldBorder().getSize() / 2);
 }

 public void setMaxRange(final double maxRange) {
 config.setProperty("max-range", maxRange);
 public void setMaxRange(final String name, final double maxRange) {
 config.setProperty(locationKey(name, "max-range"), maxRange);
 config.save();
 }

 public String getDefaultLocation() {
 return config.getString("default-location", "{world}");
 }

 public boolean isPerLocationPermission() {
 return config.getBoolean("per-location-permission", false);
 }

 public Set<String> getExcludedBiomes() {
 final Set<String> excludedBiomes = new HashSet<>();
 for (final String key : config.getList("excluded-biomes", String.class)) {
Expand All@@ -91,39 +110,48 @@ public int getCacheThreshold() {
 return config.getInt("cache-threshold", 10);
 }

 public boolean getPreCache() {
 return config.getBoolean("pre-cache", false);
 public List<String> listLocations() {
 return new ArrayList<>(ConfigurateUtil.getKeys(config.getRootNode().node("locations")));
 }

 public Queue<Location> getCachedLocations() {
 return cachedLocations;
 public Queue<Location> getCachedLocations(final String name) {
 this.cachedLocations.computeIfAbsent(name, x -> new ConcurrentLinkedQueue<>());
 return cachedLocations.get(name);
 }

 // Get a random location; cached if possible. Otherwise on demand.
 public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
 final int findAttempts = this.getFindAttempts();
 final Queue<Location> cachedLocations = this.getCachedLocations();
 // Get a named random teleport location; cached if possible, otherwise on demand.
 public CompletableFuture<Location> getRandomLocation(final String name) {
 final Queue<Location> cached = this.getCachedLocations(name);
 // Try to build up the cache if it is below the threshold
 if (cachedLocations.size() < this.getCacheThreshold()) {
 cacheRandomLocations(center, minRange, maxRange);
 if (cached.size() < this.getCacheThreshold()) {
 cacheRandomLocations(name);
 }
 final CompletableFuture<Location> future = new CompletableFuture<>();
 // Return a random location immediately if one is available, otherwise try to find one now
 if (cachedLocations.isEmpty()) {
 if (cached.isEmpty()) {
 final int findAttempts = this.getFindAttempts();
 final Location center = this.getCenter(name);
 final double minRange = this.getMinRange(name);
 final double maxRange = this.getMaxRange(name);
 attemptRandomLocation(findAttempts, center, minRange, maxRange).thenAccept(future::complete);
 } else {
 future.complete(cachedLocations.poll());
 future.complete(cached.poll());
 }
 return future;
 }

 // Prompts caching random valid locations, up to a maximum number of attempts
 public void cacheRandomLocations(final Location center, final double minRange, final double maxRange) {
 // Get a random location with specific parameters (note: not cached).
 public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
 return attemptRandomLocation(this.getFindAttempts(), center, minRange, maxRange);
 }

 // Prompts caching random valid locations, up to a maximum number of attempts.
 public void cacheRandomLocations(final String name) {
 ess.getServer().getScheduler().scheduleSyncDelayedTask(ess, () -> {
 for (int i = 0; i < this.getFindAttempts(); ++i) {
 calculateRandomLocation(center, minRange, maxRange).thenAccept(location -> {
 calculateRandomLocation(getCenter(name), getMinRange(name), getMaxRange(name)).thenAccept(location -> {
 if (isValidRandomLocation(location)) {
 this.getCachedLocations().add(location);
 this.getCachedLocations(name).add(location);
 }
 });
 }
Expand DownExpand Up@@ -188,14 +216,18 @@ private CompletableFuture<Location> calculateRandomLocation(final Location cente
 return future;
 }

 // Returns an appropriate elevation for a given location in the nether, or -1 if none is found
 // Returns an appropriate elevation for a given location in the nether, or MIN_VALUE if none is found
 private double getNetherYAt(final Location location) {
 for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(location.getWorld()); ++y) {
 if (!LocationUtil.isBlockUnsafe(ess, location.getWorld(), location.getBlockX(), y, location.getBlockZ())) {
 final World world = location.getWorld();
 for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(world); ++y) {
 if (Material.BEDROCK.equals(world.getBlockAt(location.getBlockX(), y, location.getBlockZ()).getType())) {
 break;
 }
 if (!LocationUtil.isBlockUnsafe(ess, world, location.getBlockX(), y, location.getBlockZ())) {
 return y;
 }
 }
 return -1;
 return Double.MIN_VALUE;
 }

 private boolean isValidRandomLocation(final Location location) {
Expand DownExpand Up@@ -226,6 +258,10 @@ private boolean isExcludedBiome(final Location location) {
 return excluded.contains(biomeKey);
 }

 private String locationKey(final String name, final String key) {
 return "locations." + name + "." + key;
 }

 public File getFile() {
 return config.getFile();
 }
Expand Down

10 changes: 10 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/Settings.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ public boolean getRespawnAtHome() {
 return config.getBoolean("respawn-at-home", false);
 }

 @Override
 public String getRandomSpawnLocation() {
 return config.getString("random-spawn-location", "none");
 }

 @Override
 public String getRandomRespawnLocation() {
 return config.getString("random-respawn-location", "none");
 }

 @Override
 public boolean isRespawnAtAnchor() {
 return config.getBoolean("respawn-at-anchor", false);
Expand Down

3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/Warps.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,6 @@
import com.earth2me.essentials.utils.AdventureUtil;
import com.earth2me.essentials.utils.StringUtil;
import net.ess3.api.InvalidNameException;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import org.bukkit.Location;

Expand DownExpand Up@@ -54,7 +53,7 @@ public Collection<String> getList() {
 }

 @Override
 public Location getWarp(final String warp) throws WarpNotFoundException, InvalidWorldException {
 public Location getWarp(final String warp) throws WarpNotFoundException {
 final EssentialsConfiguration conf = warpPoints.get(new StringIgnoreCase(warp));
 if (conf == null) {
 throw new WarpNotFoundException();
Expand Down

3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/api/IWarps.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,8 @@ public interface IWarps extends IConf {
 * @param warp - Warp name
 * @return - Location the warp is set to
 * @throws WarpNotFoundException When the warp is not found
 * @throws net.ess3.api.InvalidWorldException When the world the warp is in is not found
 */
 Location getWarp(String warp) throws WarpNotFoundException, net.ess3.api.InvalidWorldException;
 Location getWarp(String warp) throws WarpNotFoundException;

 /**
 * Checks if the provided name is a warp.
Expand Down

20 changes: 0 additions & 20 deletions
Essentials/src/main/java/com/earth2me/essentials/api/InvalidWorldException.java

View file


Open in desktop


This file was deleted.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Improvements to Random Teleport#4271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

JRoy
merged 20 commits into

from

Nov 24, 2024
 Merged


Improvements to Random Teleport
#4271
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


20 commits


Select commit
Hold shift + click to select a range
be8bb92

Random teleport improvements


pop4959 Jun 25, 2021
7991c13

Merge


pop4959 Jul 5, 2021
6d3340e

Merge branch '2.x' into randomteleport-improvements


pop4959 Dec 11, 2021
e4e1bbb

Merge branch '2.x' of https://github.com/EssentialsX/Essentials into …


pop4959 Dec 28, 2021
26ff6ec

Merge branch '2.x' into randomteleport-improvements


pop4959 Feb 13, 2022
55fb0b2

Merge branch '2.x' into randomteleport-improvements


pop4959 May 17, 2022
36d1cf7

Merge branch '2.x' into randomteleport-improvements


pop4959 May 28, 2022
29597f2

Merge branch '2.x' into randomteleport-improvements


pop4959 Jun 4, 2022
51ab2af

Merge branch '2.x' into randomteleport-improvements


triagonal Jun 12, 2022
571fb8d

random spawn option


pop4959 Jul 2, 2022
f8f4002

avoid teleporting onto bedrock


pop4959 Jul 2, 2022
fbc5bc5

Merge branch '2.x' into randomteleport-improvements


pop4959 Jul 2, 2022
7e2b877

Merge branch '2.x' into randomteleport-improvements


JRoy Jul 5, 2022
eca91b2

Merge remote-tracking branch 'upstream/2.x' into fork/pop4959/randomt…


JRoy Nov 24, 2024
04defb1

fix compile issues


JRoy Nov 24, 2024
e9445c7

Move upgrades to EssentialsUpgrade


JRoy Nov 24, 2024
168ce3b

get rid of InvalidWorldException


JRoy Nov 24, 2024
20f66a8

Don't Reload RTP Config in /settpr


JRoy Nov 24, 2024
b9d9a24

Remove unused UserRandomTeleportEvent constructor


JRoy Nov 24, 2024
f8a659a

Merge branch '2.x' into randomteleport-improvements


JRoy Nov 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/AsyncTeleport.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@
import io.papermc.lib.PaperLib;
import net.ess3.api.IEssentials;
import net.ess3.api.IUser;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import net.ess3.api.events.UserWarpEvent;
import net.ess3.api.events.teleport.PreTeleportEvent;
Expand DownExpand Up@@ -424,7 +423,7 @@ public void warp(final IUser otherUser, String warp, final Trade chargeFor, fina
 final Location loc;
 try {
 loc = ess.getWarps().getWarp(warp);
 } catch (final WarpNotFoundException | InvalidWorldException e) {
 } catch (final WarpNotFoundException e) {
 future.completeExceptionally(e);
 return;
 }
Expand Down

11 changes: 4 additions & 7 deletions
Essentials/src/main/java/com/earth2me/essentials/Essentials.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -358,6 +358,10 @@ public void onEnable() {
 upgrade.convertKits();
 execTimer.mark("Kits");

 randomTeleport = new RandomTeleport(this);
 confList.add(randomTeleport);
 execTimer.mark("Init(RandomTeleport)");

 upgrade.afterSettings();
 execTimer.mark("Upgrade3");

Expand All@@ -373,13 +377,6 @@ public void onEnable() {
 confList.add(itemDb);
 execTimer.mark("Init(ItemDB)");

 randomTeleport = new RandomTeleport(this);
 if (randomTeleport.getPreCache()) {
 randomTeleport.cacheRandomLocations(randomTeleport.getCenter(), randomTeleport.getMinRange(), randomTeleport.getMaxRange());
 }
 confList.add(randomTeleport);
 execTimer.mark("Init(RandomTeleport)");

 customItemResolver = new CustomItemResolver(this);
 try {
 itemDb.registerResolver(this, "custom_items", customItemResolver);
Expand Down

35 changes: 35 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/EssentialsUpgrade.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.EssentialsUserConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.craftbukkit.BanLookup;
import com.earth2me.essentials.userstorage.ModernUUIDCache;
import com.earth2me.essentials.utils.AdventureUtil;
Expand DownExpand Up@@ -156,6 +157,39 @@ public static void uuidFileConvert(final IEssentials ess, final Boolean ignoreUF
 ess.getLogger().info("To rerun the conversion type /essentials uuidconvert");
 }

 public void updateRandomTeleport() {
 if (doneFile.getBoolean("updateRandomTeleport", false)) {
 return;
 }

 final EssentialsConfiguration config = ess.getRandomTeleport().getConfig();

 final LazyLocation center = config.getLocation("center");
 final Location centerLoc = center != null ? center.location() : null;
 if (center != null && centerLoc != null) {
 final double minRange = config.getDouble("min-range", Double.MIN_VALUE);
 final double maxRange = config.getDouble("max-range", Double.MIN_VALUE);
 for (final World world : ess.getServer().getWorlds()) {
 final String propPrefix = "locations." + world.getName() + ".";
 config.setProperty(propPrefix + "center", centerLoc);

 if (minRange != Double.MIN_VALUE) {
 config.setProperty(propPrefix + "min-range", minRange);
 }
 if (maxRange != Double.MIN_VALUE) {
 config.setProperty(propPrefix + "max-range", maxRange);
 }
 }
 }
 config.removeProperty("center");

 config.blockingSave();

 doneFile.setProperty("updateRandomTeleport", true);
 doneFile.save();
 ess.getLogger().info("Done converting random teleport config.");
 }

 public void convertMailList() {
 if (doneFile.getBoolean("updateUsersMailList", false)) {
 return;
Expand DownExpand Up@@ -1068,5 +1102,6 @@ public void afterSettings() {
 convertStupidCamelCaseUserdataKeys();
 convertMailList();
 purgeBrokenNpcAccounts();
 updateRandomTeleport();
 }
}

4 changes: 4 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/ISettings.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,10 @@ public interface ISettings extends IConf {

 boolean getRespawnAtHome();

 String getRandomSpawnLocation();

 String getRandomRespawnLocation();

 boolean isRespawnAtAnchor();

 Set getMultipleHomes();
Expand Down

124 changes: 80 additions & 44 deletions
Essentials/src/main/java/com/earth2me/essentials/RandomTeleport.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
package com.earth2me.essentials;

import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.utils.LocationUtil;
import com.earth2me.essentials.utils.VersionUtil;
import io.papermc.lib.PaperLib;
import net.ess3.api.InvalidWorldException;
import net.ess3.provider.BiomeKeyProvider;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.World;

import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import java.util.Random;
import java.util.Set;
Expand All@@ -23,58 +28,72 @@ public class RandomTeleport implements IConf {
 private static final int HIGHEST_BLOCK_Y_OFFSET = VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_15_R01) ? 1 : 0;
 private final IEssentials ess;
 private final EssentialsConfiguration config;
 private final ConcurrentLinkedQueue<Location> cachedLocations = new ConcurrentLinkedQueue<>();
 private final Map<String, ConcurrentLinkedQueue<Location>> cachedLocations = new HashMap<>();

 public RandomTeleport(final IEssentials essentials) {
 this.ess = essentials;
 config = new EssentialsConfiguration(new File(essentials.getDataFolder(), "tpr.yml"), "/tpr.yml",
 "Configuration for the random teleport command.\nSome settings may be defaulted, and can be changed via the /settpr command in-game.");
 "Configuration for the random teleport command.\nUse the /settpr command in-game to set random teleport locations.");
 reloadConfig();
 }

 public EssentialsConfiguration getConfig() {
 return config;
 }

 @Override
 public void reloadConfig() {
 config.load();
 cachedLocations.clear();
 }

 public Location getCenter() {
 try {
 final LazyLocation center = config.getLocation("center");
 if (center != null && center.location() != null) {
 return center.location();
 }
 } catch (final InvalidWorldException ignored) {
 public boolean hasLocation(final String name) {
 return config.hasProperty("locations." + name);
 }

 public Location getCenter(final String name) {
 final LazyLocation center = config.getLocation(locationKey(name, "center"));
 if (center != null && center.location() != null) {
 return center.location();
 }
 final Location center = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
 center.setY(center.getWorld().getHighestBlockYAt(center) + HIGHEST_BLOCK_Y_OFFSET);
 setCenter(center);
 return center;

 final Location worldCenter = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
 worldCenter.setY(worldCenter.getWorld().getHighestBlockYAt(worldCenter) + HIGHEST_BLOCK_Y_OFFSET);
 setCenter(name, worldCenter);
 return worldCenter;
 }

 public void setCenter(final Location center) {
 config.setProperty("center", center);
 public void setCenter(final String name, final Location center) {
 config.setProperty(locationKey(name, "center"), center);
 config.save();
 }

 public double getMinRange() {
 return config.getDouble("min-range", 0d);
 public double getMinRange(final String name) {
 return config.getDouble(locationKey(name, "min-range"), 0d);
 }

 public void setMinRange(final double minRange) {
 config.setProperty("min-range", minRange);
 public void setMinRange(final String name, final double minRange) {
 config.setProperty(locationKey(name, "min-range"), minRange);
 config.save();
 }

 public double getMaxRange() {
 return config.getDouble("max-range", getCenter().getWorld().getWorldBorder().getSize() / 2);
 public double getMaxRange(final String name) {
 return config.getDouble(locationKey(name, "max-range"), getCenter(name).getWorld().getWorldBorder().getSize() / 2);
 }

 public void setMaxRange(final double maxRange) {
 config.setProperty("max-range", maxRange);
 public void setMaxRange(final String name, final double maxRange) {
 config.setProperty(locationKey(name, "max-range"), maxRange);
 config.save();
 }

 public String getDefaultLocation() {
 return config.getString("default-location", "{world}");
 }

 public boolean isPerLocationPermission() {
 return config.getBoolean("per-location-permission", false);
 }

 public Set<String> getExcludedBiomes() {
 final Set<String> excludedBiomes = new HashSet<>();
 for (final String key : config.getList("excluded-biomes", String.class)) {
Expand All@@ -91,39 +110,48 @@ public int getCacheThreshold() {
 return config.getInt("cache-threshold", 10);
 }

 public boolean getPreCache() {
 return config.getBoolean("pre-cache", false);
 public List<String> listLocations() {
 return new ArrayList<>(ConfigurateUtil.getKeys(config.getRootNode().node("locations")));
 }

 public Queue<Location> getCachedLocations() {
 return cachedLocations;
 public Queue<Location> getCachedLocations(final String name) {
 this.cachedLocations.computeIfAbsent(name, x -> new ConcurrentLinkedQueue<>());
 return cachedLocations.get(name);
 }

 // Get a random location; cached if possible. Otherwise on demand.
 public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
 final int findAttempts = this.getFindAttempts();
 final Queue<Location> cachedLocations = this.getCachedLocations();
 // Get a named random teleport location; cached if possible, otherwise on demand.
 public CompletableFuture<Location> getRandomLocation(final String name) {
 final Queue<Location> cached = this.getCachedLocations(name);
 // Try to build up the cache if it is below the threshold
 if (cachedLocations.size() < this.getCacheThreshold()) {
 cacheRandomLocations(center, minRange, maxRange);
 if (cached.size() < this.getCacheThreshold()) {
 cacheRandomLocations(name);
 }
 final CompletableFuture<Location> future = new CompletableFuture<>();
 // Return a random location immediately if one is available, otherwise try to find one now
 if (cachedLocations.isEmpty()) {
 if (cached.isEmpty()) {
 final int findAttempts = this.getFindAttempts();
 final Location center = this.getCenter(name);
 final double minRange = this.getMinRange(name);
 final double maxRange = this.getMaxRange(name);
 attemptRandomLocation(findAttempts, center, minRange, maxRange).thenAccept(future::complete);
 } else {
 future.complete(cachedLocations.poll());
 future.complete(cached.poll());
 }
 return future;
 }

 // Prompts caching random valid locations, up to a maximum number of attempts
 public void cacheRandomLocations(final Location center, final double minRange, final double maxRange) {
 // Get a random location with specific parameters (note: not cached).
 public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
 return attemptRandomLocation(this.getFindAttempts(), center, minRange, maxRange);
 }

 // Prompts caching random valid locations, up to a maximum number of attempts.
 public void cacheRandomLocations(final String name) {
 ess.getServer().getScheduler().scheduleSyncDelayedTask(ess, () -> {
 for (int i = 0; i < this.getFindAttempts(); ++i) {
 calculateRandomLocation(center, minRange, maxRange).thenAccept(location -> {
 calculateRandomLocation(getCenter(name), getMinRange(name), getMaxRange(name)).thenAccept(location -> {
 if (isValidRandomLocation(location)) {
 this.getCachedLocations().add(location);
 this.getCachedLocations(name).add(location);
 }
 });
 }
Expand DownExpand Up@@ -188,14 +216,18 @@ private CompletableFuture<Location> calculateRandomLocation(final Location cente
 return future;
 }

 // Returns an appropriate elevation for a given location in the nether, or -1 if none is found
 // Returns an appropriate elevation for a given location in the nether, or MIN_VALUE if none is found
 private double getNetherYAt(final Location location) {
 for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(location.getWorld()); ++y) {
 if (!LocationUtil.isBlockUnsafe(ess, location.getWorld(), location.getBlockX(), y, location.getBlockZ())) {
 final World world = location.getWorld();
 for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(world); ++y) {
 if (Material.BEDROCK.equals(world.getBlockAt(location.getBlockX(), y, location.getBlockZ()).getType())) {
 break;
 }
 if (!LocationUtil.isBlockUnsafe(ess, world, location.getBlockX(), y, location.getBlockZ())) {
 return y;
 }
 }
 return -1;
 return Double.MIN_VALUE;
 }

 private boolean isValidRandomLocation(final Location location) {
Expand DownExpand Up@@ -226,6 +258,10 @@ private boolean isExcludedBiome(final Location location) {
 return excluded.contains(biomeKey);
 }

 private String locationKey(final String name, final String key) {
 return "locations." + name + "." + key;
 }

 public File getFile() {
 return config.getFile();
 }
Expand Down

10 changes: 10 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/Settings.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ public boolean getRespawnAtHome() {
 return config.getBoolean("respawn-at-home", false);
 }

 @Override
 public String getRandomSpawnLocation() {
 return config.getString("random-spawn-location", "none");
 }

 @Override
 public String getRandomRespawnLocation() {
 return config.getString("random-respawn-location", "none");
 }

 @Override
 public boolean isRespawnAtAnchor() {
 return config.getBoolean("respawn-at-anchor", false);
Expand Down

3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/Warps.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,6 @@
import com.earth2me.essentials.utils.AdventureUtil;
import com.earth2me.essentials.utils.StringUtil;
import net.ess3.api.InvalidNameException;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import org.bukkit.Location;

Expand DownExpand Up@@ -54,7 +53,7 @@ public Collection<String> getList() {
 }

 @Override
 public Location getWarp(final String warp) throws WarpNotFoundException, InvalidWorldException {
 public Location getWarp(final String warp) throws WarpNotFoundException {
 final EssentialsConfiguration conf = warpPoints.get(new StringIgnoreCase(warp));
 if (conf == null) {
 throw new WarpNotFoundException();
Expand Down

3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/api/IWarps.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,8 @@ public interface IWarps extends IConf {
 * @param warp - Warp name
 * @return - Location the warp is set to
 * @throws WarpNotFoundException When the warp is not found
 * @throws net.ess3.api.InvalidWorldException When the world the warp is in is not found
 */
 Location getWarp(String warp) throws WarpNotFoundException, net.ess3.api.InvalidWorldException;
 Location getWarp(String warp) throws WarpNotFoundException;

 /**
 * Checks if the provided name is a warp.
Expand Down

20 changes: 0 additions & 20 deletions
Essentials/src/main/java/com/earth2me/essentials/api/InvalidWorldException.java

View file


Open in desktop


This file was deleted.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Improvements to Random Teleport#4271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

JRoy
merged 20 commits into

from

Nov 24, 2024
 Merged


Improvements to Random Teleport
#4271
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


20 commits


Select commit
Hold shift + click to select a range
be8bb92

Random teleport improvements


pop4959 Jun 25, 2021
7991c13

Merge


pop4959 Jul 5, 2021
6d3340e

Merge branch '2.x' into randomteleport-improvements


pop4959 Dec 11, 2021
e4e1bbb

Merge branch '2.x' of https://github.com/EssentialsX/Essentials into …


pop4959 Dec 28, 2021
26ff6ec

Merge branch '2.x' into randomteleport-improvements


pop4959 Feb 13, 2022
55fb0b2

Merge branch '2.x' into randomteleport-improvements


pop4959 May 17, 2022
36d1cf7

Merge branch '2.x' into randomteleport-improvements


pop4959 May 28, 2022
29597f2

Merge branch '2.x' into randomteleport-improvements


pop4959 Jun 4, 2022
51ab2af

Merge branch '2.x' into randomteleport-improvements


triagonal Jun 12, 2022
571fb8d

random spawn option


pop4959 Jul 2, 2022
f8f4002

avoid teleporting onto bedrock


pop4959 Jul 2, 2022
fbc5bc5

Merge branch '2.x' into randomteleport-improvements


pop4959 Jul 2, 2022
7e2b877

Merge branch '2.x' into randomteleport-improvements


JRoy Jul 5, 2022
eca91b2

Merge remote-tracking branch 'upstream/2.x' into fork/pop4959/randomt…


JRoy Nov 24, 2024
04defb1

fix compile issues


JRoy Nov 24, 2024
e9445c7

Move upgrades to EssentialsUpgrade


JRoy Nov 24, 2024
168ce3b

get rid of InvalidWorldException


JRoy Nov 24, 2024
20f66a8

Don't Reload RTP Config in /settpr


JRoy Nov 24, 2024
b9d9a24

Remove unused UserRandomTeleportEvent constructor


JRoy Nov 24, 2024
f8a659a

Merge branch '2.x' into randomteleport-improvements


JRoy Nov 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/AsyncTeleport.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@
import io.papermc.lib.PaperLib;
import net.ess3.api.IEssentials;
import net.ess3.api.IUser;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import net.ess3.api.events.UserWarpEvent;
import net.ess3.api.events.teleport.PreTeleportEvent;
Expand DownExpand Up@@ -424,7 +423,7 @@ public void warp(final IUser otherUser, String warp, final Trade chargeFor, fina
 final Location loc;
 try {
 loc = ess.getWarps().getWarp(warp);
 } catch (final WarpNotFoundException | InvalidWorldException e) {
 } catch (final WarpNotFoundException e) {
 future.completeExceptionally(e);
 return;
 }
Expand Down

11 changes: 4 additions & 7 deletions
Essentials/src/main/java/com/earth2me/essentials/Essentials.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -358,6 +358,10 @@ public void onEnable() {
 upgrade.convertKits();
 execTimer.mark("Kits");

 randomTeleport = new RandomTeleport(this);
 confList.add(randomTeleport);
 execTimer.mark("Init(RandomTeleport)");

 upgrade.afterSettings();
 execTimer.mark("Upgrade3");

Expand All@@ -373,13 +377,6 @@ public void onEnable() {
 confList.add(itemDb);
 execTimer.mark("Init(ItemDB)");

 randomTeleport = new RandomTeleport(this);
 if (randomTeleport.getPreCache()) {
 randomTeleport.cacheRandomLocations(randomTeleport.getCenter(), randomTeleport.getMinRange(), randomTeleport.getMaxRange());
 }
 confList.add(randomTeleport);
 execTimer.mark("Init(RandomTeleport)");

 customItemResolver = new CustomItemResolver(this);
 try {
 itemDb.registerResolver(this, "custom_items", customItemResolver);
Expand Down

35 changes: 35 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/EssentialsUpgrade.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.EssentialsUserConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.craftbukkit.BanLookup;
import com.earth2me.essentials.userstorage.ModernUUIDCache;
import com.earth2me.essentials.utils.AdventureUtil;
Expand DownExpand Up@@ -156,6 +157,39 @@ public static void uuidFileConvert(final IEssentials ess, final Boolean ignoreUF
 ess.getLogger().info("To rerun the conversion type /essentials uuidconvert");
 }

 public void updateRandomTeleport() {
 if (doneFile.getBoolean("updateRandomTeleport", false)) {
 return;
 }

 final EssentialsConfiguration config = ess.getRandomTeleport().getConfig();

 final LazyLocation center = config.getLocation("center");
 final Location centerLoc = center != null ? center.location() : null;
 if (center != null && centerLoc != null) {
 final double minRange = config.getDouble("min-range", Double.MIN_VALUE);
 final double maxRange = config.getDouble("max-range", Double.MIN_VALUE);
 for (final World world : ess.getServer().getWorlds()) {
 final String propPrefix = "locations." + world.getName() + ".";
 config.setProperty(propPrefix + "center", centerLoc);

 if (minRange != Double.MIN_VALUE) {
 config.setProperty(propPrefix + "min-range", minRange);
 }
 if (maxRange != Double.MIN_VALUE) {
 config.setProperty(propPrefix + "max-range", maxRange);
 }
 }
 }
 config.removeProperty("center");

 config.blockingSave();

 doneFile.setProperty("updateRandomTeleport", true);
 doneFile.save();
 ess.getLogger().info("Done converting random teleport config.");
 }

 public void convertMailList() {
 if (doneFile.getBoolean("updateUsersMailList", false)) {
 return;
Expand DownExpand Up@@ -1068,5 +1102,6 @@ public void afterSettings() {
 convertStupidCamelCaseUserdataKeys();
 convertMailList();
 purgeBrokenNpcAccounts();
 updateRandomTeleport();
 }
}

4 changes: 4 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/ISettings.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,10 @@ public interface ISettings extends IConf {

 boolean getRespawnAtHome();

 String getRandomSpawnLocation();

 String getRandomRespawnLocation();

 boolean isRespawnAtAnchor();

 Set getMultipleHomes();
Expand Down

124 changes: 80 additions & 44 deletions
Essentials/src/main/java/com/earth2me/essentials/RandomTeleport.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
package com.earth2me.essentials;

import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.utils.LocationUtil;
import com.earth2me.essentials.utils.VersionUtil;
import io.papermc.lib.PaperLib;
import net.ess3.api.InvalidWorldException;
import net.ess3.provider.BiomeKeyProvider;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.World;

import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import java.util.Random;
import java.util.Set;
Expand All@@ -23,58 +28,72 @@ public class RandomTeleport implements IConf {
 private static final int HIGHEST_BLOCK_Y_OFFSET = VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_15_R01) ? 1 : 0;
 private final IEssentials ess;
 private final EssentialsConfiguration config;
 private final ConcurrentLinkedQueue<Location> cachedLocations = new ConcurrentLinkedQueue<>();
 private final Map<String, ConcurrentLinkedQueue<Location>> cachedLocations = new HashMap<>();

 public RandomTeleport(final IEssentials essentials) {
 this.ess = essentials;
 config = new EssentialsConfiguration(new File(essentials.getDataFolder(), "tpr.yml"), "/tpr.yml",
 "Configuration for the random teleport command.\nSome settings may be defaulted, and can be changed via the /settpr command in-game.");
 "Configuration for the random teleport command.\nUse the /settpr command in-game to set random teleport locations.");
 reloadConfig();
 }

 public EssentialsConfiguration getConfig() {
 return config;
 }

 @Override
 public void reloadConfig() {
 config.load();
 cachedLocations.clear();
 }

 public Location getCenter() {
 try {
 final LazyLocation center = config.getLocation("center");
 if (center != null && center.location() != null) {
 return center.location();
 }
 } catch (final InvalidWorldException ignored) {
 public boolean hasLocation(final String name) {
 return config.hasProperty("locations." + name);
 }

 public Location getCenter(final String name) {
 final LazyLocation center = config.getLocation(locationKey(name, "center"));
 if (center != null && center.location() != null) {
 return center.location();
 }
 final Location center = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
 center.setY(center.getWorld().getHighestBlockYAt(center) + HIGHEST_BLOCK_Y_OFFSET);
 setCenter(center);
 return center;

 final Location worldCenter = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
 worldCenter.setY(worldCenter.getWorld().getHighestBlockYAt(worldCenter) + HIGHEST_BLOCK_Y_OFFSET);
 setCenter(name, worldCenter);
 return worldCenter;
 }

 public void setCenter(final Location center) {
 config.setProperty("center", center);
 public void setCenter(final String name, final Location center) {
 config.setProperty(locationKey(name, "center"), center);
 config.save();
 }

 public double getMinRange() {
 return config.getDouble("min-range", 0d);
 public double getMinRange(final String name) {
 return config.getDouble(locationKey(name, "min-range"), 0d);
 }

 public void setMinRange(final double minRange) {
 config.setProperty("min-range", minRange);
 public void setMinRange(final String name, final double minRange) {
 config.setProperty(locationKey(name, "min-range"), minRange);
 config.save();
 }

 public double getMaxRange() {
 return config.getDouble("max-range", getCenter().getWorld().getWorldBorder().getSize() / 2);
 public double getMaxRange(final String name) {
 return config.getDouble(locationKey(name, "max-range"), getCenter(name).getWorld().getWorldBorder().getSize() / 2);
 }

 public void setMaxRange(final double maxRange) {
 config.setProperty("max-range", maxRange);
 public void setMaxRange(final String name, final double maxRange) {
 config.setProperty(locationKey(name, "max-range"), maxRange);
 config.save();
 }

 public String getDefaultLocation() {
 return config.getString("default-location", "{world}");
 }

 public boolean isPerLocationPermission() {
 return config.getBoolean("per-location-permission", false);
 }

 public Set<String> getExcludedBiomes() {
 final Set<String> excludedBiomes = new HashSet<>();
 for (final String key : config.getList("excluded-biomes", String.class)) {
Expand All@@ -91,39 +110,48 @@ public int getCacheThreshold() {
 return config.getInt("cache-threshold", 10);
 }

 public boolean getPreCache() {
 return config.getBoolean("pre-cache", false);
 public List<String> listLocations() {
 return new ArrayList<>(ConfigurateUtil.getKeys(config.getRootNode().node("locations")));
 }

 public Queue<Location> getCachedLocations() {
 return cachedLocations;
 public Queue<Location> getCachedLocations(final String name) {
 this.cachedLocations.computeIfAbsent(name, x -> new ConcurrentLinkedQueue<>());
 return cachedLocations.get(name);
 }

 // Get a random location; cached if possible. Otherwise on demand.
 public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
 final int findAttempts = this.getFindAttempts();
 final Queue<Location> cachedLocations = this.getCachedLocations();
 // Get a named random teleport location; cached if possible, otherwise on demand.
 public CompletableFuture<Location> getRandomLocation(final String name) {
 final Queue<Location> cached = this.getCachedLocations(name);
 // Try to build up the cache if it is below the threshold
 if (cachedLocations.size() < this.getCacheThreshold()) {
 cacheRandomLocations(center, minRange, maxRange);
 if (cached.size() < this.getCacheThreshold()) {
 cacheRandomLocations(name);
 }
 final CompletableFuture<Location> future = new CompletableFuture<>();
 // Return a random location immediately if one is available, otherwise try to find one now
 if (cachedLocations.isEmpty()) {
 if (cached.isEmpty()) {
 final int findAttempts = this.getFindAttempts();
 final Location center = this.getCenter(name);
 final double minRange = this.getMinRange(name);
 final double maxRange = this.getMaxRange(name);
 attemptRandomLocation(findAttempts, center, minRange, maxRange).thenAccept(future::complete);
 } else {
 future.complete(cachedLocations.poll());
 future.complete(cached.poll());
 }
 return future;
 }

 // Prompts caching random valid locations, up to a maximum number of attempts
 public void cacheRandomLocations(final Location center, final double minRange, final double maxRange) {
 // Get a random location with specific parameters (note: not cached).
 public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
 return attemptRandomLocation(this.getFindAttempts(), center, minRange, maxRange);
 }

 // Prompts caching random valid locations, up to a maximum number of attempts.
 public void cacheRandomLocations(final String name) {
 ess.getServer().getScheduler().scheduleSyncDelayedTask(ess, () -> {
 for (int i = 0; i < this.getFindAttempts(); ++i) {
 calculateRandomLocation(center, minRange, maxRange).thenAccept(location -> {
 calculateRandomLocation(getCenter(name), getMinRange(name), getMaxRange(name)).thenAccept(location -> {
 if (isValidRandomLocation(location)) {
 this.getCachedLocations().add(location);
 this.getCachedLocations(name).add(location);
 }
 });
 }
Expand DownExpand Up@@ -188,14 +216,18 @@ private CompletableFuture<Location> calculateRandomLocation(final Location cente
 return future;
 }

 // Returns an appropriate elevation for a given location in the nether, or -1 if none is found
 // Returns an appropriate elevation for a given location in the nether, or MIN_VALUE if none is found
 private double getNetherYAt(final Location location) {
 for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(location.getWorld()); ++y) {
 if (!LocationUtil.isBlockUnsafe(ess, location.getWorld(), location.getBlockX(), y, location.getBlockZ())) {
 final World world = location.getWorld();
 for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(world); ++y) {
 if (Material.BEDROCK.equals(world.getBlockAt(location.getBlockX(), y, location.getBlockZ()).getType())) {
 break;
 }
 if (!LocationUtil.isBlockUnsafe(ess, world, location.getBlockX(), y, location.getBlockZ())) {
 return y;
 }
 }
 return -1;
 return Double.MIN_VALUE;
 }

 private boolean isValidRandomLocation(final Location location) {
Expand DownExpand Up@@ -226,6 +258,10 @@ private boolean isExcludedBiome(final Location location) {
 return excluded.contains(biomeKey);
 }

 private String locationKey(final String name, final String key) {
 return "locations." + name + "." + key;
 }

 public File getFile() {
 return config.getFile();
 }
Expand Down

10 changes: 10 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/Settings.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ public boolean getRespawnAtHome() {
 return config.getBoolean("respawn-at-home", false);
 }

 @Override
 public String getRandomSpawnLocation() {
 return config.getString("random-spawn-location", "none");
 }

 @Override
 public String getRandomRespawnLocation() {
 return config.getString("random-respawn-location", "none");
 }

 @Override
 public boolean isRespawnAtAnchor() {
 return config.getBoolean("respawn-at-anchor", false);
Expand Down

3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/Warps.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,6 @@
import com.earth2me.essentials.utils.AdventureUtil;
import com.earth2me.essentials.utils.StringUtil;
import net.ess3.api.InvalidNameException;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import org.bukkit.Location;

Expand DownExpand Up@@ -54,7 +53,7 @@ public Collection<String> getList() {
 }

 @Override
 public Location getWarp(final String warp) throws WarpNotFoundException, InvalidWorldException {
 public Location getWarp(final String warp) throws WarpNotFoundException {
 final EssentialsConfiguration conf = warpPoints.get(new StringIgnoreCase(warp));
 if (conf == null) {
 throw new WarpNotFoundException();
Expand Down

3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/api/IWarps.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,8 @@ public interface IWarps extends IConf {
 * @param warp - Warp name
 * @return - Location the warp is set to
 * @throws WarpNotFoundException When the warp is not found
 * @throws net.ess3.api.InvalidWorldException When the world the warp is in is not found
 */
 Location getWarp(String warp) throws WarpNotFoundException, net.ess3.api.InvalidWorldException;
 Location getWarp(String warp) throws WarpNotFoundException;

 /**
 * Checks if the provided name is a warp.
Expand Down

20 changes: 0 additions & 20 deletions
Essentials/src/main/java/com/earth2me/essentials/api/InvalidWorldException.java

View file


Open in desktop


This file was deleted.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Improvements to Random Teleport#4271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

JRoy
merged 20 commits into

from

Nov 24, 2024
 Merged


Improvements to Random Teleport
#4271
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


20 commits


Select commit
Hold shift + click to select a range
be8bb92

Random teleport improvements


pop4959 Jun 25, 2021
7991c13

Merge


pop4959 Jul 5, 2021
6d3340e

Merge branch '2.x' into randomteleport-improvements


pop4959 Dec 11, 2021
e4e1bbb

Merge branch '2.x' of https://github.com/EssentialsX/Essentials into …


pop4959 Dec 28, 2021
26ff6ec

Merge branch '2.x' into randomteleport-improvements


pop4959 Feb 13, 2022
55fb0b2

Merge branch '2.x' into randomteleport-improvements


pop4959 May 17, 2022
36d1cf7

Merge branch '2.x' into randomteleport-improvements


pop4959 May 28, 2022
29597f2

Merge branch '2.x' into randomteleport-improvements


pop4959 Jun 4, 2022
51ab2af

Merge branch '2.x' into randomteleport-improvements


triagonal Jun 12, 2022
571fb8d

random spawn option


pop4959 Jul 2, 2022
f8f4002

avoid teleporting onto bedrock


pop4959 Jul 2, 2022
fbc5bc5

Merge branch '2.x' into randomteleport-improvements


pop4959 Jul 2, 2022
7e2b877

Merge branch '2.x' into randomteleport-improvements


JRoy Jul 5, 2022
eca91b2

Merge remote-tracking branch 'upstream/2.x' into fork/pop4959/randomt…


JRoy Nov 24, 2024
04defb1

fix compile issues


JRoy Nov 24, 2024
e9445c7

Move upgrades to EssentialsUpgrade


JRoy Nov 24, 2024
168ce3b

get rid of InvalidWorldException


JRoy Nov 24, 2024
20f66a8

Don't Reload RTP Config in /settpr


JRoy Nov 24, 2024
b9d9a24

Remove unused UserRandomTeleportEvent constructor


JRoy Nov 24, 2024
f8a659a

Merge branch '2.x' into randomteleport-improvements


JRoy Nov 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/AsyncTeleport.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@
import io.papermc.lib.PaperLib;
import net.ess3.api.IEssentials;
import net.ess3.api.IUser;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import net.ess3.api.events.UserWarpEvent;
import net.ess3.api.events.teleport.PreTeleportEvent;
Expand DownExpand Up@@ -424,7 +423,7 @@ public void warp(final IUser otherUser, String warp, final Trade chargeFor, fina
 final Location loc;
 try {
 loc = ess.getWarps().getWarp(warp);
 } catch (final WarpNotFoundException | InvalidWorldException e) {
 } catch (final WarpNotFoundException e) {
 future.completeExceptionally(e);
 return;
 }
Expand Down

11 changes: 4 additions & 7 deletions
Essentials/src/main/java/com/earth2me/essentials/Essentials.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -358,6 +358,10 @@ public void onEnable() {
 upgrade.convertKits();
 execTimer.mark("Kits");

 randomTeleport = new RandomTeleport(this);
 confList.add(randomTeleport);
 execTimer.mark("Init(RandomTeleport)");

 upgrade.afterSettings();
 execTimer.mark("Upgrade3");

Expand All@@ -373,13 +377,6 @@ public void onEnable() {
 confList.add(itemDb);
 execTimer.mark("Init(ItemDB)");

 randomTeleport = new RandomTeleport(this);
 if (randomTeleport.getPreCache()) {
 randomTeleport.cacheRandomLocations(randomTeleport.getCenter(), randomTeleport.getMinRange(), randomTeleport.getMaxRange());
 }
 confList.add(randomTeleport);
 execTimer.mark("Init(RandomTeleport)");

 customItemResolver = new CustomItemResolver(this);
 try {
 itemDb.registerResolver(this, "custom_items", customItemResolver);
Expand Down

35 changes: 35 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/EssentialsUpgrade.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.EssentialsUserConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.craftbukkit.BanLookup;
import com.earth2me.essentials.userstorage.ModernUUIDCache;
import com.earth2me.essentials.utils.AdventureUtil;
Expand DownExpand Up@@ -156,6 +157,39 @@ public static void uuidFileConvert(final IEssentials ess, final Boolean ignoreUF
 ess.getLogger().info("To rerun the conversion type /essentials uuidconvert");
 }

 public void updateRandomTeleport() {
 if (doneFile.getBoolean("updateRandomTeleport", false)) {
 return;
 }

 final EssentialsConfiguration config = ess.getRandomTeleport().getConfig();

 final LazyLocation center = config.getLocation("center");
 final Location centerLoc = center != null ? center.location() : null;
 if (center != null && centerLoc != null) {
 final double minRange = config.getDouble("min-range", Double.MIN_VALUE);
 final double maxRange = config.getDouble("max-range", Double.MIN_VALUE);
 for (final World world : ess.getServer().getWorlds()) {
 final String propPrefix = "locations." + world.getName() + ".";
 config.setProperty(propPrefix + "center", centerLoc);

 if (minRange != Double.MIN_VALUE) {
 config.setProperty(propPrefix + "min-range", minRange);
 }
 if (maxRange != Double.MIN_VALUE) {
 config.setProperty(propPrefix + "max-range", maxRange);
 }
 }
 }
 config.removeProperty("center");

 config.blockingSave();

 doneFile.setProperty("updateRandomTeleport", true);
 doneFile.save();
 ess.getLogger().info("Done converting random teleport config.");
 }

 public void convertMailList() {
 if (doneFile.getBoolean("updateUsersMailList", false)) {
 return;
Expand DownExpand Up@@ -1068,5 +1102,6 @@ public void afterSettings() {
 convertStupidCamelCaseUserdataKeys();
 convertMailList();
 purgeBrokenNpcAccounts();
 updateRandomTeleport();
 }
}

4 changes: 4 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/ISettings.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,10 @@ public interface ISettings extends IConf {

 boolean getRespawnAtHome();

 String getRandomSpawnLocation();

 String getRandomRespawnLocation();

 boolean isRespawnAtAnchor();

 Set getMultipleHomes();
Expand Down

124 changes: 80 additions & 44 deletions
Essentials/src/main/java/com/earth2me/essentials/RandomTeleport.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
package com.earth2me.essentials;

import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.utils.LocationUtil;
import com.earth2me.essentials.utils.VersionUtil;
import io.papermc.lib.PaperLib;
import net.ess3.api.InvalidWorldException;
import net.ess3.provider.BiomeKeyProvider;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.World;

import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import java.util.Random;
import java.util.Set;
Expand All@@ -23,58 +28,72 @@ public class RandomTeleport implements IConf {
 private static final int HIGHEST_BLOCK_Y_OFFSET = VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_15_R01) ? 1 : 0;
 private final IEssentials ess;
 private final EssentialsConfiguration config;
 private final ConcurrentLinkedQueue<Location> cachedLocations = new ConcurrentLinkedQueue<>();
 private final Map<String, ConcurrentLinkedQueue<Location>> cachedLocations = new HashMap<>();

 public RandomTeleport(final IEssentials essentials) {
 this.ess = essentials;
 config = new EssentialsConfiguration(new File(essentials.getDataFolder(), "tpr.yml"), "/tpr.yml",
 "Configuration for the random teleport command.\nSome settings may be defaulted, and can be changed via the /settpr command in-game.");
 "Configuration for the random teleport command.\nUse the /settpr command in-game to set random teleport locations.");
 reloadConfig();
 }

 public EssentialsConfiguration getConfig() {
 return config;
 }

 @Override
 public void reloadConfig() {
 config.load();
 cachedLocations.clear();
 }

 public Location getCenter() {
 try {
 final LazyLocation center = config.getLocation("center");
 if (center != null && center.location() != null) {
 return center.location();
 }
 } catch (final InvalidWorldException ignored) {
 public boolean hasLocation(final String name) {
 return config.hasProperty("locations." + name);
 }

 public Location getCenter(final String name) {
 final LazyLocation center = config.getLocation(locationKey(name, "center"));
 if (center != null && center.location() != null) {
 return center.location();
 }
 final Location center = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
 center.setY(center.getWorld().getHighestBlockYAt(center) + HIGHEST_BLOCK_Y_OFFSET);
 setCenter(center);
 return center;

 final Location worldCenter = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
 worldCenter.setY(worldCenter.getWorld().getHighestBlockYAt(worldCenter) + HIGHEST_BLOCK_Y_OFFSET);
 setCenter(name, worldCenter);
 return worldCenter;
 }

 public void setCenter(final Location center) {
 config.setProperty("center", center);
 public void setCenter(final String name, final Location center) {
 config.setProperty(locationKey(name, "center"), center);
 config.save();
 }

 public double getMinRange() {
 return config.getDouble("min-range", 0d);
 public double getMinRange(final String name) {
 return config.getDouble(locationKey(name, "min-range"), 0d);
 }

 public void setMinRange(final double minRange) {
 config.setProperty("min-range", minRange);
 public void setMinRange(final String name, final double minRange) {
 config.setProperty(locationKey(name, "min-range"), minRange);
 config.save();
 }

 public double getMaxRange() {
 return config.getDouble("max-range", getCenter().getWorld().getWorldBorder().getSize() / 2);
 public double getMaxRange(final String name) {
 return config.getDouble(locationKey(name, "max-range"), getCenter(name).getWorld().getWorldBorder().getSize() / 2);
 }

 public void setMaxRange(final double maxRange) {
 config.setProperty("max-range", maxRange);
 public void setMaxRange(final String name, final double maxRange) {
 config.setProperty(locationKey(name, "max-range"), maxRange);
 config.save();
 }

 public String getDefaultLocation() {
 return config.getString("default-location", "{world}");
 }

 public boolean isPerLocationPermission() {
 return config.getBoolean("per-location-permission", false);
 }

 public Set<String> getExcludedBiomes() {
 final Set<String> excludedBiomes = new HashSet<>();
 for (final String key : config.getList("excluded-biomes", String.class)) {
Expand All@@ -91,39 +110,48 @@ public int getCacheThreshold() {
 return config.getInt("cache-threshold", 10);
 }

 public boolean getPreCache() {
 return config.getBoolean("pre-cache", false);
 public List<String> listLocations() {
 return new ArrayList<>(ConfigurateUtil.getKeys(config.getRootNode().node("locations")));
 }

 public Queue<Location> getCachedLocations() {
 return cachedLocations;
 public Queue<Location> getCachedLocations(final String name) {
 this.cachedLocations.computeIfAbsent(name, x -> new ConcurrentLinkedQueue<>());
 return cachedLocations.get(name);
 }

 // Get a random location; cached if possible. Otherwise on demand.
 public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
 final int findAttempts = this.getFindAttempts();
 final Queue<Location> cachedLocations = this.getCachedLocations();
 // Get a named random teleport location; cached if possible, otherwise on demand.
 public CompletableFuture<Location> getRandomLocation(final String name) {
 final Queue<Location> cached = this.getCachedLocations(name);
 // Try to build up the cache if it is below the threshold
 if (cachedLocations.size() < this.getCacheThreshold()) {
 cacheRandomLocations(center, minRange, maxRange);
 if (cached.size() < this.getCacheThreshold()) {
 cacheRandomLocations(name);
 }
 final CompletableFuture<Location> future = new CompletableFuture<>();
 // Return a random location immediately if one is available, otherwise try to find one now
 if (cachedLocations.isEmpty()) {
 if (cached.isEmpty()) {
 final int findAttempts = this.getFindAttempts();
 final Location center = this.getCenter(name);
 final double minRange = this.getMinRange(name);
 final double maxRange = this.getMaxRange(name);
 attemptRandomLocation(findAttempts, center, minRange, maxRange).thenAccept(future::complete);
 } else {
 future.complete(cachedLocations.poll());
 future.complete(cached.poll());
 }
 return future;
 }

 // Prompts caching random valid locations, up to a maximum number of attempts
 public void cacheRandomLocations(final Location center, final double minRange, final double maxRange) {
 // Get a random location with specific parameters (note: not cached).
 public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
 return attemptRandomLocation(this.getFindAttempts(), center, minRange, maxRange);
 }

 // Prompts caching random valid locations, up to a maximum number of attempts.
 public void cacheRandomLocations(final String name) {
 ess.getServer().getScheduler().scheduleSyncDelayedTask(ess, () -> {
 for (int i = 0; i < this.getFindAttempts(); ++i) {
 calculateRandomLocation(center, minRange, maxRange).thenAccept(location -> {
 calculateRandomLocation(getCenter(name), getMinRange(name), getMaxRange(name)).thenAccept(location -> {
 if (isValidRandomLocation(location)) {
 this.getCachedLocations().add(location);
 this.getCachedLocations(name).add(location);
 }
 });
 }
Expand DownExpand Up@@ -188,14 +216,18 @@ private CompletableFuture<Location> calculateRandomLocation(final Location cente
 return future;
 }

 // Returns an appropriate elevation for a given location in the nether, or -1 if none is found
 // Returns an appropriate elevation for a given location in the nether, or MIN_VALUE if none is found
 private double getNetherYAt(final Location location) {
 for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(location.getWorld()); ++y) {
 if (!LocationUtil.isBlockUnsafe(ess, location.getWorld(), location.getBlockX(), y, location.getBlockZ())) {
 final World world = location.getWorld();
 for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(world); ++y) {
 if (Material.BEDROCK.equals(world.getBlockAt(location.getBlockX(), y, location.getBlockZ()).getType())) {
 break;
 }
 if (!LocationUtil.isBlockUnsafe(ess, world, location.getBlockX(), y, location.getBlockZ())) {
 return y;
 }
 }
 return -1;
 return Double.MIN_VALUE;
 }

 private boolean isValidRandomLocation(final Location location) {
Expand DownExpand Up@@ -226,6 +258,10 @@ private boolean isExcludedBiome(final Location location) {
 return excluded.contains(biomeKey);
 }

 private String locationKey(final String name, final String key) {
 return "locations." + name + "." + key;
 }

 public File getFile() {
 return config.getFile();
 }
Expand Down

10 changes: 10 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/Settings.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ public boolean getRespawnAtHome() {
 return config.getBoolean("respawn-at-home", false);
 }

 @Override
 public String getRandomSpawnLocation() {
 return config.getString("random-spawn-location", "none");
 }

 @Override
 public String getRandomRespawnLocation() {
 return config.getString("random-respawn-location", "none");
 }

 @Override
 public boolean isRespawnAtAnchor() {
 return config.getBoolean("respawn-at-anchor", false);
Expand Down

3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/Warps.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,6 @@
import com.earth2me.essentials.utils.AdventureUtil;
import com.earth2me.essentials.utils.StringUtil;
import net.ess3.api.InvalidNameException;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import org.bukkit.Location;

Expand DownExpand Up@@ -54,7 +53,7 @@ public Collection<String> getList() {
 }

 @Override
 public Location getWarp(final String warp) throws WarpNotFoundException, InvalidWorldException {
 public Location getWarp(final String warp) throws WarpNotFoundException {
 final EssentialsConfiguration conf = warpPoints.get(new StringIgnoreCase(warp));
 if (conf == null) {
 throw new WarpNotFoundException();
Expand Down

3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/api/IWarps.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,8 @@ public interface IWarps extends IConf {
 * @param warp - Warp name
 * @return - Location the warp is set to
 * @throws WarpNotFoundException When the warp is not found
 * @throws net.ess3.api.InvalidWorldException When the world the warp is in is not found
 */
 Location getWarp(String warp) throws WarpNotFoundException, net.ess3.api.InvalidWorldException;
 Location getWarp(String warp) throws WarpNotFoundException;

 /**
 * Checks if the provided name is a warp.
Expand Down

20 changes: 0 additions & 20 deletions
Essentials/src/main/java/com/earth2me/essentials/api/InvalidWorldException.java

View file


Open in desktop


This file was deleted.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Improvements to Random Teleport#4271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

JRoy
merged 20 commits into

from

Nov 24, 2024
 Merged


Improvements to Random Teleport
#4271
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


20 commits


Select commit
Hold shift + click to select a range
be8bb92

Random teleport improvements


pop4959 Jun 25, 2021
7991c13

Merge


pop4959 Jul 5, 2021
6d3340e

Merge branch '2.x' into randomteleport-improvements


pop4959 Dec 11, 2021
e4e1bbb

Merge branch '2.x' of https://github.com/EssentialsX/Essentials into …


pop4959 Dec 28, 2021
26ff6ec

Merge branch '2.x' into randomteleport-improvements


pop4959 Feb 13, 2022
55fb0b2

Merge branch '2.x' into randomteleport-improvements


pop4959 May 17, 2022
36d1cf7

Merge branch '2.x' into randomteleport-improvements


pop4959 May 28, 2022
29597f2

Merge branch '2.x' into randomteleport-improvements


pop4959 Jun 4, 2022
51ab2af

Merge branch '2.x' into randomteleport-improvements


triagonal Jun 12, 2022
571fb8d

random spawn option


pop4959 Jul 2, 2022
f8f4002

avoid teleporting onto bedrock


pop4959 Jul 2, 2022
fbc5bc5

Merge branch '2.x' into randomteleport-improvements


pop4959 Jul 2, 2022
7e2b877

Merge branch '2.x' into randomteleport-improvements


JRoy Jul 5, 2022
eca91b2

Merge remote-tracking branch 'upstream/2.x' into fork/pop4959/randomt…


JRoy Nov 24, 2024
04defb1

fix compile issues


JRoy Nov 24, 2024
e9445c7

Move upgrades to EssentialsUpgrade


JRoy Nov 24, 2024
168ce3b

get rid of InvalidWorldException


JRoy Nov 24, 2024
20f66a8

Don't Reload RTP Config in /settpr


JRoy Nov 24, 2024
b9d9a24

Remove unused UserRandomTeleportEvent constructor


JRoy Nov 24, 2024
f8a659a

Merge branch '2.x' into randomteleport-improvements


JRoy Nov 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/AsyncTeleport.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@
import io.papermc.lib.PaperLib;
import net.ess3.api.IEssentials;
import net.ess3.api.IUser;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import net.ess3.api.events.UserWarpEvent;
import net.ess3.api.events.teleport.PreTeleportEvent;
Expand DownExpand Up@@ -424,7 +423,7 @@ public void warp(final IUser otherUser, String warp, final Trade chargeFor, fina
 final Location loc;
 try {
 loc = ess.getWarps().getWarp(warp);
 } catch (final WarpNotFoundException | InvalidWorldException e) {
 } catch (final WarpNotFoundException e) {
 future.completeExceptionally(e);
 return;
 }
Expand Down

11 changes: 4 additions & 7 deletions
Essentials/src/main/java/com/earth2me/essentials/Essentials.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -358,6 +358,10 @@ public void onEnable() {
 upgrade.convertKits();
 execTimer.mark("Kits");

 randomTeleport = new RandomTeleport(this);
 confList.add(randomTeleport);
 execTimer.mark("Init(RandomTeleport)");

 upgrade.afterSettings();
 execTimer.mark("Upgrade3");

Expand All@@ -373,13 +377,6 @@ public void onEnable() {
 confList.add(itemDb);
 execTimer.mark("Init(ItemDB)");

 randomTeleport = new RandomTeleport(this);
 if (randomTeleport.getPreCache()) {
 randomTeleport.cacheRandomLocations(randomTeleport.getCenter(), randomTeleport.getMinRange(), randomTeleport.getMaxRange());
 }
 confList.add(randomTeleport);
 execTimer.mark("Init(RandomTeleport)");

 customItemResolver = new CustomItemResolver(this);
 try {
 itemDb.registerResolver(this, "custom_items", customItemResolver);
Expand Down

35 changes: 35 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/EssentialsUpgrade.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.EssentialsUserConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.craftbukkit.BanLookup;
import com.earth2me.essentials.userstorage.ModernUUIDCache;
import com.earth2me.essentials.utils.AdventureUtil;
Expand DownExpand Up@@ -156,6 +157,39 @@ public static void uuidFileConvert(final IEssentials ess, final Boolean ignoreUF
 ess.getLogger().info("To rerun the conversion type /essentials uuidconvert");
 }

 public void updateRandomTeleport() {
 if (doneFile.getBoolean("updateRandomTeleport", false)) {
 return;
 }

 final EssentialsConfiguration config = ess.getRandomTeleport().getConfig();

 final LazyLocation center = config.getLocation("center");
 final Location centerLoc = center != null ? center.location() : null;
 if (center != null && centerLoc != null) {
 final double minRange = config.getDouble("min-range", Double.MIN_VALUE);
 final double maxRange = config.getDouble("max-range", Double.MIN_VALUE);
 for (final World world : ess.getServer().getWorlds()) {
 final String propPrefix = "locations." + world.getName() + ".";
 config.setProperty(propPrefix + "center", centerLoc);

 if (minRange != Double.MIN_VALUE) {
 config.setProperty(propPrefix + "min-range", minRange);
 }
 if (maxRange != Double.MIN_VALUE) {
 config.setProperty(propPrefix + "max-range", maxRange);
 }
 }
 }
 config.removeProperty("center");

 config.blockingSave();

 doneFile.setProperty("updateRandomTeleport", true);
 doneFile.save();
 ess.getLogger().info("Done converting random teleport config.");
 }

 public void convertMailList() {
 if (doneFile.getBoolean("updateUsersMailList", false)) {
 return;
Expand DownExpand Up@@ -1068,5 +1102,6 @@ public void afterSettings() {
 convertStupidCamelCaseUserdataKeys();
 convertMailList();
 purgeBrokenNpcAccounts();
 updateRandomTeleport();
 }
}

4 changes: 4 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/ISettings.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,10 @@ public interface ISettings extends IConf {

 boolean getRespawnAtHome();

 String getRandomSpawnLocation();

 String getRandomRespawnLocation();

 boolean isRespawnAtAnchor();

 Set getMultipleHomes();
Expand Down

124 changes: 80 additions & 44 deletions
Essentials/src/main/java/com/earth2me/essentials/RandomTeleport.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
package com.earth2me.essentials;

import com.earth2me.essentials.config.ConfigurateUtil;
import com.earth2me.essentials.config.EssentialsConfiguration;
import com.earth2me.essentials.config.entities.LazyLocation;
import com.earth2me.essentials.utils.LocationUtil;
import com.earth2me.essentials.utils.VersionUtil;
import io.papermc.lib.PaperLib;
import net.ess3.api.InvalidWorldException;
import net.ess3.provider.BiomeKeyProvider;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.World;

import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import java.util.Random;
import java.util.Set;
Expand All@@ -23,58 +28,72 @@ public class RandomTeleport implements IConf {
 private static final int HIGHEST_BLOCK_Y_OFFSET = VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_15_R01) ? 1 : 0;
 private final IEssentials ess;
 private final EssentialsConfiguration config;
 private final ConcurrentLinkedQueue<Location> cachedLocations = new ConcurrentLinkedQueue<>();
 private final Map<String, ConcurrentLinkedQueue<Location>> cachedLocations = new HashMap<>();

 public RandomTeleport(final IEssentials essentials) {
 this.ess = essentials;
 config = new EssentialsConfiguration(new File(essentials.getDataFolder(), "tpr.yml"), "/tpr.yml",
 "Configuration for the random teleport command.\nSome settings may be defaulted, and can be changed via the /settpr command in-game.");
 "Configuration for the random teleport command.\nUse the /settpr command in-game to set random teleport locations.");
 reloadConfig();
 }

 public EssentialsConfiguration getConfig() {
 return config;
 }

 @Override
 public void reloadConfig() {
 config.load();
 cachedLocations.clear();
 }

 public Location getCenter() {
 try {
 final LazyLocation center = config.getLocation("center");
 if (center != null && center.location() != null) {
 return center.location();
 }
 } catch (final InvalidWorldException ignored) {
 public boolean hasLocation(final String name) {
 return config.hasProperty("locations." + name);
 }

 public Location getCenter(final String name) {
 final LazyLocation center = config.getLocation(locationKey(name, "center"));
 if (center != null && center.location() != null) {
 return center.location();
 }
 final Location center = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
 center.setY(center.getWorld().getHighestBlockYAt(center) + HIGHEST_BLOCK_Y_OFFSET);
 setCenter(center);
 return center;

 final Location worldCenter = ess.getServer().getWorlds().get(0).getWorldBorder().getCenter();
 worldCenter.setY(worldCenter.getWorld().getHighestBlockYAt(worldCenter) + HIGHEST_BLOCK_Y_OFFSET);
 setCenter(name, worldCenter);
 return worldCenter;
 }

 public void setCenter(final Location center) {
 config.setProperty("center", center);
 public void setCenter(final String name, final Location center) {
 config.setProperty(locationKey(name, "center"), center);
 config.save();
 }

 public double getMinRange() {
 return config.getDouble("min-range", 0d);
 public double getMinRange(final String name) {
 return config.getDouble(locationKey(name, "min-range"), 0d);
 }

 public void setMinRange(final double minRange) {
 config.setProperty("min-range", minRange);
 public void setMinRange(final String name, final double minRange) {
 config.setProperty(locationKey(name, "min-range"), minRange);
 config.save();
 }

 public double getMaxRange() {
 return config.getDouble("max-range", getCenter().getWorld().getWorldBorder().getSize() / 2);
 public double getMaxRange(final String name) {
 return config.getDouble(locationKey(name, "max-range"), getCenter(name).getWorld().getWorldBorder().getSize() / 2);
 }

 public void setMaxRange(final double maxRange) {
 config.setProperty("max-range", maxRange);
 public void setMaxRange(final String name, final double maxRange) {
 config.setProperty(locationKey(name, "max-range"), maxRange);
 config.save();
 }

 public String getDefaultLocation() {
 return config.getString("default-location", "{world}");
 }

 public boolean isPerLocationPermission() {
 return config.getBoolean("per-location-permission", false);
 }

 public Set<String> getExcludedBiomes() {
 final Set<String> excludedBiomes = new HashSet<>();
 for (final String key : config.getList("excluded-biomes", String.class)) {
Expand All@@ -91,39 +110,48 @@ public int getCacheThreshold() {
 return config.getInt("cache-threshold", 10);
 }

 public boolean getPreCache() {
 return config.getBoolean("pre-cache", false);
 public List<String> listLocations() {
 return new ArrayList<>(ConfigurateUtil.getKeys(config.getRootNode().node("locations")));
 }

 public Queue<Location> getCachedLocations() {
 return cachedLocations;
 public Queue<Location> getCachedLocations(final String name) {
 this.cachedLocations.computeIfAbsent(name, x -> new ConcurrentLinkedQueue<>());
 return cachedLocations.get(name);
 }

 // Get a random location; cached if possible. Otherwise on demand.
 public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
 final int findAttempts = this.getFindAttempts();
 final Queue<Location> cachedLocations = this.getCachedLocations();
 // Get a named random teleport location; cached if possible, otherwise on demand.
 public CompletableFuture<Location> getRandomLocation(final String name) {
 final Queue<Location> cached = this.getCachedLocations(name);
 // Try to build up the cache if it is below the threshold
 if (cachedLocations.size() < this.getCacheThreshold()) {
 cacheRandomLocations(center, minRange, maxRange);
 if (cached.size() < this.getCacheThreshold()) {
 cacheRandomLocations(name);
 }
 final CompletableFuture<Location> future = new CompletableFuture<>();
 // Return a random location immediately if one is available, otherwise try to find one now
 if (cachedLocations.isEmpty()) {
 if (cached.isEmpty()) {
 final int findAttempts = this.getFindAttempts();
 final Location center = this.getCenter(name);
 final double minRange = this.getMinRange(name);
 final double maxRange = this.getMaxRange(name);
 attemptRandomLocation(findAttempts, center, minRange, maxRange).thenAccept(future::complete);
 } else {
 future.complete(cachedLocations.poll());
 future.complete(cached.poll());
 }
 return future;
 }

 // Prompts caching random valid locations, up to a maximum number of attempts
 public void cacheRandomLocations(final Location center, final double minRange, final double maxRange) {
 // Get a random location with specific parameters (note: not cached).
 public CompletableFuture<Location> getRandomLocation(final Location center, final double minRange, final double maxRange) {
 return attemptRandomLocation(this.getFindAttempts(), center, minRange, maxRange);
 }

 // Prompts caching random valid locations, up to a maximum number of attempts.
 public void cacheRandomLocations(final String name) {
 ess.getServer().getScheduler().scheduleSyncDelayedTask(ess, () -> {
 for (int i = 0; i < this.getFindAttempts(); ++i) {
 calculateRandomLocation(center, minRange, maxRange).thenAccept(location -> {
 calculateRandomLocation(getCenter(name), getMinRange(name), getMaxRange(name)).thenAccept(location -> {
 if (isValidRandomLocation(location)) {
 this.getCachedLocations().add(location);
 this.getCachedLocations(name).add(location);
 }
 });
 }
Expand DownExpand Up@@ -188,14 +216,18 @@ private CompletableFuture<Location> calculateRandomLocation(final Location cente
 return future;
 }

 // Returns an appropriate elevation for a given location in the nether, or -1 if none is found
 // Returns an appropriate elevation for a given location in the nether, or MIN_VALUE if none is found
 private double getNetherYAt(final Location location) {
 for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(location.getWorld()); ++y) {
 if (!LocationUtil.isBlockUnsafe(ess, location.getWorld(), location.getBlockX(), y, location.getBlockZ())) {
 final World world = location.getWorld();
 for (int y = 32; y < ess.getWorldInfoProvider().getMaxHeight(world); ++y) {
 if (Material.BEDROCK.equals(world.getBlockAt(location.getBlockX(), y, location.getBlockZ()).getType())) {
 break;
 }
 if (!LocationUtil.isBlockUnsafe(ess, world, location.getBlockX(), y, location.getBlockZ())) {
 return y;
 }
 }
 return -1;
 return Double.MIN_VALUE;
 }

 private boolean isValidRandomLocation(final Location location) {
Expand DownExpand Up@@ -226,6 +258,10 @@ private boolean isExcludedBiome(final Location location) {
 return excluded.contains(biomeKey);
 }

 private String locationKey(final String name, final String key) {
 return "locations." + name + "." + key;
 }

 public File getFile() {
 return config.getFile();
 }
Expand Down

10 changes: 10 additions & 0 deletions
Essentials/src/main/java/com/earth2me/essentials/Settings.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ public boolean getRespawnAtHome() {
 return config.getBoolean("respawn-at-home", false);
 }

 @Override
 public String getRandomSpawnLocation() {
 return config.getString("random-spawn-location", "none");
 }

 @Override
 public String getRandomRespawnLocation() {
 return config.getString("random-respawn-location", "none");
 }

 @Override
 public boolean isRespawnAtAnchor() {
 return config.getBoolean("respawn-at-anchor", false);
Expand Down

3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/Warps.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,6 @@
import com.earth2me.essentials.utils.AdventureUtil;
import com.earth2me.essentials.utils.StringUtil;
import net.ess3.api.InvalidNameException;
import net.ess3.api.InvalidWorldException;
import net.ess3.api.TranslatableException;
import org.bukkit.Location;

Expand DownExpand Up@@ -54,7 +53,7 @@ public Collection<String> getList() {
 }

 @Override
 public Location getWarp(final String warp) throws WarpNotFoundException, InvalidWorldException {
 public Location getWarp(final String warp) throws WarpNotFoundException {
 final EssentialsConfiguration conf = warpPoints.get(new StringIgnoreCase(warp));
 if (conf == null) {
 throw new WarpNotFoundException();
Expand Down

3 changes: 1 addition & 2 deletions
Essentials/src/main/java/com/earth2me/essentials/api/IWarps.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,9 +22,8 @@ public interface IWarps extends IConf {
 * @param warp - Warp name
 * @return - Location the warp is set to
 * @throws WarpNotFoundException When the warp is not found
 * @throws net.ess3.api.InvalidWorldException When the world the warp is in is not found
 */
 Location getWarp(String warp) throws WarpNotFoundException, net.ess3.api.InvalidWorldException;
 Location getWarp(String warp) throws WarpNotFoundException;

 /**
 * Checks if the provided name is a warp.
Expand Down

20 changes: 0 additions & 20 deletions
Essentials/src/main/java/com/earth2me/essentials/api/InvalidWorldException.java

View file


Open in desktop


This file was deleted.

Loading