docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct PeerInfoPlayer

    A structure used to identify player object on other peers for host migration.

    Inherited Members
    ValueType.Equals(object)
    ValueType.GetHashCode()
    ValueType.ToString()
    object.Equals(object, object)
    object.GetType()
    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 struct PeerInfoPlayer

    Fields

    netId

    The networkId of the player object.

    Declaration
    public NetworkInstanceId netId
    Field Value
    Type Description
    NetworkInstanceId

    playerControllerId

    The playerControllerId of the player GameObject.

    The HLAPI treats players and clients as separate GameObjects. In most cases, there is a single player for each client, but in some situations (for example, when there are multiple controllers connected to a console system) there might be multiple player GameObjects for a single connection. When there are multiple players for a single connection, use the playerControllerId property to tell them apart. This is an identifier that is scoped to the connection, so that it maps to the id of the controller associated with the player on that client.

    Declaration
    public short playerControllerId
    Field Value
    Type Description
    short
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)