Class Game.NetMessage
Network Message Sender class.
To sends messages to clients.
Data Structures
| .netMessageBeginOption | The Game.NetMessage:Begin options. |
Methods
| Game.NetMessage:Begin (dest, msg[, origin[, ent]]) | Marks the beginning of a client message. |
| Game.NetMessage:End () | Ends the message and sends the message. |
| Game.NetMessage:Clear () | Clears the message buffers to make them available to send another message. |
| Game.NetMessage:WriteByte (value) | Writes a byte to the buffer. |
| Game.NetMessage:WriteChar (value) | Writes a character to the buffer. |
| Game.NetMessage:WriteShort (value) | Writes a short to the buffer. |
| Game.NetMessage:WriteLong (value) | Writes a long to the buffer. |
| Game.NetMessage:WriteAngle (value) | Writes an angle to the buffer. |
| Game.NetMessage:WriteCoord (value) | Writes a coordinate to the buffer. |
| Game.NetMessage:WriteVector (value[, asVector=false]) | Writes a vector to the buffer. |
| Game.NetMessage:WriteString (value) | Writes a string to the buffer. |
| Game.NetMessage:WriteEntity (value) | Writes an entity index to the buffer. |
| Game.NetMessage:WriteFloat (value) | Writes a float to the buffer. |
| Game.NetMessage:WriteNumber (value) | Writes a lua_Number to the buffer. |
Data Structures
- .netMessageBeginOption
-
The Game.NetMessage:Begin options.
- destination Common.NetMessage.MSG The destination type.
- message Common.NetMessage.TYPE or Common.NetMessage The network message builder instance.
- position Common.Vector or table The message's position on map. (optional)
- player number or Game.Entity The player index receiving the message (0 = all players). (optional)
Methods
- Game.NetMessage:Begin (dest, msg[, origin[, ent]])
-
Marks the beginning of a client message.
Parameters:
- dest Common.NetMessage.MSG or .netMessageBeginOption The destination type. | Options table.
- msg
Common.NetMessage.TYPE or Common.NetMessage
The network message builder instance (Ignored if
destis a table). - origin
Common.Vector or table
The message's position on world (Ignored if
destis a table). (optional) - ent
number or Game.Entity
The player index receiving the message (0 = all players)(Ignored if
destis a table). (optional)
Returns:
-
Game.NetMessage
Returns this class for fluent interface.
See also:
- Game.NetMessage:End ()
-
Ends the message and sends the message.
Automatically clears the message buffers.
Returns:
-
Game.NetMessage
Returns this class for fluent interface.
See also:
- Game.NetMessage:Clear ()
-
Clears the message buffers to make them available to send another message.
Returns:
-
Game.NetMessage
Returns this class for fluent interface.
- Game.NetMessage:WriteByte (value)
-
Writes a byte to the buffer.
Parameters:
- value number An unsigned char value.
Returns:
-
Game.NetMessage
Returns this class for fluent interface.
- Game.NetMessage:WriteChar (value)
-
Writes a character to the buffer.
Parameters:
- value number or string A signed char value.
Returns:
-
Game.NetMessage
Returns this class for fluent interface.
- Game.NetMessage:WriteShort (value)
-
Writes a short to the buffer.
Parameters:
- value number A signed short value.
Returns:
-
Game.NetMessage
Returns this class for fluent interface.
- Game.NetMessage:WriteLong (value)
-
Writes a long to the buffer.
Parameters:
- value number A signed long value.
Returns:
-
Game.NetMessage
Returns this class for fluent interface.
- Game.NetMessage:WriteAngle (value)
-
Writes an angle to the buffer.
This is low-res angle.
Parameters:
- value number A float value.
Returns:
-
Game.NetMessage
Returns this class for fluent interface.
See also:
- Game.NetMessage:WriteCoord (value)
-
Writes a coordinate to the buffer.
Parameters:
- value number A float value.
Returns:
-
Game.NetMessage
Returns this class for fluent interface.
- Game.NetMessage:WriteVector (value[, asVector=false])
-
Writes a vector to the buffer.
Parameters:
- value Common.Vector or table A 3D vector table value.
- asVector bool Writes as vector value. (default false)
Returns:
-
Game.NetMessage
Returns this class for fluent interface.
- Game.NetMessage:WriteString (value)
-
Writes a string to the buffer.
Parameters:
- value number A string value.
Returns:
-
Game.NetMessage
Returns this class for fluent interface.
- Game.NetMessage:WriteEntity (value)
-
Writes an entity index to the buffer.
Parameters:
- value number or Game.Entity An entity index.
Returns:
-
Game.NetMessage
Returns this class for fluent interface.
- Game.NetMessage:WriteFloat (value)
-
Writes a float to the buffer.
Same as Game.NetMessage:WriteCoord.
Parameters:
- value number A float value.
Returns:
-
Game.NetMessage
Returns this class for fluent interface.
- Game.NetMessage:WriteNumber (value)
-
Writes a lua_Number to the buffer.
Parameters:
- value number A lua_Number value.
Returns:
-
Game.NetMessage
Returns this class for fluent interface.