1. Epic GamesDeveloper
  3. FPathPermissionList

FPathPermissionList

Set of paths that are allowd and/or denied for certain use cases.

API > API/Runtime > API/Runtime/Core

Set of paths that are allowd and/or denied for certain use cases. A permission list may contain

  • Blanket denial
  • Specifically denied paths
  • Specifically allowed paths In decreasing order of priority. When performing prefix checks, if a a path matches a denied path, it cannot be allowed again by a more specific allowed path. If any paths are specifically allowed, paths which do NOT match something in the allow list are implicitly denied.
   
Name FPathPermissionList
Type class
Header File /Engine/Source/Runtime/Core/Public/Misc/NamePermissionList.h
Include Path #include "Misc/NamePermissionList.h"

Syntax

class FPathPermissionList : public TSharedFromThis< FPathPermissionList >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  Misc/NamePermissionList.h  
  Misc/NamePermissionList.h  
  Misc/NamePermissionList.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS ~FPathPermissionList()

   Misc/NamePermissionList.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddAllowListItem ( const FName OwnerName,
const TCHAR* Item
)

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

bool AddAllowListItem ( const FName OwnerName,
const FName Item
)

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

bool AddAllowListItem ( const FName OwnerName,
const FStringView Item
)

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

bool AddDenyListAll ( const FName OwnerName
)

 Set to filter out all items. Misc/NamePermissionList.h  

bool AddDenyListItem ( const FName OwnerName,
const TCHAR* Item
)

 Add item to DenyList, this specific item will be filtered out. Misc/NamePermissionList.h  

bool AddDenyListItem ( const FName OwnerName,
const FName Item
)

 Add item to DenyList, this specific item will be filtered out. Misc/NamePermissionList.h  

bool AddDenyListItem ( const FName OwnerName,
const FStringView Item
)

 Add item to DenyList, this specific item will be filtered out. Misc/NamePermissionList.h  

bool Append ( const FPathPermissionList& Other
)

 Add the specified filters to this one. Rules are not applied, direct append lists. Misc/NamePermissionList.h  
Combine two filters. Misc/NamePermissionList.h  

bool ContainsDenyListItem ( FStringView Item
) const

 Returns whether the given path has been denied explicitly with a call to AddDenyListItem. Misc/NamePermissionList.h  

const TMap< FString, FPermissionListOwners > & GetAllowList()

 Get raw allowlist Misc/NamePermissionList.h  

TArray< FString > GetAllowListEntries()

 Returns a copy of the paths explicity allowed in this list Misc/NamePermissionList.h  

const TMap< FString, FPermissionListOwners > & GetDenyList()

 Get raw DenyList Misc/NamePermissionList.h  

TArray< FString > GetDenyListEntries()

 Get a copy of the paths explicity denied in this list. Misc/NamePermissionList.h  

TArray< FName > GetOwnerNames()

 Gathers the names of all the owners in this DenyList. Misc/NamePermissionList.h  

bool HasAllowListEntries()

 Returns whether this list has any explicitly allowed paths, which will lead to it denying access to any paths not listed. Misc/NamePermissionList.h  

bool HasDenyListEntries()

 Returns whether this list has any explicitly denied paths. Misc/NamePermissionList.h  

bool HasFiltering()

 True if has filters active Misc/NamePermissionList.h  

bool IsDenyListAll()

 Are all items set to be filtered out Misc/NamePermissionList.h  

FSimpleMulticastDelegate & OnFilterChanged()

 Triggered when filter changes Misc/NamePermissionList.h  

bool PassesFilter ( const FStringView Item
) const

 Returns true if passes filter restrictions using exact match Misc/NamePermissionList.h  

bool PassesFilter ( const FName Item
) const

 Returns true if passes filter restrictions using exact match Misc/NamePermissionList.h  

bool PassesFilter ( const TCHAR* Item
) const

 Returns true if passes filter restrictions using exact match Misc/NamePermissionList.h  

bool PassesStartsWithFilter ( const TCHAR* Item,
const bool bAllowParentPaths
) const

 Returns true if passes filter restrictions for path Misc/NamePermissionList.h  

bool PassesStartsWithFilter ( const FName Item,
const bool bAllowParentPaths
) const

 Returns true if passes filter restrictions for path Misc/NamePermissionList.h  

bool PassesStartsWithFilter ( const FStringView Item,
const bool bAllowParentPaths
) const

 Returns true if passes filter restrictions for path Misc/NamePermissionList.h  

EPathPermissionPrefixResult PassesStartsWithFilterRecursive ( const FStringView Item,
const bool bAllowParentPaths
) const

 Checks the given path against the restrictions and return whether it's possible for any child paths to succeed or fail as well. Misc/NamePermissionList.h  

bool RemoveAllowListItem ( const FName OwnerName,
const TCHAR* Item
)

 Remove item from the AllowList Misc/NamePermissionList.h  

bool RemoveAllowListItem ( const FName OwnerName,
const FName Item
)

 Remove item from the AllowList Misc/NamePermissionList.h  

bool RemoveAllowListItem ( const FName OwnerName,
const FStringView Item
)

 Remove item from the AllowList Misc/NamePermissionList.h  

bool RemoveDenyListItem ( const FName OwnerName,
const FStringView Item
)

 Remove item from the DenyList Misc/NamePermissionList.h  

bool RemoveDenyListItem ( const FName OwnerName,
const TCHAR* Item
)

 Remove item from the DenyList Misc/NamePermissionList.h  

bool RemoveDenyListItem ( const FName OwnerName,
const FName Item
)

 Remove item from the DenyList Misc/NamePermissionList.h  

FPermissionListOwners RemoveDenyListItemAndGetOwners ( FStringView Item
)

 Removes an item from the deny list and returns a list of all the owners of that item so that the item can be re-introduced. Misc/NamePermissionList.h  

FString ToString()

 Dumps the path permission list details into a multi-line string Misc/NamePermissionList.h  

bool UnregisterOwner ( const FName OwnerName
)

 Removes all filtering changes associated with a specific owner name. Misc/NamePermissionList.h  

bool UnregisterOwners ( const TArray< FName >& OwnerNames
)

 Removes all filtering changes associated with the specified list of owner names. Misc/NamePermissionList.h  

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

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

Protected

Name Remarks Include Path Unreal Specifiers

void VerifyItemMatchesListType ( const FStringView Item
) const

 Checks if an item is of a valid format for this list Misc/NamePermissionList.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Misc/NamePermissionList.h  
  Misc/NamePermissionList.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page