Legacy Documentation: Version 5.3
LanguageEnglish
  • C#
  • JS

Script language

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

NetworkTransport.AddHostWithSimulator

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again 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 AddHostWithSimulator(topology: Networking.HostTopology, minTimeout: int, maxTimeout: int, port: int = 0, ip: string = null): int;
public static int AddHostWithSimulator(Networking.HostTopology topology, int minTimeout, int maxTimeout, int port = 0, string ip = null);

Parameters

topology The host topology for this host.
minTimeout Minimum simulated delay.
maxTimeout Maximum simulated delay.
port Bind to specific port, if 0 is selected the port will chosen by OS.
ip Bind to specific IP address.

Returns

int Returns host ID just created.

Description

Create a host (open socket) and configure them to simulate internet latency (works on editor and development build only).

An optional specific host IP address can be provided. This is usually only useful on servers where multiple internet accessible IP addresses might be available. The simulated latency will vary according to exponential distribution.