Package net.lucypoulton.squirtgun.discord.command

Class DiscordConditions

java.lang.Object
net.lucypoulton.squirtgun.discord.command.DiscordConditions
public class DiscordConditions extends Object
Predefined conditions for Discord commands.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static net.lucypoulton.squirtgun.command.condition.Condition<net.lucypoulton.squirtgun.platform.audience.PermissionHolder,​DiscordUser>
    DISCORD_USER
     
    static net.lucypoulton.squirtgun.command.condition.Condition<DiscordUser,​DiscordUser>
    NO_BOTS
    Only allows human users - no bot accounts.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DiscordConditions()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static net.lucypoulton.squirtgun.command.condition.Condition<DiscordUser,​DiscordUser>
    channels​(long... channelIds)
    Only allows the command to come from a specific set of channels.
    static net.lucypoulton.squirtgun.command.condition.Condition<DiscordUser,​DiscordUser>
    discordPermission​(net.dv8tion.jda.api.Permission permission)
    Only allows the command to come from a sender with a specific Discord permission.
    static net.lucypoulton.squirtgun.command.condition.Condition<DiscordUser,​DiscordUser>
    guilds​(long... guildIds)
    Only allows the command to come from a specific set of guilds.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • DISCORD_USER

      public static net.lucypoulton.squirtgun.command.condition.Condition<net.lucypoulton.squirtgun.platform.audience.PermissionHolder,​DiscordUser> DISCORD_USER

    • NO_BOTS

      public static net.lucypoulton.squirtgun.command.condition.Condition<DiscordUser,​DiscordUser> NO_BOTS
      Only allows human users - no bot accounts.

  • Constructor Details

    • DiscordConditions

      public DiscordConditions()

  • Method Details

    • channels

      public static net.lucypoulton.squirtgun.command.condition.Condition<DiscordUser,​DiscordUser> channels​(long... channelIds)
      Only allows the command to come from a specific set of channels.
      Parameters:
      channelIds - a list of channel IDs to accept commands from.

    • guilds

      public static net.lucypoulton.squirtgun.command.condition.Condition<DiscordUser,​DiscordUser> guilds​(long... guildIds)
      Only allows the command to come from a specific set of guilds.
      Parameters:
      guildIds - a list of guild IDs to accept commands from.

    • discordPermission

      public static net.lucypoulton.squirtgun.command.condition.Condition<DiscordUser,​DiscordUser> discordPermission​(net.dv8tion.jda.api.Permission permission)
      Only allows the command to come from a sender with a specific Discord permission.
      Parameters:
      permission - the permission to check for