Add

Adds a player to the node.

Members

Enums

FIRST_JOIN
anonymousenum FIRST_JOIN
Undocumented in source.
KEYBOARD
anonymousenum KEYBOARD
Undocumented in source.
USER
anonymousenum USER
Undocumented in source.

Mixins

__anonymous
mixin Make
Undocumented in source.

Structs

ServerAddress
struct ServerAddress
Undocumented in source.
Skin
struct Skin
Undocumented in source.

Variables

ID
enum ubyte ID;
Undocumented in source.
clientAddress
Address clientAddress;

Remote address of the player.

dimension
ubyte dimension;

Dimension in which the player was playing before being transferred in the MCPE format (0: overworld, 1: nether, 2: end). It shouldn't be considered if the client just joined the server instead of being transferred.

displayName
string displayName;

Display name of the player, which can contain formatting codes. By default it's equals to the username but it can be updated by the node using the UpdateDisplayName packet.

gameData
string gameData;

Additional JSON data.

gameName
string gameName;

Name of the game played by the client; for example Minecraft or Minecraft: Java Edition.

gameVersion
string gameVersion;

Version of the game used by the client, usually in the format major.minor.patch, calculated by the server or given by the client during the authentication process. The node should verify that the version exists and matches the protocol indicated in the protocol field.

hubId
uint hubId;

Player's unique id given by the hub.

inputMode
ubyte inputMode;

Client's input mode. May be a controller, a mouse/keyboard set or a touch screen.

language
string language;

Client's language, in the same format as HubInfo's language field, which should be updated from the node when the client changes it.

permissionLevel
ubyte permissionLevel;

Player's permission level that indicates its administration power. It's set to USER by default, which has no particular permission.

protocol
uint protocol;

Version of the protocol used by the client. Should be contained in the list given to the hub in the NodeInfo's acceptedGames field.

reason
ubyte reason;

Reason for which the player has been added to the node.

serverAddress
ServerAddress serverAddress;

Address used by the client to connect to the server. The value of this field is the address the client has saved in its servers list. For example a client that joins through localhost and a client that joins through 127.0.0.1 will connect to the same server with the same ip but the field of this value will be different (localhost for the first client and 127.0.0.1 for the latter).

skin
Skin skin;

Client's skin, given by the client or downloaded from Mojang's services in online mode.

transferMessage
ubyte[] transferMessage;

Optional data set by the Transfer packet if the player was transferred from another node. The content depends on the node's implementation or even by one of its plugins.

type
ubyte type;

Game used by the player, which could either be Minecraft: Java Edition or Minecraft (Bedrock Engine). It should be one of the keys given in NodeInfo's acceptedGames field.

username
string username;

Username of the player.

uuid
UUID uuid;

Client's UUID, given by Mojang's or Microsoft's services if the server is in online mode or given by the client (and not verified) if the server is in offline mode.

viewDistance
uint viewDistance;

Client's view distance (or chunk radius).

Mixed In Members

From mixin Make

__anonymous
mixin xpacket.maker.Make
Undocumented in source.
fromBuffer
typeof(this) fromBuffer(ubyte[] buffer)
Undocumented in source. Be warned that the author may not have intended to support it.

Meta