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 > API/Runtime/Engine/GameFramework

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

  Type Name Description
Public variable bool bHasVoiceHandshakeCompleted Has server and client handshake completed
Public variable int32 VoiceChannelIdx  
Public variable TUniqueNetIdMap< EVoiceBlockReasons > VoicePacketFilterMap Map of player ids and a bitfield containing filter reasons.

Constructors

  Type Name Description
Public function    

Functions

  Type 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 Server muting based on gameplay rules
Public function void Server unmuting all players muted based on gameplay rules
Public function void 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page