Transfer

Transfers a player to another node. When a player is transferred from the node the hub will not send the Remove packet and there's no way, for the node, to know whether the player was disconnected or successfully transferred, if not using messages through a user-defined protocol.

class Transfer : Buffer {

enum ubyte ID;

enum bool CLIENTBOUND;

enum bool SERVERBOUND;

enum ubyte DISCONNECT;

enum ubyte AUTO;

enum ubyte RECONNECT;

enum string[] FIELDS;

this(uint hubId, uint node, ubyte onFail);

ubyte[] encode();

void decode();

static Transfer fromBuffer(ubyte[] buffer);

string toString();

}

Constructors

this this(): Undocumented in source.
this this(uint hubId, uint node, ubyte onFail): Undocumented in source.

Members

Functions

decode void decode(): Undocumented in source. Be warned that the author may not have intended to support it.
encode ubyte[] encode(): Undocumented in source. Be warned that the author may not have intended to support it.
toString string toString(): Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

fromBuffer Transfer fromBuffer(ubyte[] buffer): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

AUTO enum ubyte AUTO;: Undocumented in source.
CLIENTBOUND enum bool CLIENTBOUND;: Undocumented in source.
DISCONNECT enum ubyte DISCONNECT;: Undocumented in source.
FIELDS enum string[] FIELDS;: Undocumented in source.
ID enum ubyte ID;: Undocumented in source.
RECONNECT enum ubyte RECONNECT;: Undocumented in source.
SERVERBOUND enum bool SERVERBOUND;: Undocumented in source.
hubId uint hubId;: Undocumented in source.
node uint node;: Id of the node that player will be transferred to. It should be an id of a connected node (which can be calculated using AddNode and RemoveNode), otherwise the player will be disconnected or moved to another node (see the following field).
onFail ubyte onFail;: Indicates the action to be taken when a transfer fails because the indicated node is not connected anymore or it cannot accept the given player's game type or protocol. If the indicated node is full the player will be simply disconnected with the `Server Full` message.

Inherited Members

From Buffer

_buffer ubyte[] _buffer;: Undocumented in source.
_index size_t _index;: Undocumented in source.
bufferInstance Buffer bufferInstance [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
writeBytes void writeBytes(ubyte[] bytes): Undocumented in source. Be warned that the author may not have intended to support it.
writeString void writeString(string str): Undocumented in source. Be warned that the author may not have intended to support it.
readBytes ubyte[] readBytes(size_t length): Undocumented in source. Be warned that the author may not have intended to support it.
readString string readString(size_t length): Undocumented in source. Be warned that the author may not have intended to support it.
writeBigEndianBool void writeBigEndianBool(bool a): Undocumented in source. Be warned that the author may not have intended to support it.
readBigEndianBool bool readBigEndianBool(): Undocumented in source. Be warned that the author may not have intended to support it.
writeLittleEndianBool void writeLittleEndianBool(bool a): Undocumented in source. Be warned that the author may not have intended to support it.
readLittleEndianBool bool readLittleEndianBool(): Undocumented in source. Be warned that the author may not have intended to support it.
writeBigEndianByte void writeBigEndianByte(byte a): Undocumented in source. Be warned that the author may not have intended to support it.
readBigEndianByte byte readBigEndianByte(): Undocumented in source. Be warned that the author may not have intended to support it.
writeLittleEndianByte void writeLittleEndianByte(byte a): Undocumented in source. Be warned that the author may not have intended to support it.
readLittleEndianByte byte readLittleEndianByte(): Undocumented in source. Be warned that the author may not have intended to support it.
writeBigEndianUbyte void writeBigEndianUbyte(ubyte a): Undocumented in source. Be warned that the author may not have intended to support it.
readBigEndianUbyte ubyte readBigEndianUbyte(): Undocumented in source. Be warned that the author may not have intended to support it.
writeLittleEndianUbyte void writeLittleEndianUbyte(ubyte a): Undocumented in source. Be warned that the author may not have intended to support it.
readLittleEndianUbyte ubyte readLittleEndianUbyte(): Undocumented in source. Be warned that the author may not have intended to support it.
writeBigEndianShort void writeBigEndianShort(short a): Undocumented in source. Be warned that the author may not have intended to support it.
readBigEndianShort short readBigEndianShort(): Undocumented in source. Be warned that the author may not have intended to support it.
writeLittleEndianShort void writeLittleEndianShort(short a): Undocumented in source. Be warned that the author may not have intended to support it.
readLittleEndianShort short readLittleEndianShort(): Undocumented in source. Be warned that the author may not have intended to support it.
writeBigEndianUshort void writeBigEndianUshort(ushort a): Undocumented in source. Be warned that the author may not have intended to support it.
readBigEndianUshort ushort readBigEndianUshort(): Undocumented in source. Be warned that the author may not have intended to support it.
writeLittleEndianUshort void writeLittleEndianUshort(ushort a): Undocumented in source. Be warned that the author may not have intended to support it.
readLittleEndianUshort ushort readLittleEndianUshort(): Undocumented in source. Be warned that the author may not have intended to support it.
writeBigEndianTriad void writeBigEndianTriad(int a): Undocumented in source. Be warned that the author may not have intended to support it.
readBigEndianTriad int readBigEndianTriad(): Undocumented in source. Be warned that the author may not have intended to support it.
writeLittleEndianTriad void writeLittleEndianTriad(int a): Undocumented in source. Be warned that the author may not have intended to support it.
readLittleEndianTriad int readLittleEndianTriad(): Undocumented in source. Be warned that the author may not have intended to support it.
writeBigEndianInt void writeBigEndianInt(int a): Undocumented in source. Be warned that the author may not have intended to support it.
readBigEndianInt int readBigEndianInt(): Undocumented in source. Be warned that the author may not have intended to support it.
writeLittleEndianInt void writeLittleEndianInt(int a): Undocumented in source. Be warned that the author may not have intended to support it.
readLittleEndianInt int readLittleEndianInt(): Undocumented in source. Be warned that the author may not have intended to support it.
writeBigEndianUint void writeBigEndianUint(uint a): Undocumented in source. Be warned that the author may not have intended to support it.
readBigEndianUint uint readBigEndianUint(): Undocumented in source. Be warned that the author may not have intended to support it.
writeLittleEndianUint void writeLittleEndianUint(uint a): Undocumented in source. Be warned that the author may not have intended to support it.
readLittleEndianUint uint readLittleEndianUint(): Undocumented in source. Be warned that the author may not have intended to support it.
writeBigEndianLong void writeBigEndianLong(long a): Undocumented in source. Be warned that the author may not have intended to support it.
readBigEndianLong long readBigEndianLong(): Undocumented in source. Be warned that the author may not have intended to support it.
writeLittleEndianLong void writeLittleEndianLong(long a): Undocumented in source. Be warned that the author may not have intended to support it.
readLittleEndianLong long readLittleEndianLong(): Undocumented in source. Be warned that the author may not have intended to support it.
writeBigEndianUlong void writeBigEndianUlong(ulong a): Undocumented in source. Be warned that the author may not have intended to support it.
readBigEndianUlong ulong readBigEndianUlong(): Undocumented in source. Be warned that the author may not have intended to support it.
writeLittleEndianUlong void writeLittleEndianUlong(ulong a): Undocumented in source. Be warned that the author may not have intended to support it.
readLittleEndianUlong ulong readLittleEndianUlong(): Undocumented in source. Be warned that the author may not have intended to support it.
writeBigEndianFloat void writeBigEndianFloat(float a): Undocumented in source. Be warned that the author may not have intended to support it.
readBigEndianFloat float readBigEndianFloat(): Undocumented in source. Be warned that the author may not have intended to support it.
writeLittleEndianFloat void writeLittleEndianFloat(float a): Undocumented in source. Be warned that the author may not have intended to support it.
readLittleEndianFloat float readLittleEndianFloat(): Undocumented in source. Be warned that the author may not have intended to support it.
writeBigEndianDouble void writeBigEndianDouble(double a): Undocumented in source. Be warned that the author may not have intended to support it.
readBigEndianDouble double readBigEndianDouble(): Undocumented in source. Be warned that the author may not have intended to support it.
writeLittleEndianDouble void writeLittleEndianDouble(double a): Undocumented in source. Be warned that the author may not have intended to support it.
readLittleEndianDouble double readLittleEndianDouble(): Undocumented in source. Be warned that the author may not have intended to support it.