Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. FPlayerMuteList

FPlayerMuteList

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

API > API/Runtime > API/Runtime/Engine

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

   
Name FPlayerMuteList
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/GameFramework/PlayerMuteList.h
Include Path #include "GameFramework/PlayerMuteList.h"

Syntax

USTRUCT ()  
struct FPlayerMuteList

Constructors

Name Remarks Include Path Unreal Specifiers

FPlayerMuteList()

   GameFramework/PlayerMuteList.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bHasVoiceHandshakeCompleted bool Has server and client handshake completed GameFramework/PlayerMuteList.h  
VoiceChannelIdx int32   GameFramework/PlayerMuteList.h  
VoicePacketFilterMap TUniqueNetIdMap< EVoiceBlockReasons > Map of player ids and a bitfield containing filter reasons. GameFramework/PlayerMuteList.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddVoiceBlockReason ( const FUniqueNetIdPtr& PlayerId,
EVoiceBlockReasons VoiceBlockReason
)

 Add a filter reason for an id to this player's mutelist GameFramework/PlayerMuteList.h  

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

 Server muting based on gameplay rules GameFramework/PlayerMuteList.h  

void GameplayUnmuteAllPlayers ( APlayerController* OwningPC
)

 Server unmuting all players muted based on gameplay rules GameFramework/PlayerMuteList.h  

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

 Server unmuting based on gameplay rules GameFramework/PlayerMuteList.h  

bool IsPlayerMuted ( const FUniqueNetId& PlayerId
)

 Is a given player currently muted GameFramework/PlayerMuteList.h  

bool RemoveVoiceBlockReason ( const FUniqueNetIdPtr& PlayerId,
EVoiceBlockReasons VoiceBlockReason
)

 Remove a filter reason for an id from this player's mutelist GameFramework/PlayerMuteList.h  

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

 Tell the server to block a given player GameFramework/PlayerMuteList.h  

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

 Tell the server to mute a given player GameFramework/PlayerMuteList.h  

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

 Tell the server to unblock a given player GameFramework/PlayerMuteList.h  

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

 Tell the server to unmute a given player GameFramework/PlayerMuteList.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page