FPCGInlineConstantState

Composable state struct for inline constant values on pins.

API > API/Plugins > API/Plugins/PCG

Composable state struct for inline constant values on pins. Any UPCGSettings class implementing IPCGSettingsInlineConstant can embed this as a UPROPERTY member and override GetInlineConstantState()/GetMutableInlineConstantState() to get full inline constant support with minimal boilerplate.

   
Name FPCGInlineConstantState
Type struct
Header File /Engine/Plugins/PCG/Source/PCG/Public/Metadata/PCGInlineConstantInterface.h
Include Path #include "Metadata/PCGInlineConstantInterface.h"

Syntax

USTRUCT ()  
struct FPCGInlineConstantState

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
DefaultValueMap TMap< FName, FPCGPinDefaultValueInfo >   Metadata/PCGInlineConstantInterface.h  
DefaultValues FPCGDefaultValueContainer   Metadata/PCGInlineConstantInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddDefaultValueToPin ( FName PinLabel,
FPCGPinDefaultValueInfo::FInitParams InitParams
)

 Register a pin for inline constant support. Returns false if already registered. Metadata/PCGInlineConstantInterface.h  

bool ConvertPinDefaultValueMetadataType ( FName PinLabel,
EPCGMetadataTypes DataType
)

 Attempt a metadata type conversion. Returns true if conversion occurred. Metadata/PCGInlineConstantInterface.h  

const UPCGParamData * CreateDefaultValueParamData ( FPCGContext* InContext,
FName PropertyKey,
FName AttributeName
) const

 Create a Param Data with the inline constant default value properties inserted as metadata. Metadata/PCGInlineConstantInterface.h  

bool DefaultValuesAreEnabled()

 One or more pins on this node has a 'default value' and can be adjusted via an inline constant. Metadata/PCGInlineConstantInterface.h  

EPCGSettingDefaultValueExtraFlags GetDefaultValueExtraFlags ( FName PinLabel
) const

 Extra flags related to displaying the value. Metadata/PCGInlineConstantInterface.h  

FString GetPinDefaultValueAsString ( FName PinLabel
) const

 Get the 'default value', if supported, for the pin. Metadata/PCGInlineConstantInterface.h  

EPCGMetadataTypes GetPinDefaultValueType ( FName PinLabel
) const

 Get the current 'default value' type, if supported, for the pin. Metadata/PCGInlineConstantInterface.h  

FString GetPinInitialDefaultValueString ( FName PinLabel
) const

 Get the initial 'default value' of the pin. Metadata/PCGInlineConstantInterface.h  

EPCGMetadataTypes GetPinInitialDefaultValueType ( FName PinLabel
) const

 For the initial 'default value' type of the pin. Metadata/PCGInlineConstantInterface.h  

bool IsPinDefaultValueActivated ( FName PinLabel
) const

 The specified pin has a 'default value' currently activated. Metadata/PCGInlineConstantInterface.h  

bool IsPinDefaultValueEnabled ( FName PinLabel
) const

 The specified pin can accommodate 'default value' inline constants. Metadata/PCGInlineConstantInterface.h  

bool IsPinDefaultValueMetadataTypeValid ( FName PinLabel,
EPCGMetadataTypes DataType
) const

 Returns true if the pin supports the provided metadata type. Metadata/PCGInlineConstantInterface.h  

bool PinIsMapped ( FName PinLabel
) const

 Returns true if the pin has been registered for default values. Metadata/PCGInlineConstantInterface.h  

bool RemoveDefaultValueFromPin ( FName PinLabel
)

 Unregister a pin from inline constant support. Returns false if not registered. Metadata/PCGInlineConstantInterface.h  

bool ResetDefaultValue ( FName PinLabel
)

 Reset a single pin's value. Returns true if reset occurred. Metadata/PCGInlineConstantInterface.h  

bool ResetDefaultValues()

 Reset all values to their initial type/value. Returns true if any reset occurred. Metadata/PCGInlineConstantInterface.h  

bool SetPinDefaultValue ( FName PinLabel,
const FString& DefaultValue,
bool bCreateIfNeeded
)

 Set the pin's default value string directly. Returns true if value changed. Metadata/PCGInlineConstantInterface.h  

bool SetPinDefaultValueIsActivated ( FName PinLabel,
bool bIsActivated
)

 Set the default value to active/inactive. Returns true if activation state changed. Metadata/PCGInlineConstantInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page