Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Misc > FNamePermissionList

Light Theme

Dark Theme

FNamePermissionList

Inheritance Hierarchy

TSharedFromThis

FNamePermissionList

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Misc/NamePermissionList.h
Include	#include "Misc/NamePermissionList.h"

Syntax

class FNamePermissionList : public TSharedFromThis< FNamePermissionList >

Variables

	Name	Description
TMap< FName, FP...	AllowList	List of items to allow, if not empty all items will be filtered out unless they are in the list
bool	bSuppressOnFilterChanged	Temporarily prevent delegate from being triggered
TMap< FName, FP...	DenyList	List if items to filter out
FPermissionList...	DenyListAll	List of owner names that requested all items to be filtered out
FSimpleMulticas...	OnFilterChangedDelegate	Triggered when filter changes

Constructors

	Name	Description
	FNamePermissionList()

Destructors

	Name	Description
	~FNamePermissionList()

Functions

	Name	Description
bool	AddAllowListItem ( const FName OwnerName, const FName Item )	Add item to allowlist after which all items not in the allowlist will be filtered out.
bool	AddDenyListAll ( const FName OwnerName )	Set to filter out all items.
bool	AddDenyListItem ( const FName OwnerName, const FName Item )	Add item to DenyList, this specific item will be filtered out.
bool	Append ( const FNamePermissionList& Other )	Add the specified filters to this one.
const TMap< ...	GetAllowList()	Get raw allowlist
const TMap< ...	GetDenyList()	Get raw DenyList
TArray< FNam...	GetOwnerNames()	Gathers the names of all the owners in this DenyList.
bool	HasFiltering()	True if has filters active
bool	IsDenyListAll()	Are all items set to be filtered out
FSimpleMulti...	OnFilterChanged()	Triggered when filter changes
bool	PassesFilter ( const FName Item )	Returns true if passes filter restrictions using exact match
bool	RemoveAllowListItem ( const FName OwnerName, const FName Item )	Removes a previously-added item from the allowlist.
bool	RemoveDenyListItem ( const FName OwnerName, const FName Item )	Removes a previously-added item from the DenyList.
bool	UnregisterOwner ( const FName OwnerName )	Removes all filtering changes associated with a specific owner name.
bool	UnregisterOwners ( const TArray< FName >& OwnerNames )	Removes all filtering changes associated with the specified list of owner names.
bool	UnregisterOwnersAndAppend ( const TArray< FName >& OwnerNamesT..., const FNamePermissionList& Filters... )	Unregisters specified owners then adds specified filters in one operation (to avoid multiple filters changed events).

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

Take our survey

Cancel