FBlacklistNames

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

FBlacklistNames

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/BlacklistNames.h

Include

#include "Misc/BlacklistNames.h"

Syntax

class FBlacklistNames : public TSharedFromThis< FBlacklistNames >

Variables

Name Description

Protected variable

TMap< FName, FB...

 

Blacklist

List if items to filter out

Protected variable

FBlacklistOwner...

 

BlacklistAll

List of owner names that requested all items to be filtered out

Protected variable

bool

 

bSuppressOnFilterChanged

Temporarily prevent delegate from being triggered

Protected variable

FSimpleMulticas...

 

OnFilterChangedDelegate

Triggered when filter changes

Protected variable

TMap< FName, FB...

 

Whitelist

List of items to allow, if not empty all items will be filtered out unless they are in the list

Constructors

Name Description

Public function

FBlacklistNames()

Destructors

Name Description

Public function

~FBlacklistNames()

Functions

Name Description

Public function

void

 

AddBlacklistAll

(
    const FName OwnerName
)

Set to filter out all items

Public function

void

 

AddBlacklistItem

(
    const FName OwnerName,
    const FName Item
)

Add item to blacklist, this specific item will be filtered out

Public function

void

 

AddWhitelistItem

(
    const FName OwnerName,
    const FName Item
)

Add item to whitelist after which all items not in the whitelist will be filtered out

Public function

void

 

Append

(
    const FBlacklistNames& Other
)

Combine two filters together

Public function Const

const TMap< ...

 

GetBlacklist()

Get raw blacklist

Public function Const

const TMap< ...

 

GetWhitelist()

Get raw whitelist

Public function Const

bool

 

HasFiltering()

True if has filters active

Public function Const

bool

 

IsBlacklistAll()

Are all items set to be filtered out

Public function

FSimpleMulti...

 

OnFilterChanged()

Triggered when filter changes

Public function Const

bool

 

PassesFilter

(
    const FName Item
)

Returns true if passes filter restrictions using exact match

Public function

void

 

UnregisterOwner

(
    const FName OwnerName
)

Removes all filtering changes associated with a specific owner name

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss