Class StringMessage

This is a utility class for simple network messages that contain only a string.

This example sends a message with the name of the scene.

using UnityEngine;
using UnityEngine.Networking;
using UnityEngine.Networking.NetworkSystem;

public class Test
{
void SendSceneName(string sceneName)
{
var msg = new StringMessage(sceneName);
NetworkServer.SendToAll(MsgType.Scene, msg);
}
}
Inheritance
object
MessageBase
StringMessage
Inherited Members
Namespace: UnityEngine.Networking.NetworkSystem
Assembly: com.unity.multiplayer-hlapi.Runtime.dll
Syntax
[Obsolete("The high level API classes are deprecated and will be removed in the future.")]
public class StringMessage : MessageBase

Constructors

StringMessage()

Declaration
public StringMessage()

StringMessage(string)

Declaration
public StringMessage(string v)
Parameters
Type Name Description
string v

Fields

value

The string that will be serialized.

Declaration
public string value
Field Value
Type Description
string

Methods

Deserialize(NetworkReader)

This method is used to populate a message object from a NetworkReader stream.

Developers may implement this method for precise control of serialization, but they do no have to. An implemenation of this method will be generated for derived classes.

Declaration
public override void Deserialize(NetworkReader reader)
Parameters
Type Name Description
NetworkReader reader

Stream to read from.
Overrides

Serialize(NetworkWriter)

The method is used to populate a NetworkWriter stream from a message object.

Developers may implement this method for precise control of serialization, but they do no have to. An implemenation of this method will be generated for derived classes.

Declaration
public override void Serialize(NetworkWriter writer)
Parameters
Type Name Description
NetworkWriter writer

Stream to write to.
Overrides