docs.unity3d.com
  • Manual
  • Scripting API
  • Changelog
  • License
    Show / Hide Table of Contents
    • Global Namespace
      • Netcode​Conversion​Target
      • Netcode​Transform​Usage​Flags​Test​Authoring
      • Netcode​Transform​Usage​Flags​Test​Authoring.​Baker
      • Test​Net​Code​Authoring
      • Test​Net​Code​Authoring.​IConverter
    • Unity.​Net​Code
      • Apply​Current​Input​Buffer​Element​To​Input​Data<TInput​Buffer​Data, TInput​Component​Data>
      • Apply​Current​Input​Buffer​Element​To​Input​Data<TInput​Buffer​Data, TInput​Component​Data>.​Apply​Input​Data​From​Buffer​Job
      • Auto​Command​Target
      • Batch​Predict​Attribute
      • Client​Only​Variant
      • Client​Populate​Prespawned​Ghosts​System
      • Client​Server​Bootstrap
      • Client​Server​Bootstrap.​Play​Type
      • Client​Server​Tick​Rate
      • Client​Server​Tick​Rate.​Frame​Rate​Mode
      • Client​Server​World​Extensions
      • Client​Tick​Rate
      • Client​Track​Loaded​Prespawn​Sections
      • Command​Data​Interpolation​Delay
      • Command​Data​Utility
      • Command​Receive​System<TCommand​Data​Serializer, TCommand​Data>
      • Command​Receive​System<TCommand​Data​Serializer, TCommand​Data>.​Receive​Job​Data
      • Command​Receive​System​Group
      • Command​Send​System<TCommand​Data​Serializer, TCommand​Data>
      • Command​Send​System<TCommand​Data​Serializer, TCommand​Data>.​Send​Job​Data
      • Command​Send​System​Group
      • Command​Target
      • Command​Target​Component
      • Compare​Command​System​Group
      • Component​Type​Serialization​Strategy
      • Component​Type​Serialization​Strategy.​Default​Type
      • Connection​State
      • Connection​State.​State
      • Convert​Prediction​Entry
      • Copy​Input​To​Command​Buffer<TInput​Buffer​Data, TInput​Component​Data>
      • Copy​Input​To​Command​Buffer<TInput​Buffer​Data, TInput​Component​Data>.​Copy​Input​To​Buffer​Job
      • Default​Driver​Builder
      • Default​Smoothing​Action​User​Params
      • Default​Smoothing​Action​User​Params​Authoring
      • Default​Translation​Smoothing​Action
      • Default​Translation​Smoothing​Action.​Default​Static​User​Params
      • Default​Variant​System​Base
      • Default​Variant​System​Base.​Rule
      • Default​Variant​System​Group
      • Disable​Automatic​Prespawn​Section​Reporting
      • Disable​Automatic​Prespawn​Section​Reporting​Authoring
      • Disconnect​Reason​Enum​To​String
      • Dont​Serialize​For​Command​Attribute
      • Dont​Serialize​Variant
      • Dont​Support​Prefab​Overrides​Attribute
      • Driver​Migration​System
      • Enable​Packet​Logging
      • Fixed​Step​Ghost​Prediction​System​Group
      • Game​Protocol​Version
      • Ghost​Authoring​Component
      • Ghost​Authoring​Inspection​Component
      • Ghost​Child​Entity
      • Ghost​Child​Entity​Component
      • Ghost​Collection
      • Ghost​Collection​Prefab
      • Ghost​Collection​Prefab.​Loading​State
      • Ghost​Collection​System
      • Ghost​Component
      • Ghost​Component​Attribute
      • Ghost​Component​Serializer​Collection​Data
      • Ghost​Component​Serializer​Collection​System​Group
      • Ghost​Component​Utilities
      • Ghost​Component​Variation​Attribute
      • Ghost​Connection​Position
      • Ghost​Count
      • Ghost​Delta​Predictor
      • Ghost​Deserializer​State
      • Ghost​Despawn​System
      • Ghost​Distance​Data
      • Ghost​Distance​Importance
      • Ghost​Distance​Partitioning​System
      • Ghost​Distance​Partition​Shared
      • Ghost​Enabled​Bit​Attribute
      • Ghost​Field​Attribute
      • Ghost​Field​Sub​Type
      • Ghost​Group
      • Ghost​Importance
      • Ghost​Importance.​Scale​Importance​Delegate
      • Ghost​Input​System​Group
      • Ghost​Instance
      • Ghost​Mode
      • Ghost​Mode​Mask
      • Ghost​Optimization​Mode
      • Ghost​Owner
      • Ghost​Owner​Component
      • Ghost​Owner​Is​Local
      • Ghost​Prediction​History​System
      • Ghost​Prediction​Smoothing
      • Ghost​Prediction​Smoothing.​Smoothing​Action​Delegate
      • Ghost​Prediction​Smoothing​System
      • Ghost​Prediction​Switching​Queues
      • Ghost​Prediction​Switching​System
      • Ghost​Prediction​System​Group
      • Ghost​Prefab​Creation
      • Ghost​Prefab​Creation.​Component
      • Ghost​Prefab​Creation.​Component​Override
      • Ghost​Prefab​Creation.​Component​Override​Type
      • Ghost​Prefab​Creation.​Config
      • Ghost​Prefab​Type
      • Ghost​Receive​System
      • Ghost​Relevancy
      • Ghost​Relevancy​Mode
      • Ghost​Send​System
      • Ghost​Send​System​Data
      • Ghost​Send​Type
      • Ghost​Serializer​Attribute
      • Ghost​Serializer​State
      • Ghost​Simulation​System​Group
      • Ghost​Spawn​Buffer
      • Ghost​Spawn​Buffer.​Type
      • Ghost​Spawn​Classification​System
      • Ghost​Spawn​Queue
      • Ghost​Spawn​Queue​Component
      • Ghost​Spawn​System
      • Ghost​Spawn​System​Group
      • Ghost​Type
      • Ghost​Type​Component
      • Ghost​Type​Partition
      • Ghost​Update​System
      • ICommand​Data
      • ICommand​Data​Serializer<T>
      • IGhost​Component​Serializer​Registration
      • IInput​Buffer​Data
      • IInput​Component​Data
      • Incoming​Command​Data​Stream​Buffer
      • Incoming​Command​Data​Stream​Buffer​Component
      • Incoming​Rpc​Data​Stream​Buffer
      • Incoming​Rpc​Data​Stream​Buffer​Component
      • Incoming​Snapshot​Data​Stream​Buffer
      • Incoming​Snapshot​Data​Stream​Buffer​Component
      • INetwork​Stream​Driver​Constructor
      • Input​Event
      • IPCAnd​Socket​Driver​Constructor
      • IRpc​Command
      • IRpc​Command​Serializer<T>
      • Lag​Compensation​Config
      • Migration​Ticket
      • Net​Code​Debug​Config
      • Net​Code​Debug​Config​Authoring
      • Net​Code​Disable​Command​Code​Gen​Attribute
      • Net​Code​Physics​Config
      • Net​Debug
      • Net​Debug.​Log​Level​Type
      • Net​Debug​System
      • Network​Driver​Store
      • Network​Driver​Store.​Driver​Visitor
      • Network​Driver​Store.​Network​Driver​Instance
      • Network​Id
      • Network​Id​Component
      • Network​Id​Debug​Color​Utility
      • Network​Protocol​Version
      • Network​Receive​System​Group
      • Network​Snapshot​Ack
      • Network​Snapshot​Ack​Component
      • Network​Stream​Connection
      • Network​Stream​Connect​System
      • Network​Stream​Disconnect​Reason
      • Network​Stream​Driver
      • Network​Stream​In​Game
      • Network​Stream​Listen​System
      • Network​Stream​Protocol
      • Network​Stream​Receive​System
      • Network​Stream​Request​Connect
      • Network​Stream​Request​Disconnect
      • Network​Stream​Request​Listen
      • Network​Stream​Request​Listen​Result
      • Network​Stream​Request​Listen​Result.​State
      • Network​Stream​Snapshot​Target​Size
      • Network​Tick
      • Network​Time
      • Network​Time​Flags
      • Network​Time​System
      • Network​Time​System​Data
      • Outgoing​Command​Data​Stream​Buffer
      • Outgoing​Command​Data​Stream​Buffer​Component
      • Outgoing​Rpc​Data​Stream​Buffer
      • Outgoing​Rpc​Data​Stream​Buffer​Component
      • Pending​Spawn​Placeholder
      • Pending​Spawn​Placeholder​Component
      • Physics​Default​Variant​System
      • Physics​Graphical​Smoothing​Default​Variant
      • Physics​Velocity​Default​Variant
      • Physics​World​History
      • Physics​World​History​Singleton
      • Portable​Function​Pointer<T>
      • Position​Only​Variant
      • Position​Rotation​Variant
      • Position​Scale​Variant
      • Predicted​Fixed​Step​Simulation​System​Group
      • Predicted​Ghost
      • Predicted​Ghost​Component
      • Predicted​Ghost​Spawn
      • Predicted​Ghost​Spawn​List
      • Predicted​Ghost​Spawn​Request
      • Predicted​Ghost​Spawn​Request​Component
      • Predicted​Ghost​Spawn​System
      • Predicted​Physics​Config​System
      • Predicted​Physics​Non​Ghost​World
      • Predicted​Physics​Validation​System
      • Predicted​Simulation​System​Group
      • Pre​Serialized​Ghost
      • Pre​Spawned​Ghost​Index
      • Prespawn​Ghost​System​Group
      • Prespawn​Section​Ack
      • Receive​Rpc​Command​Request
      • Receive​Rpc​Command​Request​Component
      • Relevant​Ghost​For​Connection
      • Rotation​Only​Variant
      • Rotation​Scale​Variant
      • Rpc​Collection
      • Rpc​Command​Request<TAction​Serializer, TAction​Request>
      • Rpc​Command​Request<TAction​Serializer, TAction​Request>.​Send​Rpc​Data
      • Rpc​Command​Request​System​Group
      • Rpc​Deserializer​State
      • Rpc​Executor
      • Rpc​Executor.​Execute​Delegate
      • Rpc​Executor.​Parameters
      • Rpc​Queue<TAction​Serializer, TAction​Request>
      • Rpc​Serializer​State
      • Rpc​System
      • Rpc​System​Errors
      • Send​Rpc​Command​Request
      • Send​Rpc​Command​Request​Component
      • Send​To​Owner​Type
      • Server​Only​Variant
      • Server​Populate​Prespawned​Ghosts​System
      • Server​Track​Loaded​Prespawn​Sections
      • Shared​Ghost​Type​Component
      • Simulator​Preset
      • Smoothing​Action
      • Snapshot​Data
      • Snapshot​Data.​Data​At​Tick
      • Snapshot​Data​Buffer
      • Snapshot​Dynamic​Buffers​Helper
      • Snapshot​Dynamic​Data​Buffer
      • Spawned​Ghost
      • Spawned​Ghost​Entity​Map
      • Sub​Scene​Ghost​Component​Hash
      • Sub​Scene​With​Prespawn​Ghosts
      • Supports​Prefab​Overrides​Attribute
      • Switch​Prediction​Smoothing
      • Switch​Prediction​Smoothing​Physics​Ordering​System
      • Switch​Prediction​Smoothing​System
      • Transform​Default​Variant
      • Transform​Default​Variant​System
      • Transport​Type
      • Unique​Input​Tick​Map
      • Unscaled​Client​Time
    • Unity.​Net​Code.​Editor
      • Prespawned​Ghost​Preprocess​Scene
    • Unity.​Net​Code.​Generators
      • Type​Registry​Entry
      • User​Defined​Templates
    • Unity.​Net​Code.​Hybrid
      • Baker​Extensions
      • Enable​Animation​Controller​Prediction​Update
      • Ghost​Animation​Controller
      • Ghost​Animation​Controller​Interpolation​System
      • Ghost​Animation​Controller​Prediction​System
      • Ghost​Animation​Controller​Server​System
      • Ghost​Animation​Graph​Asset
      • Ghost​Playable​Behaviour
      • Ghost​Presentation​Game​Object​Authoring
      • Ghost​Presentation​Game​Object​Entity​Owner
      • Ghost​Presentation​Game​Object​Prefab
      • Ghost​Presentation​Game​Object​Prefab​Reference
      • Ghost​Presentation​Game​Object​System
      • Ghost​Presentation​Game​Object​Transform​System
      • IRegister​Playable​Data
    • Unity.​Net​Code.​Low​Level
      • Snapshot​Data​Buffer​Component​Lookup
      • Snapshot​Data​Lookup​Helper
    • Unity.​Net​Code.​Low​Level.​Unsafe
      • Ghost​Component​Serializer
      • Ghost​Component​Serializer.​Copy​To​From​Snapshot​Delegate
      • Ghost​Component​Serializer.​Deserialize​Delegate
      • Ghost​Component​Serializer.​Post​Serialize​Buffer​Delegate
      • Ghost​Component​Serializer.​Post​Serialize​Delegate
      • Ghost​Component​Serializer.​Predict​Delta​Delegate
      • Ghost​Component​Serializer.​Report​Prediction​Errors​Delegate
      • Ghost​Component​Serializer.​Restore​From​Backup​Delegate
      • Ghost​Component​Serializer.​Send​Mask
      • Ghost​Component​Serializer.​Serialize​Buffer​Delegate
      • Ghost​Component​Serializer.​Serialize​Child​Delegate
      • Ghost​Component​Serializer.​Serialize​Delegate
      • Ghost​Component​Serializer.​State
    • Scripting API
    • Unity.​Net​Code
    • Default​Driver​Builder

    Class DefaultDriverBuilder

    Default helper method implementation for constructing NetworkDriverStore.NetworkDriverInstance, default NetworkSettings and registering these on the NetworkDriverStore.

    Inheritance
    Object
    DefaultDriverBuilder
    Inherited Members
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Unity.NetCode
    Syntax
    public static class DefaultDriverBuilder

    Properties

    DefaultDriverConstructor

    Return an instance of the IPCAndSocketDriverConstructor constructor

    Declaration
    public static INetworkStreamDriverConstructor DefaultDriverConstructor { get; }
    Property Value
    Type Description
    INetworkStreamDriverConstructor

    Methods

    CreateClientNetworkDriver<T>(T)

    Helper method for creating NetworkDriver suitable for client. The driver will use the the specified netIf and is configured using the internal defaults. See: GetNetworkSettings().

    Declaration
    public static NetworkDriverStore.NetworkDriverInstance CreateClientNetworkDriver<T>(T netIf)
        where T : struct, INetworkInterface
    Parameters
    Type Name Description
    T netIf

    the instance of a INetworkInterface to use to create the driver

    Returns
    Type Description
    NetworkDriverStore.NetworkDriverInstance

    A new NetworkDriverStore.NetworkDriverInstance

    Type Parameters
    Name Description
    T

    the INetworkInterface type ot use

    CreateClientNetworkDriver<T>(T, NetworkSettings)

    Helper method for creating NetworkDriver suitable for client. The driver will use the specified INetworkInterface and is configured using the provided settings.

    Declaration
    public static NetworkDriverStore.NetworkDriverInstance CreateClientNetworkDriver<T>(T netIf, NetworkSettings settings)
        where T : struct, INetworkInterface
    Parameters
    Type Name Description
    T netIf

    the instance of a INetworkInterface to use to create the driver

    NetworkSettings settings

    A list of the parameters that describe the network configuration.

    Returns
    Type Description
    NetworkDriverStore.NetworkDriverInstance

    A new NetworkDriverStore.NetworkDriverInstance

    Type Parameters
    Name Description
    T

    the INetworkInterface type ot use

    CreateClientPipelines(ref NetworkDriverStore.NetworkDriverInstance)

    Create the default network pipelines (reliable, unreliable, unreliable fragmented) for the client.

    Declaration
    public static void CreateClientPipelines(ref NetworkDriverStore.NetworkDriverInstance driverInstance)
    Parameters
    Type Name Description
    NetworkDriverStore.NetworkDriverInstance driverInstance

    The NetworkDriverStore.NetworkDriverInstance instance to configure

    CreateServerNetworkDriver<T>(T, Int32)

    Helper method for creating server NetworkDriver given the specified netIf The driver is configured with the internal defaults. See: GetNetworkServerSettings(Int32).

    Declaration
    public static NetworkDriverStore.NetworkDriverInstance CreateServerNetworkDriver<T>(T netIf, int playerCount = 0)
        where T : struct, INetworkInterface
    Parameters
    Type Name Description
    T netIf

    the instance of a INetworkInterface to use to create the driver

    Int32 playerCount

    Amount of players the server should allocate receive and send queue for. The estimation is that each player will receive 4 packets.

    Returns
    Type Description
    NetworkDriverStore.NetworkDriverInstance

    A new NetworkDriverStore.NetworkDriverInstance

    Type Parameters
    Name Description
    T

    the INetworkInterface type ot use

    CreateServerNetworkDriver<T>(T, NetworkSettings)

    Helper method for creating server NetworkDriver given the specified INetworkInterface The driver is configured using the NetworkSettings.

    Declaration
    public static NetworkDriverStore.NetworkDriverInstance CreateServerNetworkDriver<T>(T netIf, NetworkSettings settings)
        where T : struct, INetworkInterface
    Parameters
    Type Name Description
    T netIf
    NetworkSettings settings

    A list of the parameters that describe the network configuration.

    Returns
    Type Description
    NetworkDriverStore.NetworkDriverInstance

    A new NetworkDriverStore.NetworkDriverInstance

    Type Parameters
    Name Description
    T

    the INetworkInterface type ot use

    CreateServerPipelines(ref NetworkDriverStore.NetworkDriverInstance)

    Create the default network pipelines (reliable, unreliable, unreliable fragmented) for the server.

    Declaration
    public static void CreateServerPipelines(ref NetworkDriverStore.NetworkDriverInstance driverInstance)
    Parameters
    Type Name Description
    NetworkDriverStore.NetworkDriverInstance driverInstance

    The NetworkDriverStore.NetworkDriverInstance instance to configure

    GetNetworkServerSettings(Int32)

    Return a set of internal default settings. This will use the NetworkSimulator parameters set by Multiplayer PlayMode Tools.

    Declaration
    public static NetworkSettings GetNetworkServerSettings(int playerCount = 0)
    Parameters
    Type Name Description
    Int32 playerCount

    Amount of players the server should allocate receive and send queue for. The estimation is that each player will receive 4 packets.

    Returns
    Type Description
    NetworkSettings

    Parameters that describe the network configuration.

    GetNetworkSettings()

    Return a set of internal default settings. This will use the NetworkSimulator parameters set by Multiplayer PlayMode Tools.

    Declaration
    public static NetworkSettings GetNetworkSettings()
    Returns
    Type Description
    NetworkSettings

    A new NetworkDriverStore.NetworkDriverInstance

    RegisterClientDriver(World, ref NetworkDriverStore, NetDebug)

    Register a NetworkDriver instance in driverStore:

    • a single IPCNetworkInterface NetworkDriver if the both client and server worlds are present in the same process
    • a single UDPNetworkInterface driver in all other cases
      These are configured using internal defaults. See: GetNetworkSettings().
    Declaration
    public static void RegisterClientDriver(World world, ref NetworkDriverStore driverStore, NetDebug netDebug)
    Parameters
    Type Name Description
    World world

    Used for determining whether we are running in a client or server world.

    NetworkDriverStore driverStore

    Store for NetworkDriver.

    NetDebug netDebug

    For handling logging.

    RegisterClientDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)

    Register a NetworkDriver instance in and stores it in driverStore:

    • a single IPCNetworkInterface NetworkDriver if the both client and server worlds are present in the same process.
    • a single UDPNetworkInterface driver in all other cases.
      These are configured using the NetworkSettings passed in.
    Declaration
    public static void RegisterClientDriver(World world, ref NetworkDriverStore driverStore, NetDebug netDebug, NetworkSettings settings)
    Parameters
    Type Name Description
    World world

    Used for determining whether we are running in a client or server world.

    NetworkDriverStore driverStore

    Store for NetworkDriver.

    NetDebug netDebug

    For handling logging.

    NetworkSettings settings

    A list of the parameters that describe the network configuration.

    RegisterClientDriver(World, ref NetworkDriverStore, NetDebug, ref RelayServerData)

    Register a NetworkDriver instance in and stores it in driverStore:

    • a single IPCNetworkInterface NetworkDriver if the both client and server worlds are present in the same process.
    • a single UDPNetworkInterface driver in all other cases.
      These are configured using the default settings. See GetNetworkSettings().
    Declaration
    public static void RegisterClientDriver(World world, ref NetworkDriverStore driverStore, NetDebug netDebug, ref RelayServerData relayData)
    Parameters
    Type Name Description
    World world

    Used for determining whether we are running in a client or server world.

    NetworkDriverStore driverStore

    Store for NetworkDriver.

    NetDebug netDebug

    For handling logging.

    RelayServerData relayData

    Server information to make a connection using a relay server.

    RegisterClientIpcDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)

    Register an IPCNetworkInterface NetworkDriver instance in driverStore. This are configured using the NetworkSettings passed in.

    Declaration
    public static void RegisterClientIpcDriver(World world, ref NetworkDriverStore driverStore, NetDebug netDebug, NetworkSettings settings)
    Parameters
    Type Name Description
    World world

    Used for determining whether we are running in a client or server world.

    NetworkDriverStore driverStore

    Store for NetworkDriver.

    NetDebug netDebug

    For handling logging.

    NetworkSettings settings

    A list of the parameters that describe the network configuration.

    RegisterClientUdpDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)

    Register a UDPNetworkInterface NetworkDriver instance in driverStore. This are configured using the NetworkSettings passed in.

    Declaration
    public static void RegisterClientUdpDriver(World world, ref NetworkDriverStore driverStore, NetDebug netDebug, NetworkSettings settings)
    Parameters
    Type Name Description
    World world

    Used for determining whether we are running in a client or server world.

    NetworkDriverStore driverStore

    Store for NetworkDriver.

    NetDebug netDebug

    For handling logging.

    NetworkSettings settings

    A list of the parameters that describe the network configuration.

    RegisterServerDriver(World, ref NetworkDriverStore, NetDebug, Int32)

    Register a NetworkDriver instance in driverStore:
    both IPCNetworkInterface and UDPNetworkInterface NetworkDriver in the editor and only a single UDPNetworkInterface driver in the build.
    These are configured using internal defaults. See: GetNetworkSettings().

    Declaration
    public static void RegisterServerDriver(World world, ref NetworkDriverStore driverStore, NetDebug netDebug, int playerCount = 0)
    Parameters
    Type Name Description
    World world

    Used for determining whether we are running in a client or server world.

    NetworkDriverStore driverStore

    Store for NetworkDriver.

    NetDebug netDebug

    For handling logging.

    Int32 playerCount

    Amount of players the server should allocate receive and send queue for. The estimation is that each player will receive 4 packets.

    RegisterServerDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)

    Register a NetworkDriver instance in driverStore:
    both IPCNetworkInterface and UDPNetworkInterface NetworkDriver in the editor and only a single UDPNetworkInterface driver in the build.
    These are configured using the NetworkSettings passed in.

    Declaration
    public static void RegisterServerDriver(World world, ref NetworkDriverStore driverStore, NetDebug netDebug, NetworkSettings settings)
    Parameters
    Type Name Description
    World world

    Used for determining whether we are running in a client or server world.

    NetworkDriverStore driverStore

    Store for NetworkDriver.

    NetDebug netDebug

    For handling logging.

    NetworkSettings settings

    A list of the parameters that describe the network configuration.

    RegisterServerDriver(World, ref NetworkDriverStore, NetDebug, ref RelayServerData, Int32)

    Register a NetworkDriver instance in driverStore:
    both IPCNetworkInterface and UDPNetworkInterface NetworkDriver in the editor and only a single UDPNetworkInterface driver in the build.
    These are configured using the default settings. See GetNetworkServerSettings(Int32).

    Declaration
    public static void RegisterServerDriver(World world, ref NetworkDriverStore driverStore, NetDebug netDebug, ref RelayServerData relayData, int playerCount = 0)
    Parameters
    Type Name Description
    World world

    Used for determining whether we are running in a client or server world.

    NetworkDriverStore driverStore

    Store for NetworkDriver.

    NetDebug netDebug

    For handling logging.

    RelayServerData relayData

    Server information to make a connection using a relay server.

    Int32 playerCount

    Amount of players the server should allocate receive and send queue for. The estimation is that each player will receive 4 packets.

    RegisterServerIpcDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)

    Register a IPCNetworkInterface NetworkDriver instance in driverStore. This are configured using the NetworkSettings passed in.

    If the requested ClientServerBootstrap.PlayType is Server this will do nothing as no local clients will ever make use of the IPC mechanism.

    Declaration
    public static void RegisterServerIpcDriver(World world, ref NetworkDriverStore driverStore, NetDebug netDebug, NetworkSettings settings)
    Parameters
    Type Name Description
    World world

    Used for determining whether we are running in a client or server world.

    NetworkDriverStore driverStore

    Store for NetworkDriver.

    NetDebug netDebug

    For handling logging.

    NetworkSettings settings

    A list of the parameters that describe the network configuration.

    RegisterServerUdpDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)

    Register a UDPNetworkInterface NetworkDriver instance in driverStore. This are configured using the NetworkSettings passed in.

    Declaration
    public static void RegisterServerUdpDriver(World world, ref NetworkDriverStore driverStore, NetDebug netDebug, NetworkSettings settings)
    Parameters
    Type Name Description
    World world

    Used for determining whether we are running in a client or server world.

    NetworkDriverStore driverStore

    Store for NetworkDriver.

    NetDebug netDebug

    For handling logging.

    NetworkSettings settings

    A list of the parameters that describe the network configuration.

    In This Article
    • Properties
      • DefaultDriverConstructor
    • Methods
      • CreateClientNetworkDriver<T>(T)
      • CreateClientNetworkDriver<T>(T, NetworkSettings)
      • CreateClientPipelines(ref NetworkDriverStore.NetworkDriverInstance)
      • CreateServerNetworkDriver<T>(T, Int32)
      • CreateServerNetworkDriver<T>(T, NetworkSettings)
      • CreateServerPipelines(ref NetworkDriverStore.NetworkDriverInstance)
      • GetNetworkServerSettings(Int32)
      • GetNetworkSettings()
      • RegisterClientDriver(World, ref NetworkDriverStore, NetDebug)
      • RegisterClientDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)
      • RegisterClientDriver(World, ref NetworkDriverStore, NetDebug, ref RelayServerData)
      • RegisterClientIpcDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)
      • RegisterClientUdpDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)
      • RegisterServerDriver(World, ref NetworkDriverStore, NetDebug, Int32)
      • RegisterServerDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)
      • RegisterServerDriver(World, ref NetworkDriverStore, NetDebug, ref RelayServerData, Int32)
      • RegisterServerIpcDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)
      • RegisterServerUdpDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)
    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