UWorldConditionSchema | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/WorldConditions

Describes the context data and allowed world conditions for a specific use case.

Each schema adds the context data they can provide in their class constructor. This allows the derived classes to add more data as needed.

UCLASS() class UFantasticWorldConditionSchema : public UWorldConditionSchema {

public: UFantasticWorldConditionSchema::UFantasticWorldConditionSchema(const FObjectInitializer& ObjectInitializer) : Super(ObjectInitializer) { ActorRef = AddContextDataDesc(TEXT("Actor"), AActor::StaticClass(), EWorldConditionContextDataType::Dynamic); }

// For convenience, when the schema is known, makes it easy to set the context data. FWorldConditionContextDataRef GetActorRef() const { return ActorRef; }

protected: // Filter condition classes that make sense for this context. virtual bool IsStructAllowed(const UScriptStruct* InScriptStruct) const override; { return Super::IsStructAllowed(InScriptStruct) || InScriptStruct->IsChildOf(TBaseStructure::Get()); }

FWorldConditionContextDataRef ActorRef; };


Name	UWorldConditionSchema
Type	class
Header File	/Engine/Plugins/Runtime/WorldConditions/Source/WorldConditions/Public/WorldConditionSchema.h
Include Path	#include "WorldConditionSchema.h"

Syntax

UCLASS (MinimalAPI)  
class UWorldConditionSchema : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UWorldConditionSchema

Derived Classes

Functions

Public

Name	Remarks	Include Path
const FWorldConditionContextDataDesc & GetContextDataDescByIndex ( const int32 Index ) const		WorldConditionSchema.h
const FWorldConditionContextDataDesc * GetContextDataDescByName ( const FName DataName, const UStruct* Struct ) const		WorldConditionSchema.h
const FWorldConditionContextDataDesc * GetContextDataDescByName ( const FName DataName, const TArray< const UStruct* >& Structs ) const		WorldConditionSchema.h
const FWorldConditionContextDataDesc * GetContextDataDescByRef ( const FWorldConditionContextDataRef& Ref ) const		WorldConditionSchema.h
TConstArrayView< FWorldConditionContextDataDesc > GetContextDataDescs()		WorldConditionSchema.h
int32 GetContextDataIndexByName ( const FName DataName, const UStruct* Struct ) const		WorldConditionSchema.h
FWorldConditionContextDataRef GetContextDataRefByName ( const FName DataName, const UStruct* Struct ) const		WorldConditionSchema.h
EWorldConditionContextDataType GetContextDataTypeByIndex ( const int32 Index ) const		WorldConditionSchema.h
EWorldConditionContextDataType GetContextDataTypeByRef ( const FWorldConditionContextDataRef& Ref ) const		WorldConditionSchema.h
virtual bool IsStructAllowed ( const UScriptStruct* InScriptStruct ) const		WorldConditionSchema.h
TEnableIf< TIsDerivedFrom< Head, UObject >::IsDerived, bool >::Type ResolveContextDataRef ( FWorldConditionContextDataRef& Ref ) const	Resolves the index of the context data reference to an object data, based on the name in the reference and the types from the template.	WorldConditionSchema.h
TEnableIf< TIsDerivedFrom< Head, UObject >::IsDerived, bool >::Type ResolveContextDataRef ( FWorldConditionContextDataRef& Ref ) const	Resolves the index of the context data reference to an object data, based on the name in the reference and the type from the template.	WorldConditionSchema.h
TEnableIfTIsDerivedFrom< Head, UObject >::IsDerived, bool >::Type ResolveContextDataRef ( FWorldConditionContextDataRef& Ref ) const	Resolves the index of the context data reference to a Struct context data, based on the name in the reference and the types from the template.	WorldConditionSchema.h
TEnableIfTIsDerivedFrom< Head, UObject >::IsDerived, bool >::Type ResolveContextDataRef ( FWorldConditionContextDataRef& Ref ) const	Resolves the index of the context data reference to a Struct context data, based on the name in the reference and the type from the template.	WorldConditionSchema.h

Protected

Name	Remarks	Include Path	Unreal Specifiers
FWorldConditionContextDataRef AddContextDataDesc ( const FName InName, const UStruct* InStruct, const EWorldConditionContextDataType InType )	Adds a context data descriptor and returns reference to it.	WorldConditionSchema.h