Conditions

Just like actions, conditions are defined by an id and a set of args. Condition is a way to check if a certain condition is met before executing an action or something else. You can define conditions in script, custom commands, embeds, commands, and more.

- id: hasPermission
  args:
    value: "MANAGE_MESSAGES" # Permission ID or name
    invert: true # Optional

As shown in the example above, all conditions can include an optional invert argument:

- id: aboveMembers
  args:
    amount: 100
    invert: true # Optional

Setting invert: true will negate the condition, meaning it will only be true if the original condition is false.

Alternatively you can prefix the condition ID with ! to invert it. For example, !hasPermission is equivalent to hasPermission with invert: true.

Not Met Actions

If a condition is specific to an action (i.e., listed under that action's conditions: []), you can define not-met-actions. These are fallback actions executed when the condition is not met. Here's an example:

actions:
  - id: addReaction
    args:
      value: "✅"
    conditions:
      - id: hasPermission
        args:
          value: "MANAGE_MESSAGES"
        not-met-actions:
          - id: addReaction
            args:
              value: "❌"

In this example, if the user does not have the MANAGE_MESSAGES permission, the bot will react with ❌. Otherwise, it will react with ✅.

All Conditions

aboveMembers

Check if the amount of members in a guild is above a certain number.

- id: aboveMembers
  args:
    amount: 100

anyOf

Check if any of the conditions are true.

- id: anyOf
  args:
    conditions: 
      - id: aboveMembers
        args:
          amount: 100
      - id: bellowMembers
        args:
          amount: 50

atLeastOf

Check if at least a certain amount of conditions are true.

- id: atLeastOf
  args:
    amount: 2
    conditions: 
      - id: aboveMembers
        args:
          amount: 100
      - id: '!isBot'
      - id: 'isUser'
        args:
          value: "123456789012345678"

bellowMembers

Check if the amount of members in a guild is bellow a certain number.

- id: bellowMembers
  args:
    amount: 100

content

Check if a content of an action equals a certain text.

- id: content
  args:
    value: 
      - "Hello"
      - "World"
    ignore-case: true  # Optional
- id: content
  args:
    value: "Hello"

contentContains

Check if a content of an action contains a certain text.

- id: contentContains
  args:
    value: 
      - "Hello"
      - "World"
    ignore-case: true # Optional
- id: contentContains
  args:
    value: "Hello"

isExpressionTrue

Check if an expression is true.

- id: isExpressionTrue
  args:
    value: "%server_channels% >= 0"

hasPermission

Check if a user has a certain permission.

- id: hasPermission
  args:
    value: "MANAGE_MESSAGES" # Permission name
- id: hasPermission
  args:
    value: 
      - "MANAGE_MESSAGES" # Permission name
      - "MANAGE_CHANNELS" # Permission name

hasRole

Check if a user has a certain role.

- id: hasRole
  args:
    value: "Admin" # Role ID or name
    inherit: true # Optional
- id: hasRole
  args:
    value: 
      - "Admin" # Role ID or name
      - "Moderator" # Role ID or name

isBot

Check if a user is a bot.

- id: isBot

isUser

Check if a user is a certain user

- id: isUser
  args:
    value: "123456789012345678" # User ID
- id: isUser
  args:
    value: 
      - "123456789012345678" # User ID
      - "987654321098765432" # User ID

inChannel

Check if a message is in a certain channel or category.

- id: inChannel
  args:
    value: 
      - "123456789012345678" # Channel ID or name // Category ID or name
- id: inChannel
  args:
    value: "123456789012345678" # Channel ID or name // Category ID or name

inTicket

Check if a message is in a ticket. Requires Tickets plugin.

- id: inTicket

regex

Check if a content of an action matches a certain regex.

- id: regex
  args:
    value: "^[a-zA-Z0-9]+$" # Regex pattern

startsWith

Check if a content of an action starts with a certain text.

- id: startsWith
  args:
    value: 
      - "Hello"
      - "World"
    ignore-case: true # Optional
- id: startsWith
  args:
    value: "Hello"