FPlayerMuteList

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

Choose your operating system:

Windows

macOS

Linux

References

Module

Engine

Header

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

Include

#include "GameFramework/PlayerMuteList.h"

Syntax

struct FPlayerMuteList

Remarks

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

Variables

Name Description

Public variable

bool

 

bHasVoiceHandshakeCompleted

Has server and client handshake completed

Public variable

int32

 

VoiceChannelIdx

Public variable

TUniqueNetIdMap...

 

VoicePacketFilterMap

Map of player ids and a bitfield containing filter reasons.

Constructors

Name Description

Public function

FPlayerMuteList()

Functions

Name Description

Public function

bool

 

AddVoiceBlockReason

(
    const FUniqueNetIdPtr& PlayerId,
    EVoiceBlockReasons VoiceBlockReason
)

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

Public function

void

 

GameplayMutePlayer

(
    APlayerController* OwningPC,
    const FUniqueNetIdRepl& MuteId
)

Server muting based on gameplay rules

Public function

void

 

GameplayUnmuteAllPlayers

(
    APlayerController* OwningPC
)

Server unmuting all players muted based on gameplay rules

Public function

void

 

GameplayUnmutePlayer

(
    APlayerController* OwningPC,
    const FUniqueNetIdRepl& UnmuteId
)

Server unmuting based on gameplay rules

Public function

bool

 

IsPlayerMuted

(
    const FUniqueNetId& PlayerId
)

Is a given player currently muted

Public function

bool

 

RemoveVoiceBlockReason

(
    const FUniqueNetIdPtr& PlayerId,
    EVoiceBlockReasons VoiceBlockReason
)

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

Public function

void

 

ServerBlockPlayer

(
    APlayerController* OwningPC,
    const FUniqueNetIdRepl& BlockId
)

Tell the server to block a given player

Public function

void

 

ServerMutePlayer

(
    APlayerController* OwningPC,
    const FUniqueNetIdRepl& MuteId
)

Tell the server to mute a given player

Public function

void

 

ServerUnblockPlayer

(
    APlayerController* OwningPC,
    const FUniqueNetIdRepl& UnblockId
)

Tell the server to unblock a given player

Public function

void

 

ServerUnmutePlayer

(
    APlayerController* OwningPC,
    const FUniqueNetIdRepl& UnmuteId
)

Tell the server to unmute a given player