/triggerroles¶
Tip
This command requires the administrator
permission by default.
To learn how to change this, please check the faq command.
/triggerroles add¶
Adds role(s) to the list of roles that should trigger the removal of other roles.
A trigger role is a role that will cause other roles to be automatically removed. So when a user is assigned the trigger role, they will lose the roles that trigger role is configured to remove. Multiple roles can also be set as requirements for one or more roles to be removed, all of these roles will be required before the other role(s) are removed.
Example
One of the administrators ran the command: /triggerrole add role: @Unsubscribe roles_to_remove: @Cool Role @Awesome Role
A user is assigned the trigger role, in this case @Unsubscribe
, which would cause @Cool Role
and @Awesome Role
to be removed from them automatically.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
roles |
Transform[str, RoleTransformer]
|
Role(s) that should trigger the removal of other roles |
required |
roles_to_remove |
Transform[str, RoleTransformer]
|
The role(s) that should be removed when the user is assigned the trigger role. |
required |
/triggerroles remove¶
Removes role(s) from the list of roles that should trigger the removal of other roles.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
roles |
Transform[str, RoleTransformer]
|
The role(s) that should trigger the removal of other roles |
required |
roles_to_remove |
Transform[str, RoleTransformer]
|
The role(s) that should no longer be removed when the user is assigned the trigger role. |
required |