PlayerMuteList.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/ObjectMacros.h"
#include "Online/CoreOnline.h"
#include "Misc/EnumRange.h"
#include "PlayerMuteList.generated.h"
 
struct FUniqueNetIdRepl;
 
UENUM(meta = (Bitflags))
enum class EVoiceBlockReasons : uint8
{
    None        = 0,        // Communication with this client has no filter reasons
    Muted       = 1 << 0,   // The owning player controller has explicitly muted the player
    Gameplay    = 1 << 1,   // The player was muted for gameplay reasons
    Blocked     = 1 << 2,   // The owning player controller has blocked the player
    BlockedBy   = 1 << 3,   // The owning player controller was blocked by the player
};
ENUM_CLASS_FLAGS(EVoiceBlockReasons);
ENUM_RANGE_BY_VALUES(EVoiceBlockReasons, EVoiceBlockReasons::Muted, EVoiceBlockReasons::Gameplay, EVoiceBlockReasons::Blocked, EVoiceBlockReasons::BlockedBy);
 
USTRUCT()
struct FPlayerMuteList
{
    GENERATED_USTRUCT_BODY()
 
public:
 
    FPlayerMuteList() :
        bHasVoiceHandshakeCompleted(false),
        VoiceChannelIdx(0)
    {
    }
 
    TUniqueNetIdMap<EVoiceBlockReasons> VoicePacketFilterMap;
 
    UPROPERTY()
    bool bHasVoiceHandshakeCompleted;
    UPROPERTY()
    int32 VoiceChannelIdx;
 
public:
 
    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);
};
 
ENGINE_API FString DumpMutelistState(UWorld* World);