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

#include <NamePermissionList.h>

+ Inheritance diagram for FNamePermissionList:
+ Collaboration diagram for FNamePermissionList:

Public Member Functions

 FNamePermissionList ()
 
virtual ~FNamePermissionList ()
 
bool PassesFilter (const FName Item) const
 
bool AddDenyListItem (const FName OwnerName, const FName Item)
 
bool AddAllowListItem (const FName OwnerName, const FName Item)
 
bool RemoveDenyListItem (const FName OwnerName, const FName Item)
 
bool RemoveAllowListItem (const FName OwnerName, const FName 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 FNamePermissionList &Other)
 
bool UnregisterOwnersAndAppend (const TArray< FName > &OwnerNamesToRemove, const FNamePermissionList &FiltersToAdd)
 
const TMap< FName, FPermissionListOwners > & GetDenyList () const
 
const TMap< FName, FPermissionListOwners > & GetAllowList () const
 
bool IsDenyListAll () const
 
FSimpleMulticastDelegate & OnFilterChanged ()
 
- Public Member Functions inherited from TSharedFromThis< FNamePermissionList >
TSharedRef< FNamePermissionList, Mode > AsShared ()
 
TSharedRef< FNamePermissionList const, Mode > AsShared () const
 
TWeakPtr< FNamePermissionList, Mode > AsWeak ()
 
TWeakPtr< FNamePermissionList 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 Attributes

TMap< FName, FPermissionListOwners > DenyList
 
TMap< FName, FPermissionListOwners > AllowList
 
FPermissionListOwners DenyListAll
 
FSimpleMulticastDelegate OnFilterChangedDelegate
 
bool bSuppressOnFilterChanged = false
 

Additional Inherited Members

- Protected Member Functions inherited from TSharedFromThis< FNamePermissionList >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
FORCEINLINE TSharedFromThis & operator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< FNamePermissionList >
static FORCEINLINE TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static FORCEINLINE TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Detailed Description

Definition at line 20 of file NamePermissionList.h.

Constructor & Destructor Documentation

◆ FNamePermissionList()

FNamePermissionList::FNamePermissionList ( )
inline

Definition at line 23 of file NamePermissionList.h.

◆ ~FNamePermissionList()

virtual FNamePermissionList::~FNamePermissionList ( )
inlinevirtual

Definition at line 24 of file NamePermissionList.h.

Member Function Documentation

◆ AddAllowListItem()

bool FNamePermissionList::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.

◆ AddDenyListAll()

bool FNamePermissionList::AddDenyListAll ( const FName OwnerName)

Set to filter out all items.

Returns
whether the filters changed.

◆ AddDenyListItem()

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

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

Returns
whether the filters changed.

◆ Append()

bool FNamePermissionList::Append ( const FNamePermissionList & Other)

Add the specified filters to this one.

Returns
whether the filters changed.

◆ GetAllowList()

const TMap< FName, FPermissionListOwners > & FNamePermissionList::GetAllowList ( ) const
inline

Get raw allowlist

Definition at line 93 of file NamePermissionList.h.

◆ GetDenyList()

const TMap< FName, FPermissionListOwners > & FNamePermissionList::GetDenyList ( ) const
inline

Get raw DenyList

Definition at line 90 of file NamePermissionList.h.

◆ GetOwnerNames()

TArray< FName > FNamePermissionList::GetOwnerNames ( ) const

Gathers the names of all the owners in this DenyList.

◆ HasFiltering()

bool FNamePermissionList::HasFiltering ( ) const

True if has filters active

◆ IsDenyListAll()

bool FNamePermissionList::IsDenyListAll ( ) const
inline

Are all items set to be filtered out

Definition at line 96 of file NamePermissionList.h.

◆ OnFilterChanged()

FSimpleMulticastDelegate & FNamePermissionList::OnFilterChanged ( )
inline

Triggered when filter changes

Definition at line 99 of file NamePermissionList.h.

◆ PassesFilter()

bool FNamePermissionList::PassesFilter ( const FName Item) const

Returns true if passes filter restrictions using exact match

◆ RemoveAllowListItem()

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

Removes a previously-added item from the allowlist.

Returns
whether the filters changed.

◆ RemoveDenyListItem()

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

Removes a previously-added item from the DenyList.

Returns
whether the filters changed.

◆ UnregisterOwner()

bool FNamePermissionList::UnregisterOwner ( const FName OwnerName)

Removes all filtering changes associated with a specific owner name.

Returns
whether the filters changed.

◆ UnregisterOwners()

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

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

Returns
whether the filters changed.

◆ UnregisterOwnersAndAppend()

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

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

Returns
whether the filters changed.

Member Data Documentation

◆ AllowList

TMap<FName, FPermissionListOwners> FNamePermissionList::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 107 of file NamePermissionList.h.

◆ bSuppressOnFilterChanged

bool FNamePermissionList::bSuppressOnFilterChanged = false
protected

Temporarily prevent delegate from being triggered

Definition at line 116 of file NamePermissionList.h.

◆ DenyList

TMap<FName, FPermissionListOwners> FNamePermissionList::DenyList
protected

List if items to filter out

Definition at line 104 of file NamePermissionList.h.

◆ DenyListAll

FPermissionListOwners FNamePermissionList::DenyListAll
protected

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

Definition at line 110 of file NamePermissionList.h.

◆ OnFilterChangedDelegate

FSimpleMulticastDelegate FNamePermissionList::OnFilterChangedDelegate
protected

Triggered when filter changes

Definition at line 113 of file NamePermissionList.h.

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