improved switch meta in events

DenizenScript · Nov 11, 2019 · 5b21118 · 5b21118
1 parent 11009da
commit 5b21118
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 15 deletions.
diff --git a/src/main/java/com/denizenscript/ddiscordbot/events/DiscordMessageDeletedScriptEvent.java b/src/main/java/com/denizenscript/ddiscordbot/events/DiscordMessageDeletedScriptEvent.java
@@ -26,9 +26,9 @@ public class DiscordMessageDeletedScriptEvent extends DiscordScriptEvent {
     //
     // @Regex ^on discord message deleted$
     //
-    // @Switch for <bot>
-    // @Switch channel <channel_id>
-    // @Switch group <group_id>
+    // @Switch for:<bot> to only process the event for a specified Discord bot.
+    // @Switch channel:<channel_id> to only process the event when it occurs in a specified Discord channel.
+    // @Switch group:<group_id> to only process the event for a specified Discord group.
     //
     // @Triggers when a Discord user deletes a message.
     //

diff --git a/src/main/java/com/denizenscript/ddiscordbot/events/DiscordMessageModifiedScriptEvent.java b/src/main/java/com/denizenscript/ddiscordbot/events/DiscordMessageModifiedScriptEvent.java
@@ -25,9 +25,9 @@ public class DiscordMessageModifiedScriptEvent extends DiscordScriptEvent {
     //
     // @Regex ^on discord message modified$
     //
-    // @Switch for <bot>
-    // @Switch channel <channel_id>
-    // @Switch group <group_id>
+    // @Switch for:<bot> to only process the event for a specified Discord bot.
+    // @Switch channel:<channel_id> to only process the event when it occurs in a specified Discord channel.
+    // @Switch group:<group_id> to only process the event for a specified Discord group.
     //
     // @Triggers when a Discord user modified a message.
     //

diff --git a/src/main/java/com/denizenscript/ddiscordbot/events/DiscordMessageReceivedScriptEvent.java b/src/main/java/com/denizenscript/ddiscordbot/events/DiscordMessageReceivedScriptEvent.java
@@ -26,9 +26,9 @@ public class DiscordMessageReceivedScriptEvent extends DiscordScriptEvent {
     //
     // @Regex ^on discord message received$
     //
-    // @Switch for <bot>
-    // @Switch channel <channel_id>
-    // @Switch group <group_id>
+    // @Switch for:<bot> to only process the event for a specified Discord bot.
+    // @Switch channel:<channel_id> to only process the event when it occurs in a specified Discord channel.
+    // @Switch group:<group_id> to only process the event for a specified Discord group.
     //
     // @Triggers when a Discord bot receives a message.
     //

diff --git a/src/main/java/com/denizenscript/ddiscordbot/events/DiscordUserJoinsScriptEvent.java b/src/main/java/com/denizenscript/ddiscordbot/events/DiscordUserJoinsScriptEvent.java
@@ -20,8 +20,8 @@ public class DiscordUserJoinsScriptEvent extends DiscordScriptEvent {
     //
     // @Regex ^on discord user join$
     //
-    // @Switch for <bot>
-    // @Switch group <group_id>
+    // @Switch for:<bot> to only process the event for a specified Discord bot.
+    // @Switch group:<group_id> to only process the event for a specified Discord group.
     //
     // @Triggers when a Discord user joins a guild.
     //

diff --git a/src/main/java/com/denizenscript/ddiscordbot/events/DiscordUserLeavesScriptEvent.java b/src/main/java/com/denizenscript/ddiscordbot/events/DiscordUserLeavesScriptEvent.java
@@ -20,8 +20,8 @@ public class DiscordUserLeavesScriptEvent extends DiscordScriptEvent {
     //
     // @Regex ^on discord user leaves$
     //
-    // @Switch for <bot>
-    // @Switch group <group_id>
+    // @Switch for:<bot> to only process the event for a specified Discord bot.
+    // @Switch group:<group_id> to only process the event for a specified Discord group.
     //
     // @Triggers when a Discord user leaves a guild.
     //

diff --git a/src/main/java/com/denizenscript/ddiscordbot/events/DiscordUserRoleChangeScriptEvent.java b/src/main/java/com/denizenscript/ddiscordbot/events/DiscordUserRoleChangeScriptEvent.java
@@ -25,8 +25,8 @@ public class DiscordUserRoleChangeScriptEvent extends DiscordScriptEvent {
     //
     // @Regex ^on discord role changes$
     //
-    // @Switch for <bot>
-    // @Switch group <group_id>
+    // @Switch for:<bot> to only process the event for a specified Discord bot.
+    // @Switch group:<group_id> to only process the event for a specified Discord group.
     //
     // @Triggers when a Discord user's roles change.
     //