Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FPathPermissionList Class Reference

#include <NamePermissionList.h>

+ Inheritance diagram for FPathPermissionList:
+ Collaboration diagram for FPathPermissionList:

Public Member Functions

 FPathPermissionList (EPathPermissionListType InType=EPathPermissionListType::Default)
 
virtual ~FPathPermissionList ()
 
bool PassesFilter (const FStringView Item) const
 
bool PassesFilter (const FName Item) const
 
bool PassesFilter (const TCHAR *Item) const
 
bool PassesStartsWithFilter (const FStringView Item, const bool bAllowParentPaths=false) const
 
bool PassesStartsWithFilter (const FName Item, const bool bAllowParentPaths=false) const
 
bool PassesStartsWithFilter (const TCHAR *Item, const bool bAllowParentPaths=false) const
 
bool AddDenyListItem (const FName OwnerName, const FStringView Item)
 
bool AddDenyListItem (const FName OwnerName, const FName Item)
 
bool AddDenyListItem (const FName OwnerName, const TCHAR *Item)
 
bool RemoveDenyListItem (const FName OwnerName, const FStringView Item)
 
bool RemoveDenyListItem (const FName OwnerName, const FName Item)
 
bool RemoveDenyListItem (const FName OwnerName, const TCHAR *Item)
 
bool AddAllowListItem (const FName OwnerName, const FStringView Item)
 
bool AddAllowListItem (const FName OwnerName, const FName Item)
 
bool AddAllowListItem (const FName OwnerName, const TCHAR *Item)
 
bool RemoveAllowListItem (const FName OwnerName, const FStringView Item)
 
bool RemoveAllowListItem (const FName OwnerName, const FName Item)
 
bool RemoveAllowListItem (const FName OwnerName, const TCHAR *Item)
 
bool AddDenyListAll (const FName OwnerName)
 
bool HasFiltering () const
 
TArray< FName > GetOwnerNames () const
 
bool UnregisterOwner (const FName OwnerName)
 
bool UnregisterOwners (const TArray< FName > &OwnerNames)
 
bool Append (const FPathPermissionList &Other)
 
FPathPermissionList CombinePathFilters (const FPathPermissionList &OtherFilter) const
 
bool UnregisterOwnersAndAppend (const TArray< FName > &OwnerNamesToRemove, const FPathPermissionList &FiltersToAdd)
 
const TMap< FString, FPermissionListOwners > & GetDenyList () const
 
const TMap< FString, FPermissionListOwners > & GetAllowList () const
 
bool IsDenyListAll () const
 
FSimpleMulticastDelegate & OnFilterChanged ()
 
- Public Member Functions inherited from TSharedFromThis< FPathPermissionList >
TSharedRef< FPathPermissionList, Mode > AsShared ()
 
TSharedRef< FPathPermissionList const, Mode > AsShared () const
 
TWeakPtr< FPathPermissionList, Mode > AsWeak ()
 
TWeakPtr< FPathPermissionList const, Mode > AsWeak () const
 
FORCEINLINE void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, Mode > const *InSharedPtr, OtherType *InObject) const
 
FORCEINLINE void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, Mode > const *InSharedRef, OtherType *InObject) const
 
FORCEINLINE bool DoesSharedInstanceExist () const
 

Protected Member Functions

void VerifyItemMatchesListType (const FStringView Item) const
 
- Protected Member Functions inherited from TSharedFromThis< FPathPermissionList >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
FORCEINLINE TSharedFromThis & operator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Protected Attributes

TMap< FString, FPermissionListOwners > DenyList
 
TMap< FString, FPermissionListOwners > AllowList
 
FPermissionListOwners DenyListAll
 
FSimpleMulticastDelegate OnFilterChangedDelegate
 
bool bSuppressOnFilterChanged = false
 
EPathPermissionListType ListType
 

Additional Inherited Members

- Static Protected Member Functions inherited from TSharedFromThis< FPathPermissionList >
static FORCEINLINE TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static FORCEINLINE TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Detailed Description

Definition at line 125 of file NamePermissionList.h.

Constructor & Destructor Documentation

◆ FPathPermissionList()

FPathPermissionList::FPathPermissionList ( EPathPermissionListType InType = EPathPermissionListType::Default)
inline

Definition at line 128 of file NamePermissionList.h.

◆ ~FPathPermissionList()

virtual FPathPermissionList::~FPathPermissionList ( )
inlinevirtual

Definition at line 132 of file NamePermissionList.h.

Member Function Documentation

◆ AddAllowListItem() [1/3]

bool FPathPermissionList::AddAllowListItem ( const FName OwnerName,
const FName Item )

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

Returns
whether the filters changed.

◆ AddAllowListItem() [2/3]

bool FPathPermissionList::AddAllowListItem ( const FName OwnerName,
const FStringView Item )

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

Returns
whether the filters changed.

◆ AddAllowListItem() [3/3]

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

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

Returns
whether the filters changed.

◆ AddDenyListAll()

bool FPathPermissionList::AddDenyListAll ( const FName OwnerName)

Set to filter out all items.

Returns
whether the filters changed.

◆ AddDenyListItem() [1/3]

bool FPathPermissionList::AddDenyListItem ( const FName OwnerName,
const FName Item )

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

Returns
whether the filters changed.

◆ AddDenyListItem() [2/3]

bool FPathPermissionList::AddDenyListItem ( const FName OwnerName,
const FStringView Item )

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

Returns
whether the filters changed.

◆ AddDenyListItem() [3/3]

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

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

Returns
whether the filters changed.

◆ Append()

bool FPathPermissionList::Append ( const FPathPermissionList & Other)

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

Returns
whether the filters changed.

◆ CombinePathFilters()

FPathPermissionList FPathPermissionList::CombinePathFilters ( const FPathPermissionList & OtherFilter) const

Combine two filters. Result will contain all DenyList paths combined. Result will contain AllowList paths that pass both filters.

Returns
new combined filter.

◆ GetAllowList()

const TMap< FString, FPermissionListOwners > & FPathPermissionList::GetAllowList ( ) const
inline

Get raw allowlist

Definition at line 272 of file NamePermissionList.h.

◆ GetDenyList()

const TMap< FString, FPermissionListOwners > & FPathPermissionList::GetDenyList ( ) const
inline

Get raw DenyList

Definition at line 269 of file NamePermissionList.h.

◆ GetOwnerNames()

TArray< FName > FPathPermissionList::GetOwnerNames ( ) const

Gathers the names of all the owners in this DenyList.

◆ HasFiltering()

bool FPathPermissionList::HasFiltering ( ) const

True if has filters active

◆ IsDenyListAll()

bool FPathPermissionList::IsDenyListAll ( ) const
inline

Are all items set to be filtered out

Definition at line 275 of file NamePermissionList.h.

◆ OnFilterChanged()

FSimpleMulticastDelegate & FPathPermissionList::OnFilterChanged ( )
inline

Triggered when filter changes

Definition at line 278 of file NamePermissionList.h.

◆ PassesFilter() [1/3]

bool FPathPermissionList::PassesFilter ( const FName Item) const

Returns true if passes filter restrictions using exact match

◆ PassesFilter() [2/3]

bool FPathPermissionList::PassesFilter ( const FStringView Item) const

Returns true if passes filter restrictions using exact match

◆ PassesFilter() [3/3]

bool FPathPermissionList::PassesFilter ( const TCHAR * Item) const

Returns true if passes filter restrictions using exact match

◆ PassesStartsWithFilter() [1/3]

bool FPathPermissionList::PassesStartsWithFilter ( const FName Item,
const bool bAllowParentPaths = false ) const

Returns true if passes filter restrictions for path

◆ PassesStartsWithFilter() [2/3]

bool FPathPermissionList::PassesStartsWithFilter ( const FStringView Item,
const bool bAllowParentPaths = false ) const

Returns true if passes filter restrictions for path

◆ PassesStartsWithFilter() [3/3]

bool FPathPermissionList::PassesStartsWithFilter ( const TCHAR * Item,
const bool bAllowParentPaths = false ) const

Returns true if passes filter restrictions for path

◆ RemoveAllowListItem() [1/3]

bool FPathPermissionList::RemoveAllowListItem ( const FName OwnerName,
const FName Item )

Remove item from the AllowList

Returns
whether the filters changed

◆ RemoveAllowListItem() [2/3]

bool FPathPermissionList::RemoveAllowListItem ( const FName OwnerName,
const FStringView Item )

Remove item from the AllowList

Returns
whether the filters changed

◆ RemoveAllowListItem() [3/3]

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

Remove item from the AllowList

Returns
whether the filters changed

◆ RemoveDenyListItem() [1/3]

bool FPathPermissionList::RemoveDenyListItem ( const FName OwnerName,
const FName Item )

Remove item from the DenyList

Returns
whether the filters changed

◆ RemoveDenyListItem() [2/3]

bool FPathPermissionList::RemoveDenyListItem ( const FName OwnerName,
const FStringView Item )

Remove item from the DenyList

Returns
whether the filters changed

◆ RemoveDenyListItem() [3/3]

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

Remove item from the DenyList

Returns
whether the filters changed

◆ UnregisterOwner()

bool FPathPermissionList::UnregisterOwner ( const FName OwnerName)

Removes all filtering changes associated with a specific owner name.

Returns
whether the filters changed.

◆ UnregisterOwners()

bool FPathPermissionList::UnregisterOwners ( const TArray< FName > & OwnerNames)

Removes all filtering changes associated with the specified list of owner names.

Returns
whether the filters changed.

◆ UnregisterOwnersAndAppend()

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

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

Returns
whether the filters changed.

◆ VerifyItemMatchesListType()

void FPathPermissionList::VerifyItemMatchesListType ( const FStringView Item) const
protected

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

Returns
True if the item passes list type test.

Member Data Documentation

◆ AllowList

TMap<FString, FPermissionListOwners> FPathPermissionList::AllowList
protected

List of items to allow, if not empty all items will be filtered out unless they are in the list

Definition at line 292 of file NamePermissionList.h.

◆ bSuppressOnFilterChanged

bool FPathPermissionList::bSuppressOnFilterChanged = false
protected

Temporarily prevent delegate from being triggered

Definition at line 301 of file NamePermissionList.h.

◆ DenyList

TMap<FString, FPermissionListOwners> FPathPermissionList::DenyList
protected

List if items to filter out

Definition at line 289 of file NamePermissionList.h.

◆ DenyListAll

FPermissionListOwners FPathPermissionList::DenyListAll
protected

List of owner names that requested all items to be filtered out

Definition at line 295 of file NamePermissionList.h.

◆ ListType

EPathPermissionListType FPathPermissionList::ListType
protected

Type of paths this list represent

Definition at line 304 of file NamePermissionList.h.

◆ OnFilterChangedDelegate

FSimpleMulticastDelegate FPathPermissionList::OnFilterChangedDelegate
protected

Triggered when filter changes

Definition at line 298 of file NamePermissionList.h.

The documentation for this class was generated from the following file: