Navigation
API > API/Plugins > API/Plugins/PCG
Select a grammar by comparing an input attribute against a provided set criteria one-by-one in a sequential order.
| Name | UPCGSelectGrammarSettings |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Elements/Grammar/PCGSelectGrammar.h |
| Include Path | #include "Elements/Grammar/PCGSelectGrammar.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural))
class UPCGSelectGrammarSettings : public UPCGSettings
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPCGData → UPCGSettingsInterface → UPCGSettings → UPCGSelectGrammarSettings
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UPCGSelectGrammarSettings() |
Elements/Grammar/PCGSelectGrammar.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCopyKeyForUnselectedGrammar | bool | If no grammar is selected for a given point, pass through the key value. | Elements/Grammar/PCGSelectGrammar.h |
|
| bCriteriaAsInput | bool | Toggle for an additional input "Selection Criteria Data" which accepts criteria info as an attribute set matching the structure type 'FPCGSelectGrammarCriteria'. | Elements/Grammar/PCGSelectGrammar.h |
|
| bKeyAsAttribute | bool | Select the key with an attribute. | Elements/Grammar/PCGSelectGrammar.h |
|
| bRemapCriteriaAttributeNames | bool | Remap expected attribute names for the comparison criteria. | Elements/Grammar/PCGSelectGrammar.h |
|
| ComparedValueAttribute | FPCGAttributePropertyInputSelector | The attribute on the input data to be compared against. Will be numerically evaluated. | Elements/Grammar/PCGSelectGrammar.h |
|
| Criteria | TArray< FPCGSelectGrammarCriterion > | Selection criteria that will be evaluated in order. | Elements/Grammar/PCGSelectGrammar.h |
|
| CriteriaAttributeNames | FPCGSelectGrammarCriteriaAttributeNames | The attribute names expected for the comparison criteria. | Elements/Grammar/PCGSelectGrammar.h |
|
| Key | FName | An attribute key that represents the desired set of grammars. | Elements/Grammar/PCGSelectGrammar.h |
|
| KeyAttribute | FPCGAttributePropertyInputSelector | An attribute selector for a key that represents the desired set of grammars. | Elements/Grammar/PCGSelectGrammar.h |
|
| OutputGrammarAttribute | FPCGAttributePropertyOutputSelector | The attribute to output the selected grammar. | Elements/Grammar/PCGSelectGrammar.h |
|
Functions
Public
Overridden from UPCGSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FName GetDefaultNodeName() |
Elements/Grammar/PCGSelectGrammar.h | ||
virtual FText GetDefaultNodeTitle() |
Elements/Grammar/PCGSelectGrammar.h | ||
virtual FText GetNodeTooltipText() |
Elements/Grammar/PCGSelectGrammar.h | ||
virtual EPCGSettingsType GetType() |
Elements/Grammar/PCGSelectGrammar.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostLoad() |
Elements/Grammar/PCGSelectGrammar.h |
Protected
Overridden from UPCGSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FPCGElementPtr CreateElement() |
Elements/Grammar/PCGSelectGrammar.h | ||
virtual TArray< FPCGPinProperties > InputPinProperties() |
Returns an array of all the input pin properties. You should not add manually a "params" pin, it is handled automatically by FillOverridableParamsPins. | Elements/Grammar/PCGSelectGrammar.h | |
virtual TArray< FPCGPinProperties > OutputPinProperties() |
Elements/Grammar/PCGSelectGrammar.h |