Navigation
API > API/Runtime > API/Runtime/TypedElementFramework
Base interface for any contexts provided to query callbacks.
| Name | ICommonQueryContext |
| Type | struct |
| Header File | /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h |
| Include Path | #include "Elements/Interfaces/TypedElementQueryStorageInterfaces.h" |
Syntax
struct ICommonQueryContext
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ICommonQueryContext() |
Elements/Interfaces/TypedElementQueryStorageInterfaces.h |
Structs
| Name | Remarks |
|---|---|
| FEmplaceObjectParams |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const UScriptStruct * FindDynamicColumnType
(
const FName& Identifier |
Elements/Interfaces/TypedElementQueryStorageInterfaces.h | ||
const UScriptStruct * FindDynamicColumnType
(
const FDynamicColumnDescription& Description |
Finds the type of a dynamic column | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
| Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |||
const void * GetColumn
(
const UScriptStruct* ColumnType |
Return the address of a immutable column matching the requested type or a nullptr if not found. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
const Column * GetColumn () |
Return the address of a immutable column matching the requested type or a nullptr if not found. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
void GetColumns
(
TArrayView< char* > RetrievedAddresses, |
Get a list of columns or nullptrs if the column type wasn't found. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
void GetColumnsUnguarded
(
int32 TypeCount, |
Get a list of columns or nullptrs if the column type wasn't found. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
float GetDeltaTimeSeconds() |
Returns the amount of time now and the last update in seconds. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
Column * GetMutableColumn () |
Return the address of a mutable column matching the requested type or a nullptr if not found. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
TemplateType * GetMutableColumn
(
const FName& Identifier |
Elements/Interfaces/TypedElementQueryStorageInterfaces.h | ||
void * GetMutableColumn
(
const UScriptStruct* ColumnType |
Return the address of a mutable column matching the requested type or a nullptr if not found. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
RowHandle GetParentRow
(
RowHandle Target |
Gets the Target's Parent if the query has a configured Hierarchy. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
uint32 GetRowCount() |
Returns the number rows in the batch. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
TConstArrayView< RowHandle > GetRowHandles () |
Returns an immutable view that contains the row handles for all returned results. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
bool HasColumn () |
Returns whether a column matches the requested type or not. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
bool HasColumn
(
const UScriptStruct* ColumnType |
Returns whether a column matches the requested type or not. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
bool HasColumn
(
RowHandle Row |
Return whether a column matches the requested type or not. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
bool HasColumn
(
RowHandle Row, |
Return whether a column matches the requested type or not. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
| Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |||
void PushCommand
(
T CommandContext |
Creates a command that will run at the termination of an execution context. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
void PushCommand
(
void(*)(void*) CommandFunction, |
Elements/Interfaces/TypedElementQueryStorageInterfaces.h | ||
void SetParentRow
(
RowHandle Target, |
Sets the Target's Parent if the query has a configured Hierarchy. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h | |
void SetUnresolvedParent
(
RowHandle Target, |
Establishes a parent relationship between the Target row and a Parent that is not registered in TEDS yet. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void * EmplaceObjectInScratch
(
const FEmplaceObjectParams& Params |
Required as the interface doesn't have direct access to any temporary handling of memory in the backend. | Elements/Interfaces/TypedElementQueryStorageInterfaces.h |