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.

NetworkServerSimple.ListenRelay

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 function ListenRelay(relayIp: string, relayPort: int, netGuid: Networking.Types.NetworkID, sourceId: Networking.Types.SourceID, nodeId: Networking.Types.NodeID): void;
public void ListenRelay(string relayIp, int relayPort, Networking.Types.NetworkID netGuid, Networking.Types.SourceID sourceId, Networking.Types.NodeID nodeId);

Parameters

relayIp Relay server IP Address.
relayPort Relay server port.
netGuid GUID of the network to create.
sourceId This server's sourceId.
nodeId The node to join the network with.

Description

Starts a server using a Relay server. This is the manual way of using the Relay server, as the regular NetworkServer.Connect() will automatically use the Relay server if a match exists.