FNamePermissionList

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc

Inheritance Hierarchy

References

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

Syntax

class FNamePermissionList : public TSharedFromThis< FNamePermissionList >

Variables

  Type Name Description
Protected variable TMap< FName, 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< FName, 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 FSimpleMulticastDelegate OnFilterChangedDelegate Triggered when filter changes

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
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

AddDenyListAll ( const FName OwnerName
)

 Set to filter out all items.
Public function bool

AddDenyListItem ( const FName OwnerName,
const FName Item
)

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

Append ( const FNamePermissionList& Other
)

 Add the specified filters to this one.
Public function Const const TMap< FName, FPermissionListOwners > & Get raw allowlist
Public function Const const TMap< FName, 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 FName Item
)

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

RemoveAllowListItem ( const FName OwnerName,
const FName Item
)

 Removes a previously-added item from the allowlist.
Public function bool

RemoveDenyListItem ( const FName OwnerName,
const FName Item
)

 Removes a previously-added item from the DenyList.
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 FNamePermissionList& FiltersToAdd
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page