AGameSession::BanPlayer

Forcibly remove player from the server and ban them permanently

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 BanPlayer
(
    APlayerController * BannedPlayer,
    const FText & BanReason
)

Remarks

Forcibly remove player from the server and ban them permanently

Returns

true if player was able to be banned, false otherwise

Parameters

Parameter

Description

BannedPlayer

player to ban

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