Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

NetworkMessage.ReadMessage

Switch to Manual
public function ReadMessage(): MSG;

Returns

MSG The type of the Network Message, must be derived from MessageBase.

Description

ReadMessage is used to extract a typed network message from the NetworkReader of a NetworkMessage object.

For example in a handler for the AddPlayer message:

#pragma strict
class MyManager extends NetworkManager {
	function OnServerAddPlayerMessageInternal(netMsg) {
		var msg = netMsg.ReadMessage.<NetworkSystem.AddPlayerMessage>();
		OnServerAddPlayer(netMsg.conn, msg.playerControllerId);
	}
}

The AddPlayerMessage that is created will be populated by calling DeSerialize(). So when it is returned form ReadMessage it is ready to use.