createMessageBuilder

Creates a message builder, which enables you to construct a message. The message is created as a byte array, can contain multiple data types.

Syntax

ogscript.createMessageBuilder ();

Parameters

N/A

Returns

Returns a MessageBuilder object used to build byte arrays (generally for creating network messages).

Example

In the following example, a variable named myMessage is created to contain message content created by a message builder. Then data of various data types are added to the message. The variable messageArray is defined to contain the message content as a byte array.

Tip: You can use the createMessageParser function to parse messages.

var myMessage = ogscript.createMessageBuilder();

myMessage.writeBoolean(true); myMessage.writeByte(255); myMessage.writeByte(255);

myMessage.writeShort(65535); myMessage.writeShort(65535); myMessage.writeChar('a'); myMessage.writeInt(65536); myMessage.writeLong(4294967296); myMessage.writeFloat(0.000001); myMessage.writeDouble(0.000002); myMessage.writeString('abcd');

myMessage.writeUTF('Hello World');//includes 2-byte length count

var messageArray = myMessage.toByteArray();