Interface: PlayerRank
# Interface: PlayerRank
Describes the results from the getPlayerRank helper.
# Properties
# cleanName
cleanName:
string
Cleaned up version of the name.
# cleanPrefix
cleanPrefix:
string
The chat prefix without Minecraft formatting codes.
# colorCode
colorCode:
MinecraftFormatting
The Minecraft formatting color code of this rank.
# colorHex
colorHex:
MinecraftColorAsHex
The hex value of the color code.
# customPlusColor?
optionalcustomPlusColor:MinecraftFormatting
If they have a custom color for the pluses in their rank (++). Note: this can be set when the player isn't MVP++. If you want to use this value, be sure to check if the rank is SUPERSTAR (MVP++).
# customPlusColorHex?
optionalcustomPlusColorHex:MinecraftColorAsHex
Same as customPlusColor, but the hex version of the color.
# customRankColor?
optionalcustomRankColor:MinecraftFormatting
If they have a custom color for their rank. Note: this can be set when the player isn't MVP++. If you want to use this value, be sure to check if the rank is SUPERSTAR (MVP++).
# customRankColorHex?
optionalcustomRankColorHex:MinecraftColorAsHex
Same as customRankColor, but the hex version of the color.
# name
name:
string
Name of the rank as it appears in the data.
# prefix
prefix:
string
The chat prefix with Minecraft formatting codes.
# priority
priority:
number
The priority of this rank as it relates to other ranks.
# staff
staff:
boolean
Whether or not this is a staff only rank.