Navigation
API > API/Runtime > API/Runtime/TypedElementFramework
Contract between context and implementation to be able to communicate. The contract contains all functions for all capabilities that are available. Based on the supported capabilities an implementation may opt to only partially implement the contract, with the remaining functions asserting. On the opposite side a context may restrict what functions on the contract can be called based on the requested capabilities. Through the query function the capabilities on both sides are kept aligned, resulting in no function on the contract being callable if they're not implemented.
| Name | IContextContract |
| Type | struct |
| Header File | /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementQueryContract.h |
| Include Path | #include "Elements/Framework/TypedElementQueryContract.h" |
Syntax
struct IContextContract : public UE::Editor::DataStorage::Queries::Private::IPreContextContractCombiner< int # 1 "D:/P4/UE5LicenseeTestBASE_UE5.8/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementQueryCapabilities.inl" 1 # 175 "D:/P4/UE5LicenseeTestBASE_UE5.8/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementQueryContract.h" 2 >
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IContextContract() |
Elements/Framework/TypedElementQueryContract.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CheckCompatibility () |
Elements/Framework/TypedElementQueryContract.h | ||
bool constexpr CheckCompatibility
(
uint64 CapabilityMask |
Elements/Framework/TypedElementQueryContract.h | ||
TConstArrayView< FName > GetSupportedCapabilities() |
Elements/Framework/TypedElementQueryContract.h | ||
void ReportCompatibility () |
Elements/Framework/TypedElementQueryContract.h | ||
void ReportCompatibility
(
uint64 CapabilityMask |
Elements/Framework/TypedElementQueryContract.h |