Struct NetworkInstanceId
This is used to identify networked objects across all participants of a network. It is assigned at runtime by the server when an object is spawned.
Assembly: com.unity.multiplayer-hlapi.Runtime.dll
Syntax
[Serializable]
[Obsolete("The high level API classes are deprecated and will be removed in the future.")]
public struct NetworkInstanceId : IEquatable<NetworkInstanceId>
Constructors
NetworkInstanceId(uint)
Declaration
public NetworkInstanceId(uint value)
Parameters
| Type |
Name |
Description |
| uint |
value |
|
Fields
Invalid
A static invalid NetworkInstanceId that can be used for comparisons.
The default value of NetworkInstanceId.Value is zero, and IsEmpty() can be used to check this. But NetworkInstanceId.Invalid is available for specifically setting and checking for invalid IDs.
Declaration
public static NetworkInstanceId Invalid
Field Value
Properties
Value
The internal value of this identifier.
Declaration
public uint Value { get; }
Property Value
Methods
Equals(object)
Declaration
public override bool Equals(object obj)
Parameters
| Type |
Name |
Description |
| object |
obj |
|
Returns
Overrides
Equals(NetworkInstanceId)
Declaration
public bool Equals(NetworkInstanceId other)
Parameters
Returns
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
IsEmpty()
Returns true if the value of the NetworkInstanceId is zero.
Object that have not been spawned will have a value of zero.
Declaration
Returns
| Type |
Description |
| bool |
True if zero.
|
ToString()
Returns a string of "NetID:value".
Declaration
public override string ToString()
Returns
| Type |
Description |
| string |
String representation of this object.
|
Overrides
Operators
operator ==(NetworkInstanceId, NetworkInstanceId)
Declaration
public static bool operator ==(NetworkInstanceId c1, NetworkInstanceId c2)
Parameters
Returns
operator !=(NetworkInstanceId, NetworkInstanceId)
Declaration
public static bool operator !=(NetworkInstanceId c1, NetworkInstanceId c2)
Parameters
Returns
Implements