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.
Syntax
[Serializable]
[Obsolete("The high level API classes are deprecated and will be removed in the future.")]
public struct NetworkInstanceId : IEquatable<NetworkInstanceId>
Constructors
NetworkInstanceId(UInt32)
Declaration
public NetworkInstanceId(uint value)
Parameters
Type |
Name |
Description |
UInt32 |
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 |
Boolean |
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
Equality(NetworkInstanceId, NetworkInstanceId)
Declaration
public static bool operator ==(NetworkInstanceId c1, NetworkInstanceId c2)
Parameters
Returns
Inequality(NetworkInstanceId, NetworkInstanceId)
Declaration
public static bool operator !=(NetworkInstanceId c1, NetworkInstanceId c2)
Parameters
Returns
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.