Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

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

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Returns

TMsg 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);
    }
}
class MyManager : NetworkManager
{
    void OnServerAddPlayerMessageInternal(NetworkMessage 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.