MxMessageΒΆ

class MxMessage : System.Object

The message class that represents a message being transferred over the Mx protocol.

uint RealtimeProtocol

Indicates the message is for the real time protocol.

uint ReliableProtocol

Indicates the message is for the reliable protocol.

uint Ack

Gets or sets the latest sequence number this packet is acknowledging.

Value:The latest sequence number this packet is acknowledging.
uint AckBitfield

Gets or sets the ack bitfield, which represents of the last 32 acks, which have been acknowledged.

Value:The ack bitfield, which represents of the last 32 acks, which have been acknowledged.
Protogame.MxPayload[] Payloads

Gets or sets the payloads for this message.

Value:The payloads associated with this message.
uint ProtocolID

Gets or sets the protocol ID.

Value:The protocol ID.
uint Sequence

Gets or sets the sequence number.

Value:The sequence number.
public bool DidAck(uint sequence)

Returns whether this message did acknowledge the specified sequence number.

Parameters:
  • sequence (uint) – The sequence number to check.
Returns:

Whether this message acknowledges the specified sequence number.
public System.Boolean[] GetAckBitfield()

Converts the bitfield into an array of T:System.Boolean.

Returns:The array of T:System.Boolean representing the acknowledgement status.
public bool HasAck(uint sequence)

Returns whether or not this message can acknowledge the specified sequence number. This will return false if the specified sequence number is more than 32 messages ago.

Parameters:
  • sequence (uint) – The sequence number to check.
Returns:

Whether this message can acknowledge the specified sequence number.
public void SetAckBitfield(System.Boolean[] received)

Sets the bitfield based on an input array of T:System.Boolean.

Parameters:
  • received (System.Boolean[]) – The array of T:System.Boolean representing the acknowledgement status.