Skip to content

$pruneMembers

$pruneMembers will kick all inactive users whose been inactive for a given amount of time.

Usage

$pruneMembers[days;guildID?;roleIDs?;dry?;reason?;returnCount?]

Parameters

FieldTypeDescriptionRequired
daysnumberNumber of days to count prune for (1-30, 7 default).true
guildID?numberWhere members are going to be pruned.false
roleIDs?number, stringRoles to include, split by commas.false
dry?boolean1. true
2. false (default)
false
reason?stringReason to display in the guild’s audit logs.false
returnCount?booleanReturn count of pruned members.
1. true
2. false (default)
false

Example(s)

This will prune all members who have been inactive for 4 days and return the count of the pruned members that meet those requirements:

1
client.command({
2
name: "pruneMembers",
3
code: `
4
$pruneMembers[4;$guildID;$guildID;true;Pruning!;true]
5
`
6
});