className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
ICommonQueryContext
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Base interface for any contexts provided to query callbacks.
TypedElementFramework
struct ICommonQueryContext
[]
IDirectQueryContext::~IDirectQueryContext
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
TypedElementFramework
virtual ~IDirectQueryContext()
[]
IQueryContext::AddColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
TypedElementFramework
template<typename... Columns> void AddColumns ( [RowHandle](API\Runtime\TypedElementFramework\Elements\Common\RowHandle) Row )
[]
IDirectQueryContext
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Interface to be provided to query callbacks that are directly called through RunQuery from outside a query callback.
TypedElementFramework
struct IDirectQueryContext : public [TypedElementDataStorage::ICommonQueryContext](API\Runtime\TypedElementFramework\Elements\Interfaces\ICommonQueryContext)
[]
IQueryContext::AddColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Adds new empty columns to a row of the provided type. The addition will not be immediately done but delayed until the end of the tick group.
TypedElementFramework
template<typename... Columns> void AddColumns ( TConstArrayView< [RowHandle](API\Runtime\TypedElementFramework\Elements\Common\RowHandle) > Rows )
[]
IQueryContext::AddColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Adds new empty columns to a row of the provided type. The addition will not be immediately done but delayed until the end of the tick group.
TypedElementFramework
void AddColumns ( [RowHandle](API\Runtime\TypedElementFramework\Elements\Common\RowHandle) Row, TConstArrayView< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > ColumnTypes )
[]
IQueryContext::AddColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Adds new empty columns to the listed rows of the provided type. The addition will not be immediately done but delayed until the end of the tick group.
TypedElementFramework
void AddColumns ( TConstArrayView< [RowHandle](API\Runtime\TypedElementFramework\Elements\Common\RowHandle) > Rows, TConstArrayView< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > ColumnTypes )
[]
IQueryContext::GetDependencies
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Returns a list of dependencies or nullptrs if a dependency wasn't found. Mutable versions are return and it's up to the caller to not change immutable dependencies.
TypedElementFramework
void GetDependencies ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > RetrievedAddresses, TConstArrayView< [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< const [UClass](API\Runtime\CoreUObject\UObject\UClass) >> DependencyTypes, TConstArrayView< [EQueryAccessType](API\Runtime\TypedElementFramework\Elements\Common\TypedElementData-_3) > AccessTypes )
[]
IQueryContext::GetDependency
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Returns an immutable instance of the requested dependency or a nullptr if not found.
TypedElementFramework
const [UObject](API\Runtime\CoreUObject\UObject\UObject) * GetDependency ( const [UClass](API\Runtime\CoreUObject\UObject\UClass) * DependencyClass )
[]
IQueryContext::GetMutableDependency
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Returns a mutable instance of the requested dependency or a nullptr if not found.
TypedElementFramework
[UObject](API\Runtime\CoreUObject\UObject\UObject) * GetMutableDependency ( const [UClass](API\Runtime\CoreUObject\UObject\UClass) * DependencyClass )
[]
IQueryContext::RemoveColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
TypedElementFramework
template<typename... Columns> void RemoveColumns ( TConstArrayView< [RowHandle](API\Runtime\TypedElementFramework\Elements\Common\RowHandle) > Rows )
[]
IQueryContext::RemoveColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
TypedElementFramework
template<typename... Columns> void RemoveColumns ( [RowHandle](API\Runtime\TypedElementFramework\Elements\Common\RowHandle) Row )
[]
IQueryContext::RemoveColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Removes columns of the provided types from a row. The removal will not be immediately done but delayed until the end of the tick group.
TypedElementFramework
void RemoveColumns ( [RowHandle](API\Runtime\TypedElementFramework\Elements\Common\RowHandle) Row, TConstArrayView< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > ColumnTypes )
[]
IQueryContext::RemoveColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Removes columns of the provided types from the listed rows. The removal will not be immediately done but delayed until the end of the tick group.
TypedElementFramework
void RemoveColumns ( TConstArrayView< [RowHandle](API\Runtime\TypedElementFramework\Elements\Common\RowHandle) > Rows, TConstArrayView< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > ColumnTypes )
[]
IQueryContext::RemoveRows
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Removes rows with the provided row handles. The removal will not be immediately done but delayed until the end of the tick group.
TypedElementFramework
void RemoveRows ( TConstArrayView< [RowHandle](API\Runtime\TypedElementFramework\Elements\Common\RowHandle) > Rows )
[]
IQueryContext::RemoveRow
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Removes the row with the provided row handle. The removal will not be immediately done but delayed until the end of the tick group.
TypedElementFramework
void RemoveRow ( [RowHandle](API\Runtime\TypedElementFramework\Elements\Common\RowHandle) Row )
[]
IQueryContext::RunQuery
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Runs a previously created query. This version takes an arbitrary query, but is limited to running queries that do not directly access data from rows such as count queries.
TypedElementFramework
[FQueryResult](API\Runtime\TypedElementFramework\Elements\Common\FQueryResult) RunQuery ( [QueryHandle](API\Runtime\TypedElementFramework\Elements\Common\QueryHandle) Query )
[]
IQueryContext::RunSubquery
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Runs a subquery registered with the current query. The subquery index is in the order of registration with the query.
TypedElementFramework
[FQueryResult](API\Runtime\TypedElementFramework\Elements\Common\FQueryResult) RunSubquery ( int32 SubqueryIndex )
[]
IQueryContext::~IQueryContext
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
TypedElementFramework
virtual ~IQueryContext()
[]
ISubqueryContext
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Interface to be provided to query callbacks that are directly called through from a query callback.
TypedElementFramework
struct ISubqueryContext : public [TypedElementDataStorage::ICommonQueryContext](API\Runtime\TypedElementFramework\Elements\Interfaces\ICommonQueryContext)
[]
IQueryContext
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
Interface to be provided to query callbacks running with the Data Storage. Note that at the time of writing only subclasses of Subsystem are supported as dependencies.
TypedElementFramework
struct IQueryContext : public [TypedElementDataStorage::ICommonQueryContext](API\Runtime\TypedElementFramework\Elements\Interfaces\ICommonQueryContext)
[]
ITypedElementDataStorageCompatibilityInterface::AddCompatibleObject
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
These allow compatibility with any type. These do eventually fall back to the explicit versions. Any references given are non-owning so it's up to the caller to deregister the object after it's no longer available. Adds a reference to an existing object to the data storage. The data storage does NOT take ownership of the object and the caller is responsible for managing the life cycle of the object. The address is only used for associating the object with a row and to setup the initial row data.
TypedElementFramework
template<typename ObjectType> TypedElementRowHandle AddCompatibleObject ( ObjectType Object, TypedElementTableHandle Table )
[]
ISubqueryContext::~ISubqueryContext
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementQueryStorageInterfaces.h
TypedElementFramework
virtual ~ISubqueryContext()
[]
ITypedElementDataStorageCompatibilityInterface::AddCompatibleObjectExplicit
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
Adds an actor to the data storage.
TypedElementFramework
TypedElementRowHandle AddCompatibleObjectExplicit ( [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor )
[]
ITypedElementDataStorageCompatibilityInterface::AddCompatibleObject
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
These allow compatibility with any type. These do eventually fall back to the explicit versions. Any references given are non-owning so it's up to the caller to deregister the object after it's no longer available. Adds a reference to an existing object to the data storage. The data storage does NOT take ownership of the object and the caller is responsible for managing the life cycle of the object. The address is only used for associating the object with a row and to setup the initial row data.
TypedElementFramework
template<typename ObjectType> TypedElementRowHandle AddCompatibleObject ( ObjectType Object )
[]
ITypedElementDataStorageCompatibilityInterface::AddCompatibleObjectExplicit
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
TypedElementFramework
TypedElementRowHandle AddCompatibleObjectExplicit ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object, TypedElementTableHandle Table )
[]
ITypedElementDataStorageCompatibilityInterface::AddCompatibleObjectExplicit
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
These are functions that work on specific types.Adds aUObjectto the data storage.
TypedElementFramework
TypedElementRowHandle AddCompatibleObjectExplicit ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )
[]
ITypedElementDataStorageCompatibilityInterface::AddCompatibleObjectExplicit
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
TypedElementFramework
TypedElementRowHandle AddCompatibleObjectExplicit ( [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor, TypedElementTableHandle Table )
[]
ITypedElementDataStorageCompatibilityInterface::AddCompatibleObjectExplicit
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
Adds an FStruct to the data storage.
TypedElementFramework
TypedElementRowHandle AddCompatibleObjectExplicit ( void * Object, [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) > TypeInfo )
[]
ITypedElementDataStorageCompatibilityInterface::AddCompatibleObjectExplicit
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
TypedElementFramework
TypedElementRowHandle AddCompatibleObjectExplicit ( void * Object, [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) > TypeInfo, TypedElementTableHandle Table )
[]
ITypedElementDataStorageCompatibilityInterface::FindRowWithCompatibleObject
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
TypedElementFramework
template<typename ObjectType> TypedElementRowHandle FindRowWithCompatibleObject ( const ObjectType Object ) const
[]
ITypedElementDataStorageCompatibilityInterface::FindRowWithCompatibleObjectExplicit
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
Finds a previously stored actor based on the object key. If not found an invalid row handle will be returned. While FindRowWithCompatibleObject(const TObjectKeyObject) can also be used, this call will be slightly faster if it's already known that the target is an actor.
TypedElementFramework
TypedElementRowHandle FindRowWithCompatibleObjectExplicit ( const [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor ) const
[]
ITypedElementDataStorageCompatibilityInterface::FindRowWithCompatibleObjectExplicit
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
Finds a previously storedUObject. If not found an invalid row handle will be returned.
TypedElementFramework
TypedElementRowHandle FindRowWithCompatibleObjectExplicit ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object ) const
[]
ITypedElementDataStorageCompatibilityInterface::FindRowWithCompatibleObjectExplicit
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
Finds a previously stored FStructe . If not found an invalid row handle will be returned.
TypedElementFramework
TypedElementRowHandle FindRowWithCompatibleObjectExplicit ( const void * Object ) const
[]
ITypedElementDataStorageCompatibilityInterface::RemoveCompatibleObject
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
Removes a previously registered object from the data storage.
TypedElementFramework
template<typename ObjectType> void RemoveCompatibleObject ( ObjectType Object )
[]
ITypedElementDataStorageCompatibilityInterface::RemoveCompatibleObjectExplicit
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
Removes aUObjectfrom the data storage.
TypedElementFramework
void RemoveCompatibleObjectExplicit ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )
[]
ITypedElementDataStorageCompatibilityInterface::RemoveCompatibleObjectExplicit
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
Removes an actor from the data storage.
TypedElementFramework
void RemoveCompatibleObjectExplicit ( [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor )
[]
ITypedElementDataStorageCompatibilityInterface::RemoveCompatibleObjectExplicit
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
Removes an FStruct from the data storage.
TypedElementFramework
void RemoveCompatibleObjectExplicit ( void * Object )
[]
ITypedElementDataStorageCompatibilityInterface
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageCompatibilityInterface.h
Interface to provide compatibility with existing systems that don't directly support the data storage.
TypedElementFramework
class ITypedElementDataStorageCompatibilityInterface
[]
ITypedElementDataStorageInterface::AddColumn
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
The following are utility functions that are not part of the interface but are provided in order to make using the interface easier.Adds a column to a row or does nothing if already added.
TypedElementFramework
template<typename Column> bool AddColumn ( TypedElementRowHandle Row )
[]
ITypedElementDataStorageInterface::AddColumn
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Management
TypedElementFramework
bool AddColumn ( TypedElementRowHandle Row, const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * ColumnType )
[]
ITypedElementDataStorageInterface::AddColumn
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
bool AddColumn ( TypedElementRowHandle Row, [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) ColumnName )
[]
ITypedElementDataStorageInterface::AddColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Adds multiple columns from a row. This is typically more efficient than adding columns one at a time.
TypedElementFramework
template<typename... Columns> void AddColumns ( TypedElementRowHandle Row )
[]
ITypedElementDataStorageInterface::AddColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Adds multiple columns from a row. This is typically more efficient than adding columns one at a time.
TypedElementFramework
bool AddColumns ( TypedElementRowHandle Row, TConstArrayView< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > Columns )
[]
ITypedElementDataStorageInterface::AddOrGetColumn
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Returns a pointer to the column of the given row or creates a new one if not found. Optionally arguments can be provided to update or initialize the column's data.
TypedElementFramework
template<typename ColumnType, typename... Args> ColumnType * AddOrGetColumn ( TypedElementRowHandle Row, Args... Arguments )
[]
ITypedElementDataStorageInterface::AddOrGetColumnData
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Adds a new column to a row. If the column already exists it will be returned instead. If the colum couldn't be added or the column type points to a tag an nullptr will be returned.
TypedElementFramework
void * AddOrGetColumnData ( TypedElementRowHandle Row, const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * ColumnType )
[]
ITypedElementDataStorageInterface::AddOrGetColumnData
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
[ColumnDataResult](API\Runtime\TypedElementFramework\Elements\Interfaces\ColumnDataResult) AddOrGetColumnData ( TypedElementRowHandle Row, [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) ColumnName )
[]
ITypedElementDataStorageInterface::AddOrGetColumnData
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Sets the data of a column using the provided argument bag. This is only meant for simple initialization for fragments that use UPROPERTY to expose properties. For complex initialization or when the fragment type is known it's recommended to use calls that work directly on the type for better performance and a wider range of configuration options. If the column couldn't be created or the column name points to a tag, then the result will contain only nullptrs.
TypedElementFramework
[ColumnDataResult](API\Runtime\TypedElementFramework\Elements\Interfaces\ColumnDataResult) AddOrGetColumnData ( TypedElementRowHandle Row, [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) ColumnName, TConstArrayView< [TypedElement::ColumnUtils::Argument](API\Runtime\TypedElementFramework\Elements\Framework\Argument) > Arguments )
[]
ITypedElementDataStorageInterface::AddRemoveColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Adds and removes the provided column types from the provided row. This is typically more efficient than individually adding and removing columns as well as being faster than adding and removing columns separately.
TypedElementFramework
bool AddRemoveColumns ( TypedElementRowHandle Row, TConstArrayView< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > ColumnsToAdd, TConstArrayView< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > ColumnsToRemove )
[]
ITypedElementDataStorageInterface::AddRow
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Adds a new row to the provided table using a previously reserved row..
TypedElementFramework
bool AddRow ( TypedElementRowHandle ReservedRow, TypedElementTableHandle Table )
[]
ITypedElementDataStorageInterface::AddRow
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Adds a new row to the provided table.
TypedElementFramework
TypedElementRowHandle AddRow ( TypedElementTableHandle Table )
[]
ITypedElementDataStorageInterface::BatchAddRemoveColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Adds and removes the provided column types from the provided list of rows.
TypedElementFramework
bool BatchAddRemoveColumns ( TConstArrayView< TypedElementRowHandle > Rows, TConstArrayView< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > ColumnsToAdd, TConstArrayView< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > ColumnsToRemove )
[]
ITypedElementDataStorageInterface::BatchAddRow
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Add multiple rows at once. For each new row the OnCreated callback is called. Callers are expected to use the callback to initialize the row if needed.
TypedElementFramework
bool BatchAddRow ( TypedElementTableHandle Table, int32 Count, TypedElementDataStorageCreationCallbackRef OnCreated )
[]
ITypedElementDataStorageInterface::BatchAddRow
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Add multiple rows at once. For each new row the OnCreated callback is called. Callers are expected to use the callback to initialize the row if needed. This version uses a set of previously reserved rows. Any row that can't be used will be released.
TypedElementFramework
bool BatchAddRow ( TypedElementTableHandle Table, TConstArrayView< TypedElementRowHandle > ReservedHandles, TypedElementDataStorageCreationCallbackRef OnCreated )
[]
DirectQueryCallback
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::DirectQueryCallback](API\Runtime\TypedElementFramework\Elements\Common\DirectQueryCallback) DirectQueryCallback
[]
DirectQueryCallbackRef
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::DirectQueryCallbackRef](API\Runtime\TypedElementFramework\Elements\Common\DirectQueryCallbackRef) DirectQueryCallbackRef
[]
EQueryCallbackType
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::EQueryCallbackType](API\Runtime\TypedElementFramework\Elements\Common\TypedElementData-_2) EQueryCallbackType
[]
EQueryAccessType
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::EQueryAccessType](API\Runtime\TypedElementFramework\Elements\Common\TypedElementData-_3) EQueryAccessType
[]
EQueryDependencyFlags
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::EQueryDependencyFlags](API\Runtime\TypedElementFramework\Elements\Common\TypedElementData-_4) EQueryDependencyFlags
[]
EQueryTickPhase
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Queries can be constructed using the Query Builder. Note that the Query Builder allows for the creation of queries that are more complex than the back-end may support. The back-end is allowed to simplify the query, in which case the query can be used directly in the processor to do additional filtering. This will however impact performance and it's therefore recommended to try to simplify the query first before relying on extended query filtering in a processor.
TypedElementFramework
typedef [TypedElementDataStorage::EQueryTickPhase](API\Runtime\TypedElementFramework\Elements\Common\TypedElementData-) EQueryTickPhase
[]
EQueryTickGroups
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::EQueryTickGroups](API\Runtime\TypedElementFramework\Elements\Common\TypedElementData-_1) EQueryTickGroups
[]
ITypedElementDataStorageInterface::FindTable
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Returns a previously created table with the provided name or TypedElementInvalidTableHandle if not found.
TypedElementFramework
TypedElementTableHandle FindTable ( const [FName](API\Runtime\Core\UObject\FName) Name )
[]
FQueryDescription
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::FQueryDescription](API\Runtime\TypedElementFramework\Elements\Common\FQueryDescription) FQueryDescription
[]
FQueryResult
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::FQueryResult](API\Runtime\TypedElementFramework\Elements\Common\FQueryResult) FQueryResult
[]
ITypedElementDataStorageInterface::GetColumnData
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Retrieves a pointer to the column of the given row or a nullptr if not found or if the column type is a tag.
TypedElementFramework
void * GetColumnData ( TypedElementRowHandle Row, const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * ColumnType )
[]
ITypedElementDataStorageInterface::GetColumn
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Returns a pointer to the column of the given row or a nullptr if the type couldn't be found or the row doesn't exist.
TypedElementFramework
template<typename ColumnType> ColumnType * GetColumn ( TypedElementRowHandle Row )
[]
ITypedElementDataStorageInterface::GetColumnData
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
[ColumnDataResult](API\Runtime\TypedElementFramework\Elements\Interfaces\ColumnDataResult) GetColumnData ( TypedElementRowHandle Row, [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) ColumnName )
[]
ITypedElementDataStorageInterface::GetExternalSystem
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Returns a pointer to the registered external system if found, otherwise null.
TypedElementFramework
template<typename SystemType> SystemType * GetExternalSystem()
[]
ITypedElementDataStorageInterface::GetExternalSystemAddress
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Returns a pointer to the registered external system if found, otherwise null.
TypedElementFramework
void * GetExternalSystemAddress ( [UClass](API\Runtime\CoreUObject\UObject\UClass) * Target )
[]
ITypedElementDataStorageInterface::GetQueryDescription
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Returns the description of a previously registered query. If the query no longer exists an empty description will be returned.
TypedElementFramework
const [FQueryDescription](API\Runtime\TypedElementFramework\Elements\Interfaces\ITypedElementDat-_1\FQueryDescriptio-) & GetQueryDescription ( TypedElementQueryHandle Query ) const
[]
ITypedElementDataStorageInterface::GetQueryTickGroupName
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Tick groups for queries can be given any name and the Data Storage will figure out the order of execution based on found dependencies. However keeping processors within the same query group can help promote better performance through parallelization. Therefore a collection of common tick group names is provided to help create consistent tick group names.
TypedElementFramework
[FName](API\Runtime\Core\UObject\FName) GetQueryTickGroupName ( [EQueryTickGroups](API\Runtime\TypedElementFramework\Elements\Common\TypedElementData-_1) Group ) const
[]
ITypedElementDataStorageInterface::HasColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Determines if the provided row contains the collection of columns and tags.
TypedElementFramework
bool HasColumns ( TypedElementRowHandle Row, TConstArrayView< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > ColumnTypes ) const
[]
ITypedElementDataStorageInterface::HasColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
template<typename... ColumnTypes> bool HasColumns ( TypedElementRowHandle Row ) const
[]
ITypedElementDataStorageInterface::HasColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
bool HasColumns ( TypedElementRowHandle Row, TConstArrayView< [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) >> ColumnTypes ) const
[]
IDirectQueryContext
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::IDirectQueryContext](API\Runtime\TypedElementFramework\Elements\Interfaces\IDirectQueryContext) IDirectQueryContext
[]
IQueryContext
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::IQueryContext](API\Runtime\TypedElementFramework\Elements\Interfaces\IQueryContext) IQueryContext
[]
ITypedElementDataStorageInterface::IsAvailable
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Whether or not the data storage is available. The data storage is available most of the time, but can be unavailable for a brief time between being destroyed and a new one created.
TypedElementFramework
bool IsAvailable() const
[]
ITypedElementDataStorageInterface::IsRowAvailable
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Checks whether or not a row is in use. This is true even if the row has only been reserved.
TypedElementFramework
bool IsRowAvailable ( TypedElementRowHandle Row ) const
[]
ISubqueryContext
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::ISubqueryContext](API\Runtime\TypedElementFramework\Elements\Interfaces\ISubqueryContext) ISubqueryContext
[]
ITypedElementDataStorageInterface::OnUpdate
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Called periodically when the storage is available. This provides an opportunity to do any repeated processing for the data storage.
TypedElementFramework
FTypedElementOnDataStorageUpdate & OnUpdate()
[]
ITypedElementDataStorageInterface::HasRowBeenAssigned
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Checks whether or not a row has been reserved but not yet assigned to a table.
TypedElementFramework
bool HasRowBeenAssigned ( TypedElementRowHandle Row ) const
[]
QueryCallback
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::QueryCallback](API\Runtime\TypedElementFramework\Elements\Common\QueryCallback) QueryCallback
[]
QueryCallbackRef
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::QueryCallbackRef](API\Runtime\TypedElementFramework\Elements\Common\QueryCallbackRef) QueryCallbackRef
[]
ITypedElementDataStorageInterface::RegisterQuery
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Registers a query with the data storage. The description is processed into an internal format and may be changed. If no valid could be created an invalid query handle will be returned. It's recommended to use the Query Builder for a more convenient and safer construction of a query.
TypedElementFramework
TypedElementQueryHandle RegisterQuery ( [FQueryDescription](API\Runtime\TypedElementFramework\Elements\Interfaces\ITypedElementDat-_1\FQueryDescriptio-) && Query )
[]
ITypedElementDataStorageInterface::RegisterTable
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Tables are automatically created by taking an existing table and adding/removing columns. For performance its however better to create a table before adding objects to the table. This doesn't prevent those objects from having columns added/removed at a later time. To make debugging and profiling easier it's also recommended to give tables a name.Creates a new table for with the provided columns. Optionally a name can be given which is useful for retrieval later.
TypedElementFramework
TypedElementTableHandle RegisterTable ( TConstArrayView< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > ColumnList, const [FName](API\Runtime\Core\UObject\FName) Name )
[]
ITypedElementDataStorageInterface::RegisterTable
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Copies the column information from the provided table and creates a new table for with the provided columns. Optionally a name can be given which is useful for retrieval later.
TypedElementFramework
TypedElementTableHandle RegisterTable ( TypedElementTableHandle SourceTable, TConstArrayView< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > ColumnList, const [FName](API\Runtime\Core\UObject\FName) Name )
[]
ITypedElementDataStorageInterface::RemoveColumn
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Removes a column from a row or does nothing if already removed.
TypedElementFramework
void RemoveColumn ( TypedElementRowHandle Row, const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * ColumnType )
[]
ITypedElementDataStorageInterface::RemoveColumn
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Removes a tag from a row or does nothing if already removed.
TypedElementFramework
template<typename Column> void RemoveColumn ( TypedElementRowHandle Row )
[]
ITypedElementDataStorageInterface::RemoveColumn
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
void RemoveColumn ( TypedElementRowHandle Row, [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) ColumnName )
[]
ITypedElementDataStorageInterface::RemoveColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Removes multiple columns from a row. This is typically more efficient than adding columns one at a time.
TypedElementFramework
template<typename... Columns> void RemoveColumns ( TypedElementRowHandle Row )
[]
ITypedElementDataStorageInterface::RemoveColumns
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Removes multiple columns from a row. This is typically more efficient than adding columns one at a time.
TypedElementFramework
void RemoveColumns ( TypedElementRowHandle Row, TConstArrayView< const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > Columns )
[]
ITypedElementDataStorageInterface::RemoveRow
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Removes a previously reserved or added row. If the row handle is invalid or already removed, nothing happens
TypedElementFramework
void RemoveRow ( TypedElementRowHandle Row )
[]
ITypedElementDataStorageInterface::ReserveRow
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Reserves a row to be assigned to a table at a later point. If the row is no longer needed before it's been assigned to a table, it should still be released with RemoveRow.
TypedElementFramework
TypedElementRowHandle ReserveRow()
[]
ITypedElementDataStorageInterface::RunQuery
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Directly runs a query. If the query handle is invalid or has been deleted nothing will happen.
TypedElementFramework
[FQueryResult](API\Runtime\TypedElementFramework\Elements\Interfaces\ITypedElementDat-_1\FQueryResult) RunQuery ( TypedElementQueryHandle Query )
[]
ITypedElementDataStorageInterface::RunQuery
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Directly runs a query. The callback will be called for batches of matching rows. During a single call to RunQuery the callback may be called multiple times. If the query handle is invalid or has been deleted nothing happens and the callback won't be called
TypedElementFramework
[FQueryResult](API\Runtime\TypedElementFramework\Elements\Interfaces\ITypedElementDat-_1\FQueryResult) RunQuery ( TypedElementQueryHandle Query, [DirectQueryCallbackRef](API\Runtime\TypedElementFramework\Elements\Interfaces\ITypedElementDat-_1\DirectQueryCallb-_1) Callback )
[]
SubqueryCallbackRef
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::SubqueryCallbackRef](API\Runtime\TypedElementFramework\Elements\Common\SubqueryCallbackRef) SubqueryCallbackRef
[]
SubqueryCallback
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
TypedElementFramework
typedef [TypedElementDataStorage::SubqueryCallback](API\Runtime\TypedElementFramework\Elements\Common\SubqueryCallback) SubqueryCallback
[]
ITypedElementDataStorageInterface::UnregisterQuery
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageInterface.h
Removes a previous registered. If the query handle is invalid or the query has already been deleted nothing will happen.
TypedElementFramework
void UnregisterQuery ( TypedElementQueryHandle Query )
[]
ITypedElementDataStorageUiInterface::ConstructWidget
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageUiInterface.h
Creates a single widget using the provided constructor. Arguments can optionally be used to intialize the constructor.
TypedElementFramework
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > ConstructWidget ( TypedElementRowHandle Row, [FTypedElementWidgetConstructor](API\Runtime\TypedElementFramework\Elements\Interfaces\FTypedElementWid-) & Constructor, TConstArrayView< [TypedElement::ColumnUtils::Argument](API\Runtime\TypedElementFramework\Elements\Framework\Argument) > Arguments )
[]
ITypedElementDataStorageUiInterface::ConstructWidgets
/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageUiInterface.h
Creates all the widgets registered under the provided name. This may be a large number of widgets for a wide name or exactly one when the exact name of the widget is registered. Arguments can be provided, but widgets are free to ignore them.
TypedElementFramework
void ConstructWidgets ( [FName](API\Runtime\Core\UObject\FName) Purpose, TConstArrayView< [TypedElement::ColumnUtils::Argument](API\Runtime\TypedElementFramework\Elements\Framework\Argument) > Arguments, const [WidgetCreatedCallback](API\Runtime\TypedElementFramework\Elements\Interfaces\ITypedElementDat-_2\WidgetCreatedCal-) & ConstructionCallback )
[]