Actions

The actions are the main part of the bot. They are used to perform actions when a trigger is met. You can find more information about how to use them here.


All Actions

addCoins

Add coins to a user.

id: addCoins
args:
  amount: # Amount of coins to add

addInviteBonus

Add bonus invites to a user. Requires the Invite Traker addon.

id: addInviteBonus
args:
  amount: # Amount of bonus invites

addReaction

Add a reaction to a message. The reaction can be an emoji or a custom emoji.

id: addReaction
args:
  value: #Emoji or array of Emoji

addRole

Add a role to a member. The role can be a string or an array of strings.

id: addRole
args:
  value: # Role ID or name

deleteMessage

Delete a message.

id: deleteMessage

editMessage

Edit a message. You can see the message configuration for more information.

id: editMessage
args:
  # <messsage configuration>

metaAdd

Increase the value of a key in the meta data. Only works with number type.

id: metaAdd
args:
  key: # Key to add the value to
  value: # Value to add

metaListAdd

Add a value to a meta list. Only works with list type.

id: metaListAdd
args:
  key: # Key to add the value to
  value: # Value to add

metaListRemove

Remove a value from a meta list. Only works with list type.

id: metaListRemove
args:
  key: # Key to remove the value from
  value: # Value to remove

metaRemove

Remove a value from the meta data.

id: metaRemove
args:
  key: # Key to remove the value from

metaSet

Set a value to a key in the meta data.

id: metaSet
args:
  key: # Key to set the value to
  value: # Value to set

metaSubtract

Decrease the value of a key in the meta data. Only works with number type.

id: metaSubtract
args:
  key: # Key to subtract the value from
  value: # Value to subtract

metaToggle

Toggle a value in the meta data. Only works with boolean type.

id: metaToggle
args:
  key: # Key to toggle the value for

pinMessage

Pin a message.

id: pinMessage

randomAction

Run a random action from a list of actions. The actions can be defined in the actions array. If the actions array is empty, the action will do nothing.

id: randomAction
args:
  actions: # Array of actions to run

removeCoins

Remove coins from a user.

id: removeCoins
args:
  amount: # Amount of coins to remove

removeInviteBonus

Remove bonus invites to a user. Requires the Invite Traker addon.

id: removeInviteBonus
args:
  amount: # Amount of bonus invites

removeReaction

Remove a reaction from a message. The reaction can be an emoji or a custom emoji. If no value is provided, every reaction is removed.

id: removeReaction
args:
  value: # Emoji or array of Emoji, optional

removeRole

Remove a role from a member. The role can be a string or an array of strings.

id: removeRole
args:
  value: # Role ID or name, optional

reply

Reply to a message or an interaction. You can see the message configuration for more information. Can triggers actions

id: reply
args:
  # <message configuration>

resetCooldown

Reset a cooldown for a user.

id: resetCooldown
args:
  value: # Cooldown name

sendMessage

Send a message. You can see the message configuration for more information.

id: sendMessage
args:
  # <message configuration>

sendPrivateMessage

Send a private message to a user. You can see the message configuration for more information. If the user has private messages disabled, the message will not be sent.

id: sendPrivateMessage
args:
  # <message configuration>

sendRequest

Send a http request. New placeholders will be added when you trigger an action after this action. With the format %data_<object>%. If you want a value that is inside an object, you can add the path with underscore _. For example, if you want the value of user.id, you can use %data_user_id%. *Can triggers actions

- id: sendRequest
  args:
    value: 'https://api.example.com' # URL
    method: 'POST' # Method, optional. Default is GET
    headers: # Optional
      Content-Type: 'application/json' # Headers
    body: # Optional
      key: 'value' # Body

setCoins

Set the amount of coins for a user.

id: setCoins
args:
  amount: # Amount of coins to set

setCooldown

Set a cooldown for a user.

id: setCooldown
args:
  value: # Cooldown name
  duration: # Duration in seconds

setInviteBonus

Set bonus invites to a user. Requires the Invite Traker addon.

id: setInviteBonus
args:
  amount: # Amount of bonus invites

startThread

Start a thread. If the value is a array, a random value will be selected. *Can triggers actions

id: startThread
args:
  value: # String or array of strings, the thread name

timeoutMember

Timeout a member for a certain duration. The duration is in seconds.

id: timeoutMember
args:
  value: # User ID or mention
  duration: # Duration in seconds

unpinMessage

Unpin a message.

id: unpinMessage