improved switch meta in events

also typo fix for bungee in debug logs
DenizenScript · Nov 11, 2019 · e12f98a · e12f98a
1 parent b823a64
commit e12f98a
Show file tree

Hide file tree

Showing 130 changed files with 146 additions and 147 deletions.
diff --git a/...rc/main/java/com/denizenscript/denizen/paper/events/PlayerSpectatesEntityScriptEvent.java b/...rc/main/java/com/denizenscript/denizen/paper/events/PlayerSpectatesEntityScriptEvent.java
@@ -18,7 +18,7 @@ public class PlayerSpectatesEntityScriptEvent extends BukkitScriptEvent implemen
     //
     // @Regex ^on player spectates [^\s]+$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Plugin Paper
     //

diff --git a/...rc/main/java/com/denizenscript/denizen/paper/events/PlayerStopsSpectatingScriptEvent.java b/...rc/main/java/com/denizenscript/denizen/paper/events/PlayerStopsSpectatingScriptEvent.java
@@ -18,7 +18,7 @@ public class PlayerStopsSpectatingScriptEvent extends BukkitScriptEvent implemen
     //
     // @Regex ^on player stops spectating( [^\s]+)?$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Plugin Paper
     //

diff --git a/paper/src/main/java/com/denizenscript/denizen/paper/events/TNTPrimesScriptEvent.java b/paper/src/main/java/com/denizenscript/denizen/paper/events/TNTPrimesScriptEvent.java
@@ -21,7 +21,7 @@ public class TNTPrimesScriptEvent extends BukkitScriptEvent implements Listener
     //
     // @Regex ^on tnt primes$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Plugin Paper
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockBuiltScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockBuiltScriptEvent.java
@@ -24,7 +24,7 @@ public class BlockBuiltScriptEvent extends BukkitScriptEvent implements Listener
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockBurnsScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockBurnsScriptEvent.java
@@ -19,7 +19,7 @@ public class BlockBurnsScriptEvent extends BukkitScriptEvent implements Listener
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockDispensesScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockDispensesScriptEvent.java
@@ -25,7 +25,7 @@ public class BlockDispensesScriptEvent extends BukkitScriptEvent implements List
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockFadesScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockFadesScriptEvent.java
@@ -19,7 +19,7 @@ public class BlockFadesScriptEvent extends BukkitScriptEvent implements Listener
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockFallsScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockFallsScriptEvent.java
@@ -20,7 +20,7 @@ public class BlockFallsScriptEvent extends BukkitScriptEvent implements Listener
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockFormsScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockFormsScriptEvent.java
@@ -19,7 +19,7 @@ public class BlockFormsScriptEvent extends BukkitScriptEvent implements Listener
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockGrowsScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockGrowsScriptEvent.java
@@ -19,7 +19,7 @@ public class BlockGrowsScriptEvent extends BukkitScriptEvent implements Listener
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockIgnitesScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockIgnitesScriptEvent.java
@@ -21,8 +21,8 @@ public class BlockIgnitesScriptEvent extends BukkitScriptEvent implements Listen
     //
     // @Group Block
     //
-    // @Switch in <area>
-    // @Switch cause <cause>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
+    // @Switch cause:<cause> to only process the event when it came from a specified cause.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockPhysicsScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockPhysicsScriptEvent.java
@@ -21,7 +21,7 @@ public class BlockPhysicsScriptEvent extends BukkitScriptEvent implements Listen
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Warning This event may fire very rapidly.
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockSpreadsScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockSpreadsScriptEvent.java
@@ -19,7 +19,7 @@ public class BlockSpreadsScriptEvent extends BukkitScriptEvent implements Listen
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/BrewsScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/BrewsScriptEvent.java
@@ -18,7 +18,7 @@ public class BrewsScriptEvent extends BukkitScriptEvent implements Listener {
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/.../src/main/java/com/denizenscript/denizen/events/block/CauldronLevelChangeScriptEvent.java b/.../src/main/java/com/denizenscript/denizen/events/block/CauldronLevelChangeScriptEvent.java
@@ -21,8 +21,8 @@ public class CauldronLevelChangeScriptEvent extends BukkitScriptEvent implements
     //
     // @Group Block
     //
-    // @Switch in <area>
-    // @Switch cause <cause>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
+    // @Switch cause:<cause> to only process the event when it came from a specified cause.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/FurnaceBurnsItemScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/FurnaceBurnsItemScriptEvent.java
@@ -20,7 +20,7 @@ public class FurnaceBurnsItemScriptEvent extends BukkitScriptEvent implements Li
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/...in/src/main/java/com/denizenscript/denizen/events/block/FurnaceSmeltsItemScriptEvent.java b/...in/src/main/java/com/denizenscript/denizen/events/block/FurnaceSmeltsItemScriptEvent.java
@@ -21,7 +21,7 @@ public class FurnaceSmeltsItemScriptEvent extends BukkitScriptEvent implements L
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Triggers when a furnace smelts an item.
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/LeafDecaysScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/LeafDecaysScriptEvent.java
@@ -17,7 +17,7 @@ public class LeafDecaysScriptEvent extends BukkitScriptEvent implements Listener
     //
     // @Regex ^on [^\s]+ decay$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/LiquidSpreadScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/LiquidSpreadScriptEvent.java
@@ -21,7 +21,7 @@ public class LiquidSpreadScriptEvent extends BukkitScriptEvent implements Listen
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/PistonExtendsScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/PistonExtendsScriptEvent.java
@@ -22,7 +22,7 @@ public class PistonExtendsScriptEvent extends BukkitScriptEvent implements Liste
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/PistonRetractsScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/PistonRetractsScriptEvent.java
@@ -22,7 +22,7 @@ public class PistonRetractsScriptEvent extends BukkitScriptEvent implements List
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/block/RedstoneScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/block/RedstoneScriptEvent.java
@@ -18,7 +18,7 @@ public class RedstoneScriptEvent extends BukkitScriptEvent implements Listener {
     //
     // @Group Block
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Warning This event fires very very rapidly!
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/entity/CreeperPoweredScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/entity/CreeperPoweredScriptEvent.java
@@ -18,7 +18,7 @@ public class CreeperPoweredScriptEvent extends BukkitScriptEvent implements List
     //
     // @Regex ^on creeper powered( because [^\s]+)?$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/...n/src/main/java/com/denizenscript/denizen/events/entity/DragonPhaseChangeScriptEvent.java b/...n/src/main/java/com/denizenscript/denizen/events/entity/DragonPhaseChangeScriptEvent.java
@@ -22,9 +22,9 @@ public class DragonPhaseChangeScriptEvent extends BukkitScriptEvent implements L
     //
     // @Regex ^on [^\s]+ changes phase$
     //
-    // @Switch in <area>
-    // @Switch from <phase>
-    // @Switch to <phase>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
+    // @Switch from:<phase> to only process the event if the dragon was previously in the specified phase.
+    // @Switch to:<phase> to only process the event if the dragon is changing to the specified phase.
     //
     // @Cancellable true
     //

diff --git a/...rc/main/java/com/denizenscript/denizen/events/entity/EntityAirLevelChangeScriptEvent.java b/...rc/main/java/com/denizenscript/denizen/events/entity/EntityAirLevelChangeScriptEvent.java
@@ -21,7 +21,7 @@ public class EntityAirLevelChangeScriptEvent extends BukkitScriptEvent implement
     //
     // @Regex ^on [^\s]+ changes air level$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/...src/main/java/com/denizenscript/denizen/events/entity/EntityBreaksHangingScriptEvent.java b/...src/main/java/com/denizenscript/denizen/events/entity/EntityBreaksHangingScriptEvent.java
@@ -25,7 +25,7 @@ public class EntityBreaksHangingScriptEvent extends BukkitScriptEvent implements
     //
     // @Regex ^on [^\s]+ breaks [^\s]+( because [^\s]+)?$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityBreedScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityBreedScriptEvent.java
@@ -23,7 +23,7 @@ public class EntityBreedScriptEvent extends BukkitScriptEvent implements Listene
     //
     // @Regex ^on [^\s]+ breeds$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/.../src/main/java/com/denizenscript/denizen/events/entity/EntityChangesBlockScriptEvent.java b/.../src/main/java/com/denizenscript/denizen/events/entity/EntityChangesBlockScriptEvent.java
@@ -26,7 +26,7 @@ public class EntityChangesBlockScriptEvent extends BukkitScriptEvent implements
     //
     // @Regex ^on [^\s]+ changes [^\s]+( into [^\s]+)?$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityCombustsScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityCombustsScriptEvent.java
@@ -26,7 +26,7 @@ public class EntityCombustsScriptEvent extends BukkitScriptEvent implements List
     //
     // @Regex ^on [^\s]+ combusts$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/.../src/main/java/com/denizenscript/denizen/events/entity/EntityCreatePortalScriptEvent.java b/.../src/main/java/com/denizenscript/denizen/events/entity/EntityCreatePortalScriptEvent.java
@@ -22,7 +22,7 @@ public class EntityCreatePortalScriptEvent extends BukkitScriptEvent implements
     //
     // @Regex ^on [^\s]+ creates portal$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityDamagedScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityDamagedScriptEvent.java
@@ -39,9 +39,9 @@ public class EntityDamagedScriptEvent extends BukkitScriptEvent implements Liste
     //
     // @Regex ^on [^\s]+ ((damages [^\s]+)|damaged( by [^\s]+)?)$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
-    // @Switch with <item>
+    // @Switch with:<item> to only process the event when the item used to cause damage (in the damager's hand) is a specified item.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityDeathScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityDeathScriptEvent.java
@@ -38,8 +38,8 @@ public class EntityDeathScriptEvent extends BukkitScriptEvent implements Listene
     //
     // @Regex ^on [^\s]+ (death|dies)$
     //
-    // @Switch in <area>
-    // @Switch by <entity type>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
+    // @Switch by:<entity type> to only process the event if the killer is of a specified entity type.
     //
     // @Triggers when an entity dies. Note that this fires *after* the entity dies, and thus some data may be lost from the entity.
     // The death cannot be cancelled, only the death message (for players).

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityDespawnScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityDespawnScriptEvent.java
@@ -18,11 +18,10 @@ public class EntityDespawnScriptEvent extends BukkitScriptEvent {
     //
     // @Regex ^on [^\s]+ despawns$
     //
-    // @Switch in <area>
-    //
     // @Warning this event fires very rapidly.
     //
-    // @Switch cause death|chunk_unload|other
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
+    // @Switch cause:<cause> to only process the event when it came from a specified cause.
     //
     // @Triggers when an entity despawns permanently from the world. May fire repeatedly for one entity.
     //

diff --git a/.../src/main/java/com/denizenscript/denizen/events/entity/EntityEntersPortalScriptEvent.java b/.../src/main/java/com/denizenscript/denizen/events/entity/EntityEntersPortalScriptEvent.java
@@ -21,7 +21,7 @@ public class EntityEntersPortalScriptEvent extends BukkitScriptEvent implements
     //
     // @Regex ^on [^\s]+ enters portal$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Triggers when an entity enters a portal.
     //

diff --git a/...src/main/java/com/denizenscript/denizen/events/entity/EntityEntersVehicleScriptEvent.java b/...src/main/java/com/denizenscript/denizen/events/entity/EntityEntersVehicleScriptEvent.java
@@ -22,7 +22,7 @@ public class EntityEntersVehicleScriptEvent extends BukkitScriptEvent implements
     //
     // @Regex ^on [^\s]+ enters [^\s]+$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/...n/src/main/java/com/denizenscript/denizen/events/entity/EntityExitsPortalScriptEvent.java b/...n/src/main/java/com/denizenscript/denizen/events/entity/EntityExitsPortalScriptEvent.java
@@ -21,7 +21,7 @@ public class EntityExitsPortalScriptEvent extends BukkitScriptEvent implements L
     //
     // @Regex ^on [^\s]+ exits portal$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Triggers when an entity exits a portal.
     //

diff --git a/.../src/main/java/com/denizenscript/denizen/events/entity/EntityExitsVehicleScriptEvent.java b/.../src/main/java/com/denizenscript/denizen/events/entity/EntityExitsVehicleScriptEvent.java
@@ -22,7 +22,7 @@ public class EntityExitsVehicleScriptEvent extends BukkitScriptEvent implements
     //
     // @Regex ^on [^\s]+ exits [^\s]+$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityExplodesScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityExplodesScriptEvent.java
@@ -26,7 +26,7 @@ public class EntityExplodesScriptEvent extends BukkitScriptEvent implements List
     //
     // @Regex ^on [^\s]+ explodes$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/...c/main/java/com/denizenscript/denizen/events/entity/EntityExplosionPrimesScriptEvent.java b/...c/main/java/com/denizenscript/denizen/events/entity/EntityExplosionPrimesScriptEvent.java
@@ -21,7 +21,7 @@ public class EntityExplosionPrimesScriptEvent extends BukkitScriptEvent implemen
     //
     // @Regex ^on [^\s]+ explosion primes$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/...c/main/java/com/denizenscript/denizen/events/entity/EntityFoodLevelChangeScriptEvent.java b/...c/main/java/com/denizenscript/denizen/events/entity/EntityFoodLevelChangeScriptEvent.java
@@ -21,7 +21,7 @@ public class EntityFoodLevelChangeScriptEvent extends BukkitScriptEvent implemen
     //
     // @Regex ^on [^\s]+ changes food level$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/...in/src/main/java/com/denizenscript/denizen/events/entity/EntityFormsBlockScriptEvent.java b/...in/src/main/java/com/denizenscript/denizen/events/entity/EntityFormsBlockScriptEvent.java
@@ -24,7 +24,7 @@ public class EntityFormsBlockScriptEvent extends BukkitScriptEvent implements Li
     //
     // @Regex ^on [^\s]+ forms [^\s]+$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //

diff --git a/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityGlideScriptEvent.java b/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityGlideScriptEvent.java
@@ -22,7 +22,7 @@ public class EntityGlideScriptEvent extends BukkitScriptEvent implements Listene
     //
     // @Regex ^on player (toggles|starts|stops) gliding$
     //
-    // @Switch in <area>
+    // @Switch in:<area> to only process the event if it occurred within a specified area.
     //
     // @Cancellable true
     //