FJsonSchemaPropertyFilter | Unreal Engine 5.8 Documentation

Filter used during schema generation, used for both FProperties and UStructs.


Name	FJsonSchemaPropertyFilter
Type	struct
Header File	/Engine/Source/Runtime/JsonUtilities/Public/JsonSchema/JsonSchemaPropertyFilter.h
Include Path	#include "JsonSchema/JsonSchemaPropertyFilter.h"

Syntax

struct FJsonSchemaPropertyFilter

Name	Remarks	Include Path	Unreal Specifiers
FJsonSchemaPropertyFilter ( const FJsonSchemaPropertyFilter& Other )		JsonSchema/JsonSchemaPropertyFilter.h
FJsonSchemaPropertyFilter ( const EPropertyFlags InCheckFlags, const EPropertyFlags InSkipFlags, const TOptional< TSet< FString > >& InRequiredPropertyMemberPaths, const TOptional< TSet< FString > >& InSkipPropertyMemberPaths, const EJsonObjectConversionFlags InConversionFlags, CustomCallback* CustomCb )		JsonSchema/JsonSchemaPropertyFilter.h

Name	Type	Remarks	Include Path
CustomCallback	TDelegate< bool(const FProperty *Property, const FString &ParameterDefaultString, const TSharedRef< FJsonObject > &OutputSchema)>	Optional callback that will be run when exporting a single property to JsonSchema.	JsonSchema/JsonSchemaPropertyFilter.h

Name	Type	Remarks	Include Path
CheckFlags	EPropertyFlags	If specified (not CPF_None), only properties with any of the specified EPropertyFlags will be considered.	JsonSchema/JsonSchemaPropertyFilter.h
ConversionFlags	EJsonObjectConversionFlags	If passed, ensures generated schema is compatible with FJsonObjectConverter::UStructToJsonObject executed with the same flags e.g: EJsonObjectConversionFlags::SkipStandardizeCase for property name casing.	JsonSchema/JsonSchemaPropertyFilter.h
CustomCb	FJsonSchemaPropertyFilter::CustomCallback *	If passed, allows for custom property handling.	JsonSchema/JsonSchemaPropertyFilter.h
RequiredPropertyMemberPaths	TOptional< TSet< FString > >	Only considered while generating schemas for UStructs.	JsonSchema/JsonSchemaPropertyFilter.h
SkipFlags	EPropertyFlags	If specified (not CPF_None), any properties with any of the specified EPropertyFlags will be skipped.	JsonSchema/JsonSchemaPropertyFilter.h
SkipPropertyMemberPaths	TOptional< TSet< FString > >	Only considered while generating schemas for UStructs.	JsonSchema/JsonSchemaPropertyFilter.h

Name	Remarks	Include Path
bool IsPropertyIgnored ( TNotNull< const FProperty* > Property ) const	Checks if a property should be ignored, to its flags compared to our check/skip flags.	JsonSchema/JsonSchemaPropertyFilter.h
bool IsPropertyMemberPathRequired ( const FString& PropertyMemberPath ) const	Checks if a property is required.	JsonSchema/JsonSchemaPropertyFilter.h
bool IsPropertyMemberPathSkipped ( const FString& PropertyMemberPath ) const	Checks if a property should be skipped.	JsonSchema/JsonSchemaPropertyFilter.h
FString PropertyAuthoredNameToJsonKey ( const FString& PropertyAuthoredName ) const	Converts a property's authored name into a name that respects the ConversionFlags setting.	JsonSchema/JsonSchemaPropertyFilter.h