FPlayerMuteList Struct Reference

#include <PlayerMuteList.h>

Public Member Functions
	FPlayerMuteList ()
bool	AddVoiceBlockReason (const FUniqueNetIdPtr &PlayerId, EVoiceBlockReasons VoiceBlockReason)
bool	RemoveVoiceBlockReason (const FUniqueNetIdPtr &PlayerId, EVoiceBlockReasons VoiceBlockReason)
void	ServerMutePlayer (class APlayerController *OwningPC, const FUniqueNetIdRepl &MuteId)
void	ServerUnmutePlayer (class APlayerController *OwningPC, const FUniqueNetIdRepl &UnmuteId)
void	GameplayMutePlayer (class APlayerController *OwningPC, const FUniqueNetIdRepl &MuteId)
void	GameplayUnmutePlayer (class APlayerController *OwningPC, const FUniqueNetIdRepl &UnmuteId)
void	GameplayUnmuteAllPlayers (class APlayerController *OwningPC)
void	ServerBlockPlayer (class APlayerController *OwningPC, const FUniqueNetIdRepl &BlockId)
void	ServerUnblockPlayer (class APlayerController *OwningPC, const FUniqueNetIdRepl &UnblockId)
bool	IsPlayerMuted (const class FUniqueNetId &PlayerId)

Public Attributes
TUniqueNetIdMap< EVoiceBlockReasons >	VoicePacketFilterMap
bool	bHasVoiceHandshakeCompleted
int32	VoiceChannelIdx

Detailed Description

Container responsible for managing the mute state of a player controller at the gameplay level (VoiceInterface handles actual muting)

Constructor & Destructor Documentation

FPlayerMuteList()

FPlayerMuteList::FPlayerMuteList ( )

inline

Member Function Documentation

AddVoiceBlockReason()

bool FPlayerMuteList::AddVoiceBlockReason	(	const FUniqueNetIdPtr &	PlayerId,
		EVoiceBlockReasons	VoiceBlockReason
	)

Add a filter reason for an id to this player's mutelist

Parameters

OwningPC	player id to add a filter reason
VoiceBlockReason	reason to add

Returns

true if it's the first reason to block voice from user

GameplayMutePlayer()

void FPlayerMuteList::GameplayMutePlayer	(	class APlayerController *	OwningPC,
		const FUniqueNetIdRepl &	MuteId
	)

Server muting based on gameplay rules

Parameters

OwningPC	player controller that would like to mute another player
MuteId	player id that should be muted

GameplayUnmuteAllPlayers()

void FPlayerMuteList::GameplayUnmuteAllPlayers

(

class APlayerController *

OwningPC

)

Server unmuting all players muted based on gameplay rules

Parameters

OwningPC

player controller that would like to unmute all players

GameplayUnmutePlayer()

void FPlayerMuteList::GameplayUnmutePlayer	(	class APlayerController *	OwningPC,
		const FUniqueNetIdRepl &	UnmuteId
	)

Server unmuting based on gameplay rules

Parameters

OwningPC	player controller that would like to unmute another player
UnmuteId	player id that should be unmuted

IsPlayerMuted()

bool FPlayerMuteList::IsPlayerMuted

(

const class FUniqueNetId &

PlayerId

)

Is a given player currently muted

Parameters

PlayerId

player to query mute state

Returns

true if the playerid is muted, false otherwise

RemoveVoiceBlockReason()

bool FPlayerMuteList::RemoveVoiceBlockReason	(	const FUniqueNetIdPtr &	PlayerId,
		EVoiceBlockReasons	VoiceBlockReason
	)

Remove a filter reason for an id from this player's mutelist

Parameters

UniqueIdToRemove	player id to remove a filter reason
VoiceBlockReason	reason to remove

Returns

true if it's the last reason blocking voice from user

ServerBlockPlayer()

void FPlayerMuteList::ServerBlockPlayer	(	class APlayerController *	OwningPC,
		const FUniqueNetIdRepl &	BlockId
	)

Tell the server to block a given player

Parameters

OwningPC	player controller that would like to block another player
BlockerId	player id that should be blocked

ServerMutePlayer()

void FPlayerMuteList::ServerMutePlayer	(	class APlayerController *	OwningPC,
		const FUniqueNetIdRepl &	MuteId
	)

Tell the server to mute a given player

Parameters

OwningPC	player controller that would like to mute another player
MuteId	player id that should be muted

ServerUnblockPlayer()

void FPlayerMuteList::ServerUnblockPlayer	(	class APlayerController *	OwningPC,
		const FUniqueNetIdRepl &	UnblockId
	)

Tell the server to unblock a given player

Parameters

UnblockedPC	player controller that would like to unblock another player
BlockerId	player id that should be unblocked

ServerUnmutePlayer()

void FPlayerMuteList::ServerUnmutePlayer	(	class APlayerController *	OwningPC,
		const FUniqueNetIdRepl &	UnmuteId
	)

Tell the server to unmute a given player

Parameters

OwningPC	player controller that would like to unmute another player
UnmuteId	player id that should be unmuted

Member Data Documentation

bHasVoiceHandshakeCompleted

bool FPlayerMuteList::bHasVoiceHandshakeCompleted

Has server and client handshake completed

VoiceChannelIdx

int32 FPlayerMuteList::VoiceChannelIdx

VoicePacketFilterMap

TUniqueNetIdMap<EVoiceBlockReasons> FPlayerMuteList::VoicePacketFilterMap

Map of player ids and a bitfield containing filter reasons. Non-zero entries imply communication is blocked for that player

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Engine/Classes/GameFramework/PlayerMuteList.h
• Engine/Source/Runtime/Engine/Private/PlayerMuteList.cpp