Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

NetworkTransport.ConnectWithSimulator

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function ConnectWithSimulator(hostId: int, address: string, port: int, exeptionConnectionId: int, out error: byte, conf: Networking.ConnectionSimulatorConfig): int;
public static int ConnectWithSimulator(int hostId, string address, int port, int exeptionConnectionId, out byte error, Networking.ConnectionSimulatorConfig conf);

Parameters

hostId Host ID associated with this connection (Retrieved when calling NetworkTransport.AddHost).
address IPv4 address of the other peer.
port Port of the other peer.
exeptionConnectionId Set to 0 in the case of a default connection.
error Error (can be cast to NetworkError for more information).
conf A ConnectionSimulatorConfig defined for this connection.

Returns

int A unique connection identifier on success (otherwise zero).

Description

Connect with simulated latency.

Establishes a connection between peers and configures it to simulate Internet latency (only works with the Editor and development builds).