Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

Network.Connect

static function Connect(IP: string, remotePort: int, password: string = ""): NetworkConnectionError;
static NetworkConnectionError Connect(string IP, int remotePort, string password = "");
static def Connect(IP as string, remotePort as int, password as string = "") as NetworkConnectionError

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);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def ConnectToServer() as void:
		Network.Connect('127.0.0.1', 25000)

static function Connect(IPs: string[], remotePort: int, password: string = ""): NetworkConnectionError;
static NetworkConnectionError Connect(string[] IPs, int remotePort, string password = "");
static def Connect(IPs as string[], remotePort as int, password as string = "") as NetworkConnectionError

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).

static function Connect(GUID: string, password: string = ""): NetworkConnectionError;
static NetworkConnectionError Connect(string GUID, string password = "");
static def Connect(GUID as string, password as string = "") as NetworkConnectionError

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.

static function Connect(hostData: HostData, password: string = ""): NetworkConnectionError;
static NetworkConnectionError Connect(HostData hostData, string password = "");
static def Connect(hostData as HostData, password as string = "") as NetworkConnectionError

Description

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