LanguageEnglish
  • C#
  • JS

Script language

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

NetworkMatch.DropConnection

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 function DropConnection(netId: Networking.Types.NetworkID, dropNodeId: Networking.Types.NodeID, callback: ResponseDelegate<BasicResponse>): Coroutine;
public Coroutine DropConnection(Networking.Types.NetworkID netId, Networking.Types.NodeID dropNodeId, ResponseDelegate<BasicResponse> callback);
public function DropConnection(req: Networking.Match.DropConnectionRequest, callback: ResponseDelegate<BasicResponse>): Coroutine;
public Coroutine DropConnection(Networking.Match.DropConnectionRequest req, ResponseDelegate<BasicResponse> callback);

Parameters

callback A callback delegate that takes a BasicResponse that indicates the return of the request after coroutine processing.
req A DropConnectionRequest describing the match to destroy.
netId Id of the match to drop from.
dropNodeId NodeId of the client to drop.

Returns

Coroutine A coroutine for managing the async operation. if using the callback, this can be ignored.

Description

This causes a client to be dropped from a UNET Matchmaker match.

The host can drop any connection to any connected client. A client connected to a host can drop only its own connection. If a client (non host) tries to call DropConnection on another client, the command will fail. This is asynchronous, the callback function will be invoked when the operation completes.