1. Epic GamesDeveloper
  3. ICommonQueryWithEnvironmentContext

ICommonQueryWithEnvironmentContext

API > API/Runtime > API/Runtime/TypedElementFramework

   
Name ICommonQueryWithEnvironmentContext
Type struct
Header File /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Include Path #include "Elements/Interfaces/TypedElementQueryStorageInterfaces.h"

Syntax

struct ICommonQueryWithEnvironmentContext : public UE::Editor::DataStorage::ICommonQueryContext

Derived Classes

Typedefs

Name Type Remarks Include Path
ObjectCopyOrMove void(*)(const UScriptStruct &TypeInfo, void *Destination, void *Source)   Elements/Interfaces/TypedElementQueryStorageInterfaces.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ActivateQueries ( FName ActivationName
)

 Triggers all queries registered under the activation name to run for one update cycle. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

ColumnType & AddColumn ( RowHandle Row,
ColumnType&& Column
)

 Adds the provided column to the requested row. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

ColumnTypeTemplate * AddColumn ( RowHandle Row,
const FName& Identifier
)

 Helper template for adding a dynamic column to the requested row. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

ColumnTypeTemplate & AddColumn ( RowHandle Row,
const FName& Identifier,
ColumnTypeTemplate&& Column
)

 Helper template for adding a dynamic column to the requested row Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void AddColumns ( TConstArrayView< RowHandle > Rows,
TConstArrayView< FDynamicColumnDescription > DynamicColumnDescriptions
)

   Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void AddColumns ( TConstArrayView< RowHandle > Rows,
TConstArrayView< const UScriptStruct* > ColumnTypes
)

 Adds new empty columns to the listed rows of the provided type. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void AddColumns ( RowHandle Row,
TConstArrayView< const UScriptStruct* > ColumnTypes
)

 Adds new empty columns to a row of the provided type. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void AddColumns ( RowHandle Row
)

 Adds new empty columns to a row of the provided type. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void AddColumns ( TConstArrayView< RowHandle > Rows
)

 Adds new empty columns to the listed rows of the provided type. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void * AddColumnUninitialized ( RowHandle Row,
const FDynamicColumnDescription& DynamicColumnDescription,
ObjectCopyOrMove Relocator
)

   Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void * AddColumnUninitialized ( RowHandle Row,
const FDynamicColumnDescription& DynamicColumnDescription
)

   Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void * AddColumnUninitialized ( RowHandle Row,
const UScriptStruct* ColumnType
)

 Add a new uninitialized column of the provided type if one does not exist. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void * AddColumnUninitialized ( RowHandle Row,
const UScriptStruct* ObjectType,
ObjectCopyOrMove Relocator
)

 Add a new uninitialized column of the provided type if one does not exist. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

RowHandle AddRow ( TableHandle Table
)

 Adds a row to the given table. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

const DynamicColumnTemplate * GetColumn ( const FName& Identifier
) const

 Helper template that returns a const reference to the column array data for the range of rows being processed Returns nullptr if type not found or column not assigned to row 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  

Column * GetMutableColumn ()

 Return the address of a mutable column matching the requested type or a nullptr if not found. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

DynamicColumnTemplate * GetMutableColumn ( const FName& Identifier
)

 Helper template that returns the reference to the column array data for the range of rows being processed Returns nullptr if type not found or column not assigned to row Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

uint64 GetUpdateCycleId ()

 Returns the id for the current update cycle. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

bool HasColumn ( RowHandle Row,
const FName& Identifier
) const

 Helper template to return whether a row has a given dynamic column. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

bool HasColumn ()

 Returns whether a column matches the requested type or not. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

bool HasColumn ( const FName& Identifier
) const

 Helper template to return whether a row has a given dynamic column. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

bool HasColumn ( RowHandle Row
) const

 Return whether a column matches the requested type or not. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

bool IsRowAssigned ( RowHandle Row
) const

 Checks whether or not a row has been reserved but not yet assigned to a table. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

bool IsRowAvailable ( RowHandle Row
) const

 Checks whether or not a row is in use. This is true even if the row has only been reserved. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void RemoveColumns ( RowHandle Row
)

 Removes columns of the provided types from a row. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void RemoveColumns ( TConstArrayView< RowHandle > Rows
)

 Removes columns of the provided types from the listed rows. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void RemoveColumns ( TConstArrayView< RowHandle > Rows,
TConstArrayView< const UScriptStruct* > ColumnTypes
)

 Removes columns of the provided types from the listed rows. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void RemoveColumns ( RowHandle Row,
TConstArrayView< const UScriptStruct* > ColumnTypes
)

 Removes columns of the provided types from a row. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void RemoveRow ( RowHandle Row
)

 Removes the row with the provided row handle. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

void RemoveRows ( TConstArrayView< RowHandle > Rows
)

 Removes rows with the provided row handles. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

Overridden from ICommonQueryContext

Name Remarks Include Path Unreal Specifiers

virtual const void * GetColumn ( const UScriptStruct* ColumnType
) const

 Return the address of a immutable column matching the requested type or a nullptr if not found. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

virtual 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  

virtual bool HasColumn ( const UScriptStruct* ColumnType
) const

 Returns whether a column matches the requested type or not. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

virtual bool HasColumn ( RowHandle Row,
const UScriptStruct* ColumnType
) const

 Return whether a column matches the requested type or not. Elements/Interfaces/TypedElementQueryStorageInterfaces.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page