Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
IFilter< TItemType > Class Template Referenceabstract

#include <IFilter.h>

Public Types

typedef TItemType ItemType
 

Public Member Functions

virtual ~IFilter ()
 
virtual bool PassesFilter (TItemType InItem) const =0
 
 DECLARE_EVENT (IFilter< TItemType >, FChangedEvent)
 
virtual FChangedEvent & OnChanged ()=0
 

Detailed Description

template<typename TItemType>
class IFilter< TItemType >

A generic interface that represents a Filter of ItemType.

Definition at line 12 of file IFilter.h.

Member Typedef Documentation

◆ ItemType

template<typename TItemType >
typedef TItemType IFilter< TItemType >::ItemType

Definition at line 15 of file IFilter.h.

Constructor & Destructor Documentation

◆ ~IFilter()

template<typename TItemType >
virtual IFilter< TItemType >::~IFilter ( )
inlinevirtual

Definition at line 17 of file IFilter.h.

Member Function Documentation

◆ DECLARE_EVENT()

template<typename TItemType >
IFilter< TItemType >::DECLARE_EVENT ( IFilter< TItemType > ,
FChangedEvent  )

Broadcasts anytime the restrictions of the Filter changes

◆ OnChanged()

template<typename TItemType >
virtual FChangedEvent & IFilter< TItemType >::OnChanged ( )
pure virtual

Implemented in TDelegateFilter< ItemType >, and TTextFilter< ItemType >.

◆ PassesFilter()

template<typename TItemType >
virtual bool IFilter< TItemType >::PassesFilter ( TItemType InItem) const
pure virtual

Returns whether the specified Item passes the Filter's restrictions

Implemented in TDelegateFilter< ItemType >, and TTextFilter< ItemType >.

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