Class PeerInfoMessage

Information about another participant in the same network game.

This information is cached by clients and used during host-migration.

Inheritance

object

MessageBase

PeerInfoMessage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

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 PeerInfoMessage : MessageBase

Fields

address

The IP address of the peer.

Declaration

public string address

Field Value

Type	Description
string

connectionId

The id of the NetworkConnection associated with the peer.

Declaration

public int connectionId

Field Value

Type	Description
int

isHost

True if this peer is the host of the network game.

Declaration

public bool isHost

Field Value

Type	Description
bool

isYou

True if the peer if the same as the current client.

Declaration

public bool isYou

Field Value

Type	Description
bool

playerIds

The players for this peer.

Declaration

public PeerInfoPlayer[] playerIds

Field Value

Type	Description
PeerInfoPlayer[]

port

The network port being used by the peer.

Declaration

public int port

Field Value

Type	Description
int

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

MessageBase.Deserialize(NetworkReader)

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

MessageBase.Serialize(NetworkWriter)

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()