Skip to content

Commit

Permalink
discordtimeout command (#51)
Browse files Browse the repository at this point in the history
* Add `discordtimeout` command and related tag.

Also added forgotten default for `discordbancommand` + new switch syntax.

* Add `null` check if member is invalid.

* Make meta sound more correct.

* Meta optimization + another `discordban` optimization

Thanks to Funky on discord for suggesting the meta change (https://discord.com/channels/315163488085475337/1027064108056580106/1065251950268010567).
  • Loading branch information
BreadcrumbIsTaken committed Jan 19, 2023
1 parent 70fe5c6 commit 4097373
Show file tree
Hide file tree
Showing 4 changed files with 130 additions and 7 deletions.
Expand Up @@ -62,6 +62,7 @@ public void onEnable() {
DenizenCore.commandRegistry.registerCommand(DiscordMessageCommand.class);
DenizenCore.commandRegistry.registerCommand(DiscordModalCommand.class);
DenizenCore.commandRegistry.registerCommand(DiscordReactCommand.class);
DenizenCore.commandRegistry.registerCommand(DiscordTimeoutCommand.class);
// Events
ScriptEvent.registerScriptEvent(DiscordApplicationCommandScriptEvent.class);
ScriptEvent.registerScriptEvent(DiscordButtonClickedScriptEvent.class);
Expand Down
Expand Up @@ -71,7 +71,7 @@ public enum DiscordBanInstruction { ADD, REMOVE }

public static void autoExecute(ScriptEntry scriptEntry,
@ArgPrefixed @ArgName("id") DiscordBotTag bot,
@ArgName("instruction") DiscordBanInstruction instruction,
@ArgName("instruction") @ArgDefaultText("add") DiscordBanInstruction instruction,
@ArgPrefixed @ArgName("user") DiscordUserTag user,
@ArgPrefixed @ArgName("group") DiscordGroupTag group,
@ArgPrefixed @ArgDefaultNull @ArgName("reason") String reason,
Expand All @@ -84,18 +84,14 @@ public static void autoExecute(ScriptEntry scriptEntry,
Runnable runnable = () -> {
try {
switch (instruction) {
case ADD: {
case ADD -> {
AuditableRestAction<Void> banAction = guild.ban(userObj, deletionTimeframe.getSecondsAsInt(), TimeUnit.SECONDS);
if (reason != null) {
banAction.reason(reason);
}
banAction.queue();
break;
}
case REMOVE: {
guild.unban(userObj).queue();
break;
}
case REMOVE -> guild.unban(userObj).queue();
}
}
catch (Exception ex) {
Expand Down
@@ -0,0 +1,110 @@
package com.denizenscript.ddiscordbot.commands;

import com.denizenscript.ddiscordbot.DenizenDiscordBot;
import com.denizenscript.ddiscordbot.objects.DiscordBotTag;
import com.denizenscript.ddiscordbot.objects.DiscordGroupTag;
import com.denizenscript.ddiscordbot.objects.DiscordUserTag;
import com.denizenscript.denizencore.objects.core.DurationTag;
import com.denizenscript.denizencore.scripts.ScriptEntry;
import com.denizenscript.denizencore.scripts.commands.AbstractCommand;
import com.denizenscript.denizencore.scripts.commands.Holdable;
import com.denizenscript.denizencore.scripts.commands.generator.ArgDefaultNull;
import com.denizenscript.denizencore.scripts.commands.generator.ArgDefaultText;
import com.denizenscript.denizencore.scripts.commands.generator.ArgName;
import com.denizenscript.denizencore.scripts.commands.generator.ArgPrefixed;
import com.denizenscript.denizencore.utilities.debugging.Debug;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.Member;
import net.dv8tion.jda.api.requests.restaction.AuditableRestAction;
import org.bukkit.Bukkit;

import java.util.concurrent.TimeUnit;

public class DiscordTimeoutCommand extends AbstractCommand implements Holdable {

public DiscordTimeoutCommand() {
setName("discordtimeout");
setSyntax("discordtimeout [id:<id>] ({add}/remove) [user:<user>] [group:<group>] (reason:<reason>) (duration:<duration>/{60s})");
setRequiredArguments(3, 6);
isProcedural = false;
autoCompile();
}

// <--[command]
// @Name discordtimeout
// @Syntax discordtimeout [id:<id>] ({add}/remove) [user:<user>] [group:<group>] (reason:<reason>) (duration:<duration>/{60s})
// @Required 3
// @Maximum 6
// @Short Puts a user in timeout.
// @Plugin dDiscordBot
// @Guide https://guide.denizenscript.com/guides/expanding/ddiscordbot.html
// @Group external
//
// @Description
// Puts a user in timeout.
//
// To put a user in timeout, use the "add" argument. To remove the timeout, use the "remove" argument.
// The group is required for both "add" and "remove" arguments, but "reason" can only be used with "add".
// Reasons show up in the group's Audit Logs.
//
// The timeout duration defaults to 60 seconds. The duration cannot be greater than 28 days.
// This argument can only be used when putting a user in timeout using the "add" argument, although it is not required.
//
// The command should usually be ~waited for. See <@link language ~waitable>.
//
// @Tags
// <DiscordUserTag.is_timed_out[<group>]> returns if the user is timed out in a certain group.
//
// @Usage
// # Put a user in timeout.
// - ~discordtimeout id:my_bot add user:<[user]> group:<[group]>
//
// @Usage
// # Put a user in timeout for a duration of 3 hours with a reason.
// - ~discordtimeout id:my_bot add user:<[user]> group:<[group]> "reason:Was being troublesome!" duration:3h
//
// @Usage
// # Remove a user from timeout.
// - ~discordtimeout id:my_bot remove user:<[user]> group:<[group]>
// -->

public enum DiscordTimeoutInstruction { ADD, REMOVE }

public static void autoExecute(ScriptEntry scriptEntry,
@ArgName("id") @ArgPrefixed DiscordBotTag bot,
@ArgName("instruction") @ArgDefaultText("add") DiscordTimeoutInstruction instruction,
@ArgName("user") @ArgPrefixed DiscordUserTag user,
@ArgName("group") @ArgPrefixed DiscordGroupTag group,
@ArgName("reason") @ArgPrefixed @ArgDefaultNull String reason,
@ArgName("duration") @ArgPrefixed @ArgDefaultText("60s") DurationTag duration) {
if (group.bot == null) {
group = new DiscordGroupTag(bot.bot, group.guild_id);
}
Guild guild = group.getGuild();
Member member = guild.getMemberById(user.user_id);
if (member == null) {
Debug.echoError("Invalid user! Are they in the Discord Group?");
}
Runnable runnable = () -> {
try {
switch (instruction) {
case ADD -> {
AuditableRestAction<Void> timeoutAction = member.timeoutFor(duration.getSecondsAsInt(), TimeUnit.SECONDS);
if (reason != null) {
timeoutAction.reason(reason);
}
timeoutAction.queue();
}
case REMOVE -> member.removeTimeout().queue();
}
}
catch (Exception ex) {
Debug.echoError(scriptEntry, ex);
}
};
Bukkit.getScheduler().runTaskAsynchronously(DenizenDiscordBot.instance, () -> {
runnable.run();
scriptEntry.setFinished(true);
});
}
}
Expand Up @@ -444,6 +444,22 @@ public static void register() {
}
return new ElementTag(true);
});

// <--[tag]
// @attribute <DiscordUserTag.is_timed_out[<group>]>
// @returns ElementTag(boolean)
// @plugin dDiscordBot
// @description
// Returns whether the user is timed out in a certain group.
// -->
tagProcessor.registerTag(ElementTag.class, DiscordGroupTag.class, "is_timed_out", (attribute, object, group) -> {
Guild guild = group.getGuild();
Member member = guild.getMemberById(object.user_id);
if (member == null) {
Debug.echoError("Invalid user! Are they in the Discord Group?");
}
return new ElementTag(member.isTimedOut());
});
}

public static ObjectTagProcessor<DiscordUserTag> tagProcessor = new ObjectTagProcessor<>();
Expand Down

0 comments on commit 4097373

Please sign in to comment.