Interface: PlayerRank


# Interface: PlayerRank

Describes the results from the getPlayerRank helper.

# Properties

# cleanName

cleanName: string

Cleaned up version of the name.

Defined in: helpers/PlayerRank.ts:37 (opens new window)


# cleanPrefix

cleanPrefix: string

The chat prefix without Minecraft formatting codes.

Defined in: helpers/PlayerRank.ts:45 (opens new window)


# colorCode

colorCode: MinecraftFormatting

The Minecraft formatting color code of this rank.

Defined in: helpers/PlayerRank.ts:49 (opens new window)


# colorHex

colorHex: MinecraftColorAsHex

The hex value of the color code.

Defined in: helpers/PlayerRank.ts:53 (opens new window)


# customPlusColor

Optional customPlusColor: 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++).

Defined in: helpers/PlayerRank.ts:67 (opens new window)


# customPlusColorHex

Optional customPlusColorHex: MinecraftColorAsHex

Same as customPlusColor, but the hex version of the color.

Defined in: helpers/PlayerRank.ts:71 (opens new window)


# customRankColor

Optional customRankColor: 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++).

Defined in: helpers/PlayerRank.ts:58 (opens new window)


# customRankColorHex

Optional customRankColorHex: MinecraftColorAsHex

Same as customRankColor, but the hex version of the color.

Defined in: helpers/PlayerRank.ts:62 (opens new window)


# name

name: string

Name of the rank as it appears in the data.

Defined in: helpers/PlayerRank.ts:33 (opens new window)


# prefix

prefix: string

The chat prefix with Minecraft formatting codes.

Defined in: helpers/PlayerRank.ts:41 (opens new window)


# priority

priority: number

The priority of this rank as it relates to other ranks.

Defined in: helpers/PlayerRank.ts:29 (opens new window)


# staff

staff: boolean

Whether or not this is a staff only rank.

Defined in: helpers/PlayerRank.ts:75 (opens new window)