User
Defined in: src/types/User.ts:1
Properties
Section titled “Properties”
optionalafk:boolean
Defined in: src/types/User.ts:39
Whether the player is currently AFK.
alt:
boolean
Defined in: src/types/User.ts:42
Whether the player is an alt account.
bot:
boolean
Defined in: src/types/User.ts:45
Whether the player is a bot account.
displayName
Section titled “displayName”displayName:
string
Defined in: src/types/User.ts:33
The player’s name as it appears in chat. May differ from name.
group:
string
Defined in: src/types/User.ts:7
The rank of the player. Usually default, moderator, or admin, but
the server may send anything.
name:
string
Defined in: src/types/User.ts:36
The player’s Minecraft username.
pronouns
Section titled “pronouns”pronouns:
null|string
Defined in: src/types/User.ts:17
The pronouns set by the user by running /pronouns. This may be null
if the player has not set any preferred pronouns. Where reasonably possible, you should attempt to use the user’s
preferred pronouns, or avoid using pronouns entirely. If you are unable to do this, you should use the player’s
name instead.
Example
Section titled “Example”"she/her"supporter
Section titled “supporter”supporter:
number
Defined in: src/types/User.ts:52
The current public tier of the player’s supporter status. This will be 0 if the player is not a supporter or
has opted out of showing their supporter tag, 1 for a Tier 1 supporter, 2 for a Tier 2 supporter, and 3 for
a Tier 3 supporter.
type:
"ingame"
Defined in: src/types/User.ts:3
The type of user. For in-game events, this is always ingame.
uuid:
string
Defined in: src/types/User.ts:30
The UUID of the player, including hyphens.
world:
null|string
Defined in: src/types/User.ts:27
The world the player is in, or null if this information is not
available. It will be a Minecraft namespaced registry key, for example:
minecraft:overworld- The overworldminecraft:the_nether- The Netherminecraft:the_end- The End