Struct NetworkInstanceId | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    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.

    Inherited Members
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    Namespace: UnityEngine.Networking
    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
    System.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
    Type Description
    NetworkInstanceId

    Properties

    Value

    The internal value of this identifier.

    Declaration
    public uint Value { get; }
    Property Value
    Type Description
    System.UInt32

    Methods

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    System.Boolean
    Overrides
    System.ValueType.Equals(System.Object)

    Equals(NetworkInstanceId)

    Declaration
    public bool Equals(NetworkInstanceId other)
    Parameters
    Type Name Description
    NetworkInstanceId other
    Returns
    Type Description
    System.Boolean
    Implements
    System.IEquatable<T>.Equals(T)

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    System.ValueType.GetHashCode()

    IsEmpty()

    Returns true if the value of the NetworkInstanceId is zero.

    Object that have not been spawned will have a value of zero.

    Declaration
    public bool IsEmpty()
    Returns
    Type Description
    System.Boolean

    True if zero.

    ToString()

    Returns a string of "NetID:value".

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String

    String representation of this object.

    Overrides
    System.ValueType.ToString()

    Operators

    Equality(NetworkInstanceId, NetworkInstanceId)

    Declaration
    public static bool operator ==(NetworkInstanceId c1, NetworkInstanceId c2)
    Parameters
    Type Name Description
    NetworkInstanceId c1
    NetworkInstanceId c2
    Returns
    Type Description
    System.Boolean

    Inequality(NetworkInstanceId, NetworkInstanceId)

    Declaration
    public static bool operator !=(NetworkInstanceId c1, NetworkInstanceId c2)
    Parameters
    Type Name Description
    NetworkInstanceId c1
    NetworkInstanceId c2
    Returns
    Type Description
    System.Boolean
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023