Navigation
API > API/Runtime > API/Runtime/TypedElementFramework
Product of boolean combination of multiple columns. This can be used to verify if a collection of columns match the stored columns. NOTE: You must call Compile() before you call any members accessing the conditions
| Name | FConditions |
| Type | class |
| Header File | /Engine/Source/Runtime/TypedElementFramework/Public/DataStorage/Queries/Conditions.h |
| Include Path | #include "DataStorage/Queries/Conditions.h" |
Syntax
class FConditions
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FConditions
(
FColumnBase Column |
Not marked as "explicit" to allow conversion from a column. | DataStorage/Queries/Conditions.h | |
FConditions () |
DataStorage/Queries/Conditions.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ColumnArray | TArray< TWeakObjectPtr< const UScriptStruct >, TInlineAllocator< MaxColumnCount > > | DataStorage/Queries/Conditions.h | |
| ColumnFlagArray | TArray< EColumnFlags, TInlineAllocator< MaxColumnCount > > | DataStorage/Queries/Conditions.h | |
| ContainsCallback | TFunctionRef< bool(uint8_t ColumnIndex, TWeakObjectPtr< const UScriptStruct > Column)> | DataStorage/Queries/Conditions.h | |
| IdentifierArray | TArray< FName, TInlineAllocator< MaxColumnCount > > | DataStorage/Queries/Conditions.h | |
| TokenArray | TArray< Token, TInlineAllocator< MaxTokenCount > > | DataStorage/Queries/Conditions.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MaxColumnCount | SIZE_T | DataStorage/Queries/Conditions.h | |
| MaxTokenCount | SIZE_T | DataStorage/Queries/Conditions.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsCompiled | bool | DataStorage/Queries/Conditions.h | ||
| ColumnCount | uint8_t | DataStorage/Queries/Conditions.h | ||
| ColumnFlags | ColumnFlagArray | DataStorage/Queries/Conditions.h | ||
| Columns | ColumnArray | DataStorage/Queries/Conditions.h | ||
| Identifiers | IdentifierArray | DataStorage/Queries/Conditions.h | ||
| TokenCount | uint8_t | DataStorage/Queries/Conditions.h | ||
| Tokens | TokenArray | DataStorage/Queries/Conditions.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AppendToString
(
FString& Output |
Convert the conditions into a string and append them to the provided string. | DataStorage/Queries/Conditions.h | |
FConditions & Compile
(
const IQueryConditionCompileContext& CompileContext |
Compile must be called before using any functions that access the columns. | DataStorage/Queries/Conditions.h | |
TConstArrayView< TWeakObjectPtr< const UScriptStruct > > GetColumns() |
Returns a list of all columns used. This can include duplicate columns. | DataStorage/Queries/Conditions.h | |
bool IsCompiled() |
Check whether these query conditions have been compiled. | DataStorage/Queries/Conditions.h | |
bool IsEmpty() |
Whether or not there are any columns registered for operation. | DataStorage/Queries/Conditions.h | |
uint8_t MinimumColumnMatchRequired() |
Returns the minimum number of columns needed for a successful match. | DataStorage/Queries/Conditions.h | |
bool UsesDynamicTemplates() |
Whether the conditions contain any columns that are dynamic templates. | DataStorage/Queries/Conditions.h | |
bool Verify
(
TConstArrayView< FColumnBase > AvailableColumns |
Runs the provided list of columns through the conditions and returns true if a valid combination of columns is found. | DataStorage/Queries/Conditions.h | |
bool Verify
(
TSet< TWeakObjectPtr< const UScriptStruct > > AvailableColumns |
Runs the provided list of columns through the conditions and returns true if a valid combination of columns is found. | DataStorage/Queries/Conditions.h | |
bool Verify
(
ContainsCallback Callback |
Runs through the list of query conditions and uses the callback to verify if a column is available. | DataStorage/Queries/Conditions.h | |
bool Verify
(
TConstArrayView< TWeakObjectPtr< const UScriptStruct > > AvailableColumns, |
Runs the provided list of columns through the conditions and returns true if a valid combination of columns is found. | DataStorage/Queries/Conditions.h | |
bool Verify
(
TArray< TWeakObjectPtr< const UScriptStruct > >& MatchedColumns, |
Runs the provided list of columns through the conditions and returns true if a valid combination of columns is found. | DataStorage/Queries/Conditions.h | |
bool Verify
(
TArray< TWeakObjectPtr< const UScriptStruct > >& MatchedColumns, |
Runs the provided list of columns through the conditions and returns true if a valid combination of columns is found. | DataStorage/Queries/Conditions.h | |
bool VerifyWithDynamicColumn
(
TConstArrayView< AvailableColumnType > AvailableColumns, |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AppendQuery
(
FConditions& Target, |
DataStorage/Queries/Conditions.h |