FPlayerMuteList

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

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

TArray< TShared...

 

GameplayVoiceMuteList

List of player id's muted for gameplay reasons (teams, spectators, etc)

Public variable

int32

 

VoiceChannelIdx

Public variable

TArray< TShared...

 

VoiceMuteList

List of player id's muted explicitly by the player

Public variable

TArray< TShared...

 

VoicePacketFilter

Combined list of the above for efficient processing of voice packets

Constructors

Name Description

Public function

FPlayerMuteList()

Functions

Name Description

Public function

void

 

ClientMutePlayer

(
    APlayerController* OwningPC,
    const FUniqueNetIdRepl& MuteId
)

Tell the client to mute a given player

Public function

void

 

ClientUnmutePlayer

(
    APlayerController* OwningPC,
    const FUniqueNetIdRepl& UnmuteId
)

Tell the client to unmute a given player

Public function

void

 

GameplayMutePlayer

(
    APlayerController* OwningPC,
    const FUniqueNetIdRepl& MuteId
)

Server muting 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

void

 

ServerMutePlayer

(
    APlayerController* OwningPC,
    const FUniqueNetIdRepl& MuteId
)

Tell the server to mute a given player

Public function

void

 

ServerUnmutePlayer

(
    APlayerController* OwningPC,
    const FUniqueNetIdRepl& UnmuteId
)

Tell the server to unmute a given 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