$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
Field | Type | Description | Required |
---|---|---|---|
days | number | Number of days to count prune for (1-30, 7 default). | true |
guildID? | number | Where members are going to be pruned. | false |
roleIDs? | number, string | Roles to include, split by commas. | false |
dry? | boolean | 1. true 2. false (default) | false |
reason? | string | Reason to display in the guild’s audit logs. | false |
returnCount? | boolean | Return 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:
1client.command({2 name: "pruneMembers",3 code: `4 $pruneMembers[4;$guildID;$guildID;true;Pruning!;true]5 `6});