1. Epic GamesDeveloper
  3. FPathPermissionList

FPathPermissionList

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

Unreal Engine C++ API Reference > Runtime > Core > Misc

Inheritance Hierarchy

References

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

Syntax

class FPathPermissionList : public TSharedFromThis< FPathPermissionList >

Remarks

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.

Variables

  Type Name Description
Protected variable TDirectoryTree< FPermissionListOwners > AllowTree Compiled path tree produced from AllowList
Protected variable bool bSuppressOnFilterChanged Temporarily prevent delegate from being triggered
Protected variable FPermissionListOwners DenyListAll List of owner names that requested all items to be filtered out
Protected variable TDirectoryTree< FPermissionListOwners > DenyTree Compiled path tree produced from DenyList
Protected variable EPathPermissionListType ListType Type of paths this list represent
Protected variable FSimpleMulticastDelegate OnFilterChangedDelegate Triggered when filter changes

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Destructors

  Type Name Description
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS  

Functions

  Type Name Description
Public function bool

AddAllowListItem ( const FName OwnerName,
const TCHAR* Item
)

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

AddAllowListItem ( const FName OwnerName,
const FName Item
)

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

AddAllowListItem ( const FName OwnerName,
const FStringView Item
)

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

AddDenyListAll ( const FName OwnerName
)

 Set to filter out all items.
Public function bool

AddDenyListItem ( const FName OwnerName,
const TCHAR* Item
)

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

AddDenyListItem ( const FName OwnerName,
const FName Item
)

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

AddDenyListItem ( const FName OwnerName,
const FStringView Item
)

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

Append ( const FPathPermissionList& Other
)

 Add the specified filters to this one. Rules are not applied, direct append lists.
Public function Const FPathPermissionList

CombinePathFilters ( const FPathPermissionList& OtherFilter
)

 Combine two filters.
Public function Const bool Returns whether the given path has been denied explicitly with a call to AddDenyListItem.
Public function Const const TMap< FString, FPermissionListOwners > & Get raw allowlist
Public function Const TArray< FString > Returns a copy of the paths explicity allowed in this list
Public function Const const TMap< FString, FPermissionListOwners > & Get raw DenyList
Public function Const TArray< FString > Get a copy of the paths explicity denied in this list.
Public function Const TArray< FName > Gathers the names of all the owners in this DenyList.
Public function Const bool Returns whether this list has any explicitly allowed paths, which will lead to it denying access to any paths not listed.
Public function Const bool Returns whether this list has any explicitly denied paths.
Public function Const bool True if has filters active
Public function Const bool Are all items set to be filtered out
Public function FSimpleMulticastDelegate & Triggered when filter changes
Public function Const bool

PassesFilter ( const FStringView Item
)

 Returns true if passes filter restrictions using exact match
Public function Const bool

PassesFilter ( const FName Item
)

 Returns true if passes filter restrictions using exact match
Public function Const bool

PassesFilter ( const TCHAR* Item
)

 Returns true if passes filter restrictions using exact match
Public function Const bool

PassesStartsWithFilter ( const TCHAR* Item,
const bool bAllowParentPaths
)

 Returns true if passes filter restrictions for path
Public function Const bool

PassesStartsWithFilter ( const FName Item,
const bool bAllowParentPaths
)

 Returns true if passes filter restrictions for path
Public function Const bool

PassesStartsWithFilter ( const FStringView Item,
const bool bAllowParentPaths
)

 Returns true if passes filter restrictions for path
Public function Const EPathPermissionPrefixResult

PassesStartsWithFilterRecursive ( const FStringView Item,
const bool bAllowParentPaths
)

 Checks the given path against the restrictions and return whether it's possible for any child paths to succeed or fail as well.
Public function bool

RemoveAllowListItem ( const FName OwnerName,
const TCHAR* Item
)

 Remove item from the AllowList
Public function bool

RemoveAllowListItem ( const FName OwnerName,
const FName Item
)

 Remove item from the AllowList
Public function bool

RemoveAllowListItem ( const FName OwnerName,
const FStringView Item
)

 Remove item from the AllowList
Public function bool

RemoveDenyListItem ( const FName OwnerName,
const FStringView Item
)

 Remove item from the DenyList
Public function bool

RemoveDenyListItem ( const FName OwnerName,
const TCHAR* Item
)

 Remove item from the DenyList
Public function bool

RemoveDenyListItem ( const FName OwnerName,
const FName Item
)

 Remove item from the DenyList
Public function FPermissionListOwners 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.
Public function Const FString Dumps the path permission list details into a multi-line string
Public function bool

UnregisterOwner ( const FName OwnerName
)

 Removes all filtering changes associated with a specific owner name.
Public function bool

UnregisterOwners ( const TArray< FName >& OwnerNames
)

 Removes all filtering changes associated with the specified list of owner names.
Public function 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).
Protected function Const void Checks if an item is of a valid format for this list

Operators

  Type Name Description
Public function FPathPermissionList &  
Public function FPathPermissionList &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page