Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OnlineSubsystem > Interfaces > IOnlineGroups > IOnlineGroups::LeaveGroup

Light Theme

Dark Theme

IOnlineGroups::LeaveGroup

Tells the server to remove the context user from the specified group.

Windows

MacOS

Linux

References

Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineGroupsInterface.h
Include	#include "Interfaces/OnlineGroupsInterface.h"

Syntax

void LeaveGroup
(
    const FUniqueNetId & ContextUserId,
    const FUniqueNetId & GroupId,
    const FOnGroupsRequestCompleted & OnCompleted
)

Remarks

Tells the server to remove the context user from the specified group. Should always result in the user's role for that group becoming Unaffiliated. Owners cannot leave their group, use TransferGroup (followed by LeaveGroup) or DeleteGroup instead.

Parameters

Parameter	Description
ContextUserId	The ID of the user whose credentials are being used to make this call
GroupId	The group's globally unique ID
OnCompleted	This callback is invoked after contacting the server. It is guaranteed to occur (regardless of success/fail) and will not be called before this function returns.

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

Take our survey

Dismiss