1. Epic GamesDeveloper
  3. FPathPermissionList

FPathPermissionList

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 >

Variables

  Type Name Description
Protected variable TMap< FString, FPermissionListOwners > AllowList List of items to allow, if not empty all items will be filtered out unless they are in the list
Protected variable bool bSuppressOnFilterChanged Temporarily prevent delegate from being triggered
Protected variable TMap< FString, FPermissionListOwners > DenyList List if items to filter out
Protected variable FPermissionListOwners DenyListAll List of owner names that requested all items to be filtered out
Protected variable EPathPermissionListType ListType Type of paths this list represent
Protected variable FSimpleMulticastDelegate OnFilterChangedDelegate Triggered when filter changes

Constructors

  Type Name Description
Public function  

FPathPermissionList ( EPathPermissionListType InType
)

  

Destructors

  Type Name Description
Public function Virtual    

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 const TMap< FString, FPermissionListOwners > & Get raw allowlist
Public function Const const TMap< FString, FPermissionListOwners > & Get raw DenyList
Public function Const TArray< FName > Gathers the names of all the owners in this DenyList.
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 FStringView 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 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 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

VerifyItemMatchesListType ( const FStringView Item
)

 Checks if an item is of a valid format for this list

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page