AGameSession::KickPlayer

Forcibly remove player from the server

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/GameFramework/GameSession.h

Include

#include "GameFramework/GameSession.h"

Source

/Engine/Source/Runtime/Engine/Private/GameSession.cpp

Syntax

virtual bool KickPlayer
(
    APlayerController * KickedPlayer,
    const FText & KickReason
)

Remarks

Forcibly remove player from the server

Returns

true if player was able to be kicked, false otherwise

Parameters

Parameter

Description

KickedPlayer

player to kick

KickReason

text reason to display to player

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