$onBanAdd

Triggered when a user gets banned from the server.

$onBanAdd[Channel ID] is a callback, which means it’s used in the command trigger (not the code). The command is ran when a user is banned from the server.

Syntax

$onBanAdd[Channel ID]

Parameters

  • Channel ID (Type: Snowflake || Flag: Required): The ID of the channel where the message should be sent to.

Example

  1. Create a command with $onBanAdd[Channel ID] as the trigger.

    🧙‍♂️ You must replace “Channel ID” with a valid channel ID or a server variable that holds the channel ID (See more here…)!

    example1

  2. Input your code/reply text.

    🧙‍♂️ You can use functions like $username, $authorID, $authorAvatar, $getBanReason[] here.

    example2

  3. Now you have a ban message! ✨

    User was struck with the ban hammer! User left.

Advanced

Per-Server $onBanAdd

Both free and premium users can use $onBanAdd[], and all users can put $getServerVar[] within $onBanAdd[]. However, non-premium users can not use $getServerVar[] outside of callbacks.
If you own a public bot and want to make it so multiple different servers can use $onBanAdd[] (e.g. set their own logging channel), follow these steps:

  1. Create a variable named “logs” and the value set to nothing.
    image

  2. Create a command for setting the logging channel, then put the following in your code:

    $nomention
$onlyAdmin[You need the admin permission to use that!]
$argsCheck[>1;Please mention a channel!]
Logging channel updated!
$setServerVar[logs;$mentionedChannels[1]]

    📝 Servers will need to setup the channel they want the ban message to send to (by running a command with the code above).

  3. Now replace $onBanAdd[Channel ID] in your command trigger, with $onBanAdd[$getServerVar[logs]] and you’re all set!