UPCGMatchAndSetBase | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/PCG

Base class for Match & Set objects. Note that while it currently deals with points, it might be extended in the future. This class is extensible and can be implemented in different ways, but its role should be simple: For a given point, if it matches some criteria ("Match"), apply it some value ("Set"). It can be a lookup, a random process or something more involved.


Name	UPCGMatchAndSetBase
Type	class
Header File	/Engine/Plugins/PCG/Source/PCG/Public/MatchAndSet/PCGMatchAndSetBase.h
Include Path	#include "MatchAndSet/PCGMatchAndSetBase.h"

Syntax

UCLASS (MinimalAPI, Abstract, BlueprintType, Blueprintable, ClassGroup=(Procedural))  
class UPCGMatchAndSetBase : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UPCGMatchAndSetBase

Derived Classes

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
void MatchAndSet ( FPCGContext& Context, const UPCGPointMatchAndSetSettings* InSettings, const UPCGPointData* InPointData, UPCGPointData* OutPointData ) const	Main function to process points, and pass them through the Match & Set logic.	MatchAndSet/PCGMatchAndSetBase.h	BlueprintNativeEvent Category=Selection
virtual void MatchAndSet_Implementation ( FPCGContext& Context, const UPCGPointMatchAndSetSettings* InSettings, const UPCGPointData* InPointData, UPCGPointData* OutPointData ) const		MatchAndSet/PCGMatchAndSetBase.h
virtual void SetType ( EPCGMetadataTypes InType )	Sets & propagates type change from the owner settings object	MatchAndSet/PCGMatchAndSetBase.h
virtual bool ShouldMutateSeed()	Queries whether we should mutate the seeds as a post-process	MatchAndSet/PCGMatchAndSetBase.h
virtual bool UsesRandomProcess()	Queries whether this object uses a random process - note that this is expected to be static through the life of the object	MatchAndSet/PCGMatchAndSetBase.h
bool ValidatePreconditions ( const UPCGPointData* InPointData ) const	Early check to prevent issues when the data does not contain the required information to perform the operation	MatchAndSet/PCGMatchAndSetBase.h	BlueprintNativeEvent Category=Selection
virtual bool ValidatePreconditions_Implementation ( const UPCGPointData* InPointData ) const		MatchAndSet/PCGMatchAndSetBase.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostLoad()		MatchAndSet/PCGMatchAndSetBase.h

Protected

Name	Remarks	Include Path	Unreal Specifiers
bool CreateAttributeIfNeeded ( FPCGContext& Context, const FPCGAttributePropertySelector& Selector, const FPCGMetadataTypesConstantStruct& Value, UPCGPointData* OutPointData, const UPCGPointMatchAndSetSettings* InSettings ) const		MatchAndSet/PCGMatchAndSetBase.h

Deprecated Variables

Name	Type	Remarks	Include Path	Unreal Specifiers
StringMode_DEPRECATED	EPCGMetadataTypesConstantStructStringMode		MatchAndSet/PCGMatchAndSetBase.h

Navigation