IOnlineGameMatches::LeaveGameMatch

Removes a player from an existing match

Windows
MacOS
Linux

References

Module

OnlineSubsystem

Header

/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineGameMatchesInterface.h

Include

#include "Interfaces/OnlineGameMatchesInterface.h"

Syntax

void LeaveGameMatch
(
    const FUniqueNetId & UserId,
    const FString & MatchId,
    const TArray< FLeaveGameMatchPlayer > & GameMatchLeavePlayerData,
    const FOnLeaveGameMatchComplete & CompletionDelegate
)

Remarks

Removes a player from an existing match

Parameters

Parameter

Description

UserId

Id of the user updating the match (not to be confused with the id of the player being removed from the match)

MatchId

The id of the match in which the player will be removed from

GameMatchLeavePlayerData

Game match data required to remove a player from the existing match

CompletionDelegate

Completion delegate called when LeaveGameMatch is complete

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss