Version: 2017.3 (switch to 2018.1b)
LanguageEnglish
  • C#
  • JS

Script language

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

Network.Connect

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 method Connect(IP: string, remotePort: int, password: string = ""): NetworkConnectionError;
public static NetworkConnectionError Connect(string IP, int remotePort, string password = "");

Description

Connect to the specified host (ip or domain name) and server port.

The parameters are the IP address of the host. Either a dotted IP address or a domain name. remotePort, which specifies the port on the remote machine to connect to. password, which is an optional password for the server. The password has to match the Network.incomingPassword set on the server.

    function ConnectToServer () {
        Network.Connect("127.0.0.1", 25000);
    }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void ConnectToServer() { Network.Connect("127.0.0.1", 25000); } }

public static method Connect(IPs: string[], remotePort: int, password: string = ""): NetworkConnectionError;
public static NetworkConnectionError Connect(string[] IPs, int remotePort, string password = "");

Description

This function is exactly like Network.Connect but can accept an array of IP addresses.

It can be used when the host information from a master server returns multiple internal IP addresses, then the IP data structure can be passed directly into this connect function. It actually connects to the first IP which responds to a ping (i.e. is connectable).


public static method Connect(GUID: string, password: string = ""): NetworkConnectionError;
public static NetworkConnectionError Connect(string GUID, string password = "");

Description

Connect to a server GUID. NAT punchthrough can only be performed this way.

The host GUID value is exposed locally through the NetworkPlayer structure. The master server also provides this in the HostData structure.


public static method Connect(hostData: HostData, password: string = ""): NetworkConnectionError;
public static NetworkConnectionError Connect(HostData hostData, string password = "");

Description

Connect to the host represented by a HostData structure returned by the Master Server.

Did you find this page useful? Please give it a rating: