mirror of
https://github.com/IntellectualSites/PlotSquared.git
synced 2024-11-24 06:06:45 +01:00
docs: Unify WE, P2 and Fawe abbreviations (#3672)
This commit is contained in:
parent
bf646be482
commit
09cc59a1c1
@ -270,7 +270,7 @@ public final class BukkitPlatform extends JavaPlugin implements Listener, PlotPl
|
||||
|
||||
final PlotSquared plotSquared = new PlotSquared(this, "Bukkit");
|
||||
|
||||
// FAWE
|
||||
// FastAsyncWorldEdit
|
||||
if (Settings.FAWE_Components.FAWE_HOOK) {
|
||||
Plugin fawe = getServer().getPluginManager().getPlugin("FastAsyncWorldEdit");
|
||||
if (fawe != null) {
|
||||
@ -278,7 +278,7 @@ public final class BukkitPlatform extends JavaPlugin implements Listener, PlotPl
|
||||
Class.forName("com.fastasyncworldedit.bukkit.regions.plotsquared.FaweQueueCoordinator");
|
||||
faweHook = true;
|
||||
} catch (Exception ignored) {
|
||||
LOGGER.error("Incompatible version of FAWE to enable hook, please upgrade: https://ci.athion" +
|
||||
LOGGER.error("Incompatible version of FastAsyncWorldEdit to enable hook, please upgrade: https://ci.athion" +
|
||||
".net/job/FastAsyncWorldEdit/");
|
||||
}
|
||||
}
|
||||
@ -432,7 +432,7 @@ public final class BukkitPlatform extends JavaPlugin implements Listener, PlotPl
|
||||
|
||||
plotSquared.startExpiryTasks();
|
||||
|
||||
// Once the server has loaded force updating all generators known to P2
|
||||
// Once the server has loaded force updating all generators known to PlotSquared
|
||||
TaskManager.runTaskLater(() -> PlotSquared.platform().setupUtils().updateGenerators(true), TaskTime.ticks(1L));
|
||||
|
||||
// Services are accessed in order
|
||||
|
@ -110,7 +110,7 @@ public class GenChunk extends ScopedQueueCoordinator {
|
||||
/**
|
||||
* Set the world and XZ of the chunk being represented via {@link ChunkWrapper}
|
||||
*
|
||||
* @param wrap P2 ChunkWrapper
|
||||
* @param wrap PlotSquared ChunkWrapper
|
||||
*/
|
||||
public void setChunk(@NonNull ChunkWrapper wrap) {
|
||||
chunk = null;
|
||||
|
@ -359,9 +359,9 @@ public interface PlotPlatform<P> extends LocaleHolder {
|
||||
@NonNull String toLegacyPlatformString(@NonNull Component component);
|
||||
|
||||
/**
|
||||
* Returns if the FAWE-P2 hook is active/enabled
|
||||
* Returns if the FastAsyncWorldEdit-PlotSquared hook is active/enabled
|
||||
*
|
||||
* @return status of FAWE-P2 hook
|
||||
* @return status of FastAsyncWorldEdit-PlotSquared hook
|
||||
*/
|
||||
default boolean isFaweHooking() {
|
||||
return false;
|
||||
|
@ -1581,7 +1581,7 @@ public class PlotSquared {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get if the {@link PlatformReadyEvent} has been sent by WE. There is no way to query this within WE itself.
|
||||
* Get if the {@link PlatformReadyEvent} has been sent by WorldEdit. There is no way to query this within WorldEdit itself.
|
||||
*/
|
||||
public boolean isWeInitialised() {
|
||||
return weInitialised;
|
||||
|
@ -44,7 +44,7 @@ public class Settings extends Config {
|
||||
|
||||
@Comment("This value is not configurable. It shows the platform you are using.") // This is a comment
|
||||
@Final
|
||||
public static String PLATFORM; // These values are set from P2 before loading
|
||||
public static String PLATFORM; // These values are set from PlotSquared before loading
|
||||
|
||||
@Comment({"Show additional information in console. It helps us at IntellectualSites to find out more about an issue.",
|
||||
"Leave it off if you don't need it, it can spam your console."})
|
||||
@ -634,10 +634,10 @@ public class Settings extends Config {
|
||||
|
||||
}
|
||||
|
||||
@Comment("Enable or disable all of or parts of the FAWE-P2 hook")
|
||||
@Comment("Enable or disable all of or parts of the FastAsyncWorldEdit-PlotSquared hook")
|
||||
public static final class FAWE_Components {
|
||||
|
||||
@Comment("Use FAWE for queue handling.")
|
||||
@Comment("Use FastAsyncWorldEdit for queue handling.")
|
||||
public static boolean FAWE_HOOK = true;
|
||||
public static boolean CUBOIDS = true;
|
||||
public static boolean CLEAR = true;
|
||||
|
@ -1379,7 +1379,7 @@ public abstract class PlotArea {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the min height from which P2 will generate blocks. Inclusive.
|
||||
* Get the min height from which PlotSquared will generate blocks. Inclusive.
|
||||
*
|
||||
* @since 6.6.0
|
||||
*/
|
||||
@ -1388,7 +1388,7 @@ public abstract class PlotArea {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the max height to which P2 will generate blocks. Inclusive.
|
||||
* Get the max height to which PlotSquared will generate blocks. Inclusive.
|
||||
*
|
||||
* @since 6.6.0
|
||||
*/
|
||||
|
@ -44,7 +44,7 @@ public enum PlotAreaTerrainType {
|
||||
ORE,
|
||||
|
||||
/**
|
||||
* Generate everything using the vanilla generator but with PS roads.
|
||||
* Generate everything using the vanilla generator but with PlotSquared roads.
|
||||
*/
|
||||
ROAD,
|
||||
|
||||
|
@ -43,7 +43,7 @@ public abstract class ListFlag<V, F extends PlotFlag<List<V>, F>> extends PlotFl
|
||||
@Override
|
||||
public F merge(@NonNull List<V> newValue) {
|
||||
final List<V> mergedList = new ArrayList<>();
|
||||
// If a server already used PS before this fix, we remove all present duplicates on an eventual merge
|
||||
// If a server already used PlotSquared before this fix, we remove all present duplicates on an eventual merge
|
||||
for (final V v : getValue()) {
|
||||
if (!mergedList.contains(v)) {
|
||||
mergedList.add(v);
|
||||
|
@ -39,7 +39,7 @@ import org.checkerframework.checker.nullness.qual.Nullable;
|
||||
* Queue that is limited to a single chunk. It does not allow a delegate queue and should be treated as a cache for changes to
|
||||
* be set to. Does not support tile entities or entities.
|
||||
*
|
||||
* @deprecated This class is poorly designed and will no longer be used in P2
|
||||
* @deprecated This class is poorly designed and will no longer be used in PlotSquared
|
||||
*/
|
||||
@Deprecated(forRemoval = true, since = "6.8.0")
|
||||
public class ChunkQueueCoordinator extends ScopedQueueCoordinator {
|
||||
|
@ -174,7 +174,7 @@ public abstract class RegionManager {
|
||||
* @param whenDone task to run when complete
|
||||
* @param manager plot manager
|
||||
* @param actor the player running the clear
|
||||
* @return {@code true} if the clear worked. {@code false} if someone went wrong so P2 can then handle the clear
|
||||
* @return {@code true} if the clear worked. {@code false} if someone went wrong so PlotSquared can then handle the clear
|
||||
*/
|
||||
public abstract boolean handleClear(
|
||||
@NonNull Plot plot,
|
||||
|
@ -109,7 +109,7 @@ public class RegionUtil {
|
||||
return new Rectangle2D.Double(min.getX(), min.getZ(), max.getX(), max.getZ());
|
||||
}
|
||||
|
||||
// Because WE (not fawe) lack this for CuboidRegion
|
||||
// Because WorldEdit (not FastAsyncWorldEdit) lack this for CuboidRegion
|
||||
public static boolean intersects(CuboidRegion region, CuboidRegion other) {
|
||||
BlockVector3 regionMin = region.getMinimumPoint();
|
||||
BlockVector3 regionMax = region.getMaximumPoint();
|
||||
|
@ -167,7 +167,7 @@ public final class TabCompletions {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a list of completions corresponding to WorldEdit(/FAWE) patterns. This uses
|
||||
* Get a list of completions corresponding to WorldEdit(/FastAsyncWorldEdit) patterns. This uses
|
||||
* WorldEdit's pattern completer internally.
|
||||
*
|
||||
* @param input Command input
|
||||
|
Loading…
Reference in New Issue
Block a user