FNamePermissionList Class Reference

#include <NamePermissionList.h>

Inheritance diagram for FNamePermissionList:

Public Member Functions
	FNamePermissionList ()
virtual	~FNamePermissionList ()
CORE_API bool	PassesFilter (const FName Item) const
CORE_API bool	AddDenyListItem (const FName OwnerName, const FName Item)
CORE_API bool	AddAllowListItem (const FName OwnerName, const FName Item)
CORE_API bool	RemoveDenyListItem (const FName OwnerName, const FName Item)
CORE_API bool	RemoveAllowListItem (const FName OwnerName, const FName Item)
CORE_API bool	AddDenyListAll (const FName OwnerName)
CORE_API bool	HasFiltering () const
CORE_API TArray< FName >	GetOwnerNames () const
CORE_API bool	UnregisterOwner (const FName OwnerName)
CORE_API bool	UnregisterOwners (const TArray< FName > &OwnerNames)
CORE_API bool	Append (const FNamePermissionList &Other)
CORE_API bool	UnregisterOwnersAndAppend (const TArray< FName > &OwnerNamesToRemove, const FNamePermissionList &FiltersToAdd)
const TMap< FName, FPermissionListOwners > &	GetDenyList () const
const TMap< FName, FPermissionListOwners > &	GetAllowList () const
bool	IsDenyListAll () const
FSimpleMulticastDelegate &	OnFilterChanged ()
Public Member Functions inherited from TSharedFromThis< FNamePermissionList >
TSharedRef< FNamePermissionList, Mode >	AsShared ()
TSharedRef< FNamePermissionList const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FNamePermissionList, Mode >	AsWeak ()
TWeakPtr< FNamePermissionList const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Protected Attributes
TMap< FName, FPermissionListOwners >	DenyList
TMap< FName, FPermissionListOwners >	AllowList
FPermissionListOwners	DenyListAll
FSimpleMulticastDelegate	OnFilterChangedDelegate
bool	bSuppressOnFilterChanged = false

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FNamePermissionList >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FNamePermissionList >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Constructor & Destructor Documentation

FNamePermissionList()

FNamePermissionList::FNamePermissionList ( )

inline

~FNamePermissionList()

virtual FNamePermissionList::~FNamePermissionList ( )

inlinevirtual

Member Function Documentation

AddAllowListItem()

bool FNamePermissionList::AddAllowListItem	(	const FName	OwnerName,
		const FName	Item
	)

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

Returns

whether the filters changed.

AddDenyListAll()

bool FNamePermissionList::AddDenyListAll

(

const FName

OwnerName

)

Set to filter out all items.

Returns

whether the filters changed.

AddDenyListItem()

bool FNamePermissionList::AddDenyListItem	(	const FName	OwnerName,
		const FName	Item
	)

Add item to DenyList, this specific item will be filtered out.

Returns

whether the filters changed.

Append()

bool FNamePermissionList::Append

(

const FNamePermissionList &

Other

)

Add the specified filters to this one.

Returns

whether the filters changed.

GetAllowList()

const TMap< FName, FPermissionListOwners > & FNamePermissionList::GetAllowList ( ) const

inline

Get raw allowlist

GetDenyList()

const TMap< FName, FPermissionListOwners > & FNamePermissionList::GetDenyList ( ) const

inline

Get raw DenyList

GetOwnerNames()

TArray< FName > FNamePermissionList::GetOwnerNames

(

)

const

Gathers the names of all the owners in this DenyList.

HasFiltering()

bool FNamePermissionList::HasFiltering

(

)

const

True if has filters active

IsDenyListAll()

bool FNamePermissionList::IsDenyListAll ( ) const

inline

Are all items set to be filtered out

OnFilterChanged()

FSimpleMulticastDelegate & FNamePermissionList::OnFilterChanged ( )

inline

Triggered when filter changes

PassesFilter()

bool FNamePermissionList::PassesFilter

(

const FName

Item

)

const

Returns true if passes filter restrictions using exact match

RemoveAllowListItem()

bool FNamePermissionList::RemoveAllowListItem	(	const FName	OwnerName,
		const FName	Item
	)

Removes a previously-added item from the allowlist.

Returns

whether the filters changed.

RemoveDenyListItem()

bool FNamePermissionList::RemoveDenyListItem	(	const FName	OwnerName,
		const FName	Item
	)

Removes a previously-added item from the DenyList.

Returns

whether the filters changed.

UnregisterOwner()

bool FNamePermissionList::UnregisterOwner

(

const FName

OwnerName

)

Removes all filtering changes associated with a specific owner name.

Returns

whether the filters changed.

UnregisterOwners()

bool FNamePermissionList::UnregisterOwners

(

const TArray< FName > &

OwnerNames

)

Removes all filtering changes associated with the specified list of owner names.

Returns

whether the filters changed.

UnregisterOwnersAndAppend()

bool FNamePermissionList::UnregisterOwnersAndAppend	(	const TArray< FName > &	OwnerNamesToRemove,
		const FNamePermissionList &	FiltersToAdd
	)

Unregisters specified owners then adds specified filters in one operation (to avoid multiple filters changed events).

Returns

whether the filters changed.

Member Data Documentation

AllowList

TMap<FName, FPermissionListOwners> FNamePermissionList::AllowList

protected

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

bSuppressOnFilterChanged

bool FNamePermissionList::bSuppressOnFilterChanged = false

protected

Temporarily prevent delegate from being triggered

DenyList

TMap<FName, FPermissionListOwners> FNamePermissionList::DenyList

protected

List if items to filter out

DenyListAll

FPermissionListOwners FNamePermissionList::DenyListAll

protected

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

OnFilterChangedDelegate

FSimpleMulticastDelegate FNamePermissionList::OnFilterChangedDelegate

protected

Triggered when filter changes

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Core/Public/Misc/NamePermissionList.h
• Engine/Source/Runtime/Core/Private/Misc/NamePermissionList.cpp