FTypePromotion

Contains behavior needed to handle type promotion in blueprints.

Unreal Engine C++ API Reference > Editor > BlueprintGraph

Inheritance Hierarchy

References

   
Module BlueprintGraph
Header /Engine/Source/Editor/BlueprintGraph/Classes/BlueprintTypePromotion.h
Include #include "BlueprintTypePromotion.h"

Syntax

class FTypePromotion : private [FNoncopyable](API\Runtime\Core\Templates\FNoncopyable)  

Remarks

Contains behavior needed to handle type promotion in blueprints. Creates a map of "Operations" to any of their matching UFunctions so that we can find the best possible match given several pin types.

Constructors

No constructors are accessible with public or protected access.

Destructors

No destructors are accessible with public or protected access.

Functions

Type Name Description
void ClearNodeSpawners () Clear all registered node spawners for operators from the system.
UFunction &#... FindBestMatchingFunc ( FName Operation, const TArray< UEdGraphPin* >&... ) Find the function that is the best match given the pins to consider.
FTypePromoti... Get () Creates a new singleton instance of TypePromotion if there isn't one and returns a reference to it
void GetAllFuncsForOp ( FName Operation, TArray< UFunction* >& OutFunc... ) Returns all functions for a specific operation.
const TSet< ... GetAllOpNames () Get a set of the supported operator names for type promo. Ex: "Add", "Subtract", "Multiply"
const TArray... GetAvailablePrimitivePromotions ( const FEdGraphPinType& Type ) Get a pointer to an array of available promotion types to a given pin type
const TSet< ... GetComparisonOpNames () Set of comparison operator names (GreaterThan, LessThan, etc)
ETypeCompari... GetHigherType ( const FEdGraphPinType& A, const FEdGraphPinType& B ) Given the two pin types check which pin type is higher.
const FText ... GetKeywordsForOperator ( const FName Operator ) Get the keywords metadata for the given operator name
UBlueprintFu... GetOperatorSpawner ( FName OpName ) Function node spawner associated with this operation
FName GetOpNameFromFunction ( UFunction const*const Func ) Parse the name of the operator that this function matches to (Add, Subtract, etc)
const TMap< ... GetPrimitivePromotionTable () Get the "Primitive Promotion Table" which represents what base Pin types can be promoted to others.
FEdGraphPinT... GetPromotedType ( const TArray< UEdGraphPin* >&... ) Determine what type a given set of wildcard pins would result in
const FText ... GetUserFacingOperatorName ( const FName Operator ) Get the user facing version of this operator name
bool HasStructConversion ( const UEdGraphPin* InputPin, const UEdGraphPin* OutputPin ) Returns true if the given input pin can correctly be converted to the output type as a struct
bool IsComparisonFunc ( UFunction const*const Func ) Returns true if the given function is a comparison operator
bool IsComparisonOpName ( const FName OpName ) Returns true if the given op name is a comparison operator name
bool IsFunctionPromotionReady ( const UFunction*const FuncToCo... ) Returns true if the given function has been registered within the operator table
bool IsOperatorSpawnerRegistered ( UFunction const*const Func ) Returns true if the given function has a registered operator node spawner
bool IsValidPromotion ( const FEdGraphPinType& A, const FEdGraphPinType& B ) Returns true if A can be promoted to type B correctly, or if the types are equal
void RefreshPromotionTables ( EReloadCompleteReason Reason ) Clear out the promotion table and rebuild it, reassessing each available UFunction.
void RegisterOperatorSpawner ( FName OpName, UBlueprintFunctionNodeSpawner*... ) Keep track of the operator that this function provides so that we don't add multiple to the BP context menu
void Shutdown () Deletes the singleton instance of type promotion if there is one

Enums

Type Name Description
Public enum ETypeComparisonResult Represents the possible results when comparing two types for promotion

Typedefs

Name Description
FFunctionsList A single operator can have multiple functions associated with it; usually for handling different types (int*int, vs. int*vector), hence this array.

Constants

Name Description
Instance  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library