The position (ordering index) of the role within the guild's role list.
Role
typeA guild role: colour, name and permissions.
Properties
6The full color set (primary / secondary / tertiary) of the role (JDA 6.x role colors).
The guild-wide permissions of the role, the ones set in the role settings of the guild (channel overrides are not included; see the allowed and denied discord permissions in a channel).
Set, add and remove change the role on Discord. Setting it to nothing (or deleting it) leaves the role with no permission at all; reset is not supported, since a role has no default to go back to.
The bot needs the 'manage roles' permission, a role below its own highest role, and every permission it gives: Discord refuses to grant a permission the bot does not have itself.
change modes
setaddremovedelete
The name of a Discord entity: a user's or member's account name, a guild's name, a role/channel name, a bot's define-name. Registered on Skript's native Property.NAME, so the idiomatic "name of %x%" works without colliding. For a member's server nickname or display name, use "effective name".
change modes
set
The color of a Discord entity: a role's color, an embed's side bar, or the color a role builder will be created with. Registered on Skript's native Property.COLOR (Skript 2.16), so "color of %x%" is the same expression that colors a block or a firework, dispatched per runtime type.
Write-only on a role builder and on an embed builder: JDA exposes no getter on either, so reading them gives <none>.
change modes
set
The guild a Discord entity belongs to: a member's, message's, role's, channel's, webhook's, sticker's, emoji's or scheduled event's guild. Co-owned across every such type, so "guild of %x%" works on any of them (null when the entity is not tied to a guild, e.g. a message from DMs).
Getters
1
Feeling lost? This is covered in the guide Getting entities by id
role with id %string% [(with|using) [the] [bot] %-bot%]
The role with the given id, looked up in cache.
Effects
4Moves a role directly above another one of the same guild. Indexes update automatically.
Moves a role down by a number of positions (one by default).
Moves a role directly below another one of the same guild. Indexes update automatically.
Moves a role up by a number of positions (one by default).
Conditions
2Whether the role is hoisted (shown separately in the member list).
Whether the role can be mentioned by anyone.
Returned by
12Syntaxes elsewhere in DiSky that return Role.
[the] exempt roles of %automodrule%AutoMod Rule[the] exempt roles of %automodrulebuilder%AutoMod Rule Builder[the] allowed roles of %emote%Emote[the] allowed roles of %emotebuilder%Emote Builder[the] boost role of %guild%Guild[the] bot role of %guild%Guild[the] everyone role of %guild%Guild[the] roles of %guild%Guild[the] roles of %member%Member[the] mentioned roles of %message%Messagerole with id %string% [(with|using) [the] [bot] %-bot%]Role[the] (build|built) result of [the] %roleaction%Role BuilderDocumentation
1Hand-written guides that cover Role.