Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

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

NetworkMessage.ReadMessage

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

Sumbission failed

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

Close

Cancel

Switch to Manual
public function ReadMessage(): TMsg;
public TMsg ReadMessage();

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.

Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961