UBlueprintEditorLibrary

API > API/Editor > API/Editor/BlueprintEditorLibrary

   
Name UBlueprintEditorLibrary
Type class
Header File /Engine/Source/Editor/BlueprintEditorLibrary/Public/BlueprintEditorLibrary.h
Include Path #include "BlueprintEditorLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class UBlueprintEditorLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UBlueprintEditorLibrary ( const FObjectInitializer& ObjectInitializer
)

   BlueprintEditorLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static bool AddEventDispatcher ( UBlueprint* Blueprint,
FName Name
)

 Creates a new event dispatcher on the Blueprint with the given name. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)

static bool AddEventDispatcherParameter ( UBlueprint* Blueprint,
FName DispatcherName,
FName ParamName,
const FEdGraphPinType& ParamType
)

 Adds a parameter to an event dispatcher's signature. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)

static UK2Node_Event * AddEventOverride ( UBlueprint* Blueprint,
FName EventName,
FIntPoint Position
)

 Creates an event-override node in the Blueprint's event graph for an inherited event-shape function. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static UEdGraph * AddFunctionGraph ( UBlueprint* Blueprint,
const FString& FuncName
)

 Adds a function to the given blueprint BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"

static UEdGraph * AddFunctionOverride ( UBlueprint* Blueprint,
FName FunctionName
)

 Creates a function-graph override of an inherited function. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static bool AddMemberVariable ( UBlueprint* Blueprint,
FName MemberName,
const FEdGraphPinType& VariableType
)

 Adds a member variable to the specified blueprint with the specified type. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static bool AddMemberVariableWithValue ( UBlueprint* Blueprint,
FName MemberName,
const int32& DefaultValue
)

 Adds a member variable to the specified blueprint inferring the type from a provided value. BlueprintEditorLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Category="Blueprint Editor"
  • Meta=(CustomStructureParam="DefaultValue")

static void ChangeMemberVariableType ( UBlueprint* Blueprint,
const FName& VariableName,
const FEdGraphPinType& NewType
)

 Changes the specified member variable's type - inherited variables must have their type changed at the point of declaration BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting"
  • Meta=(ScriptMethod)

static void CompareAssetSaveVersionTo ( const UObject* Asset,
const FString& VersionToCheck,
EAssetSaveVersionComparisonResults& Result
)

 Compares the given assets save version to the VersionToCheck. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"
  • Meta=(ExpandEnumAsExecs="Result")

static void CompareSoftObjectSaveVersionTo ( const TSoftObjectPtr< UObject > ObjectToCheck,
const FString& VersionToCheck,
EAssetSaveVersionComparisonResults& Result
)

 Compares the given soft object's save version to the VersionToCheck. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"
  • Meta=(ExpandEnumAsExecs="Result")

static bool CompileBlueprint ( UBlueprint* Blueprint
)

 Compiles the given blueprint. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"

static UBlueprint * CreateBlueprintAssetWithParent ( const FString& AssetPath,
UClass* ParentClass
)

 Creates a blueprint based on a specific parent, honoring registered custom blueprint types BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static FBlueprintGraphPin FindConditionPin ( const UK2Node_IfThenElse* Node
)

 Finds the Condition pin on this node BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static FBlueprintGraphPin FindDataInputPin ( const UK2Node* Node
)

 Returns the single data input pin associated with this node, returning default pin if there are multiple or no input(s) BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)
End UK2Node_CreateDelegate extension/script methods BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static UEdGraph * FindEventGraph ( UBlueprint* Blueprint
)

 Finds the event graph of the given blueprint. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"

static FBlueprintGraphPin FindExecutePin ( const UK2Node* Node
)

 Returns the 'execute' or 'do' pin associated with this node, if any BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static UEdGraph * FindGraph ( UBlueprint* Blueprint,
FName GraphName
)

 Finds the graph with the given name on the blueprint. Null if it doesn't have one. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"

static FBlueprintGraphPin FindInputPin ( const UK2Node* Node,
FName PinName,
const FEdGraphPinType& Type
)

 Returns an input pin specified by name and, optionally, type BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static FBlueprintGraphPin FindInputPinByIndex ( const UK2Node* Node,
int32 Index,
const FEdGraphPinType& Type
)

 Returns an input pin specified by index and, optionally, type BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static FBlueprintGraphPin FindOutputPin ( const UK2Node* Node,
FName PinName,
const FEdGraphPinType& Type
)

 Returns an output pin specified by name and, optionally, type BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static FBlueprintGraphPin FindOutputPinByIndex ( const UK2Node* Node,
int32 Index,
const FEdGraphPinType& Type
)

 Returns an output pin specified by index and, optionally, type BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static FBlueprintGraphPin FindResultPin ( const UK2Node* Node
)

 Returns the single data output pin associated with this node, returning default pin if there are multiple or no output(s) BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static FBlueprintGraphPin FindSelfPin ( const UK2Node* Node
)

 Returns the self pin associated with this node, if any BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static FBlueprintGraphPin FindThenPin ( const UK2Node* Node
)

 Returns the 'then' pin associated with this node, if any BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static bool GatherUnusedVariables ( const UBlueprint* Blueprint,
TArray< FProperty* >& OutProperties
)

 Gathers any unused blueprint variables and populates the given array of FPropertys BlueprintEditorLibrary.h  

static UClass * GeneratedClass ( UBlueprint* BlueprintObj
)

 Gets the class generated when this blueprint is compiled BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting"
  • Meta=(ScriptMethod)

static bool Generic_AddMemberVariableWithValue ( UBlueprint* Blueprint,
FName MemberName,
const uint8* DefaultValuePtr,
const FProperty* DefaultValueProp
)

   BlueprintEditorLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Category="Blueprint Editor"
  • Meta=(CustomStructureParam="DefaultValue")

static FEdGraphPinType GetArrayType ( const FEdGraphPinType& ContainedType
)

   BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static FEdGraphPinType GetBasicTypeByName ( FName TypeName
)

   BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static UBlueprint * GetBlueprintAsset ( UObject* Object
)

 Finds the UBlueprint associated with the object, locally searching the object graph for a UBlueprint associated with an asset object. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"
  • Meta=(Keywords="cast")

static UBlueprint * GetBlueprintForClass ( UClass* Class,
bool& bDoesClassHaveBlueprint
)

 Looks up the UBlueprint that generated the provided class, if any. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"
  • Meta=(ExpandBoolAsExecs="bDoesClassHaveBlueprint")

static UClass * GetBlueprintParentClass ( const UBlueprint* Blueprint
)

 Returns the parent class of the given Blueprint. BlueprintEditorLibrary.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)

static FText GetBlueprintVariableCategory ( UBlueprint* Blueprint,
const FName& VariableName
)

 Gets the user-defined category of a Blueprint member variable. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting"
  • Meta=(ScriptMethod)

static EBlueprintVariableReplication GetBlueprintVariableReplication ( UBlueprint* Blueprint,
const FName& VariableName
)

 Gets the replication mode of a Blueprint variable. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting"
  • Meta=(ScriptMethod)

static FEdGraphPinType GetClassReferenceType ( const UClass* ClassType
)

   BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static FLinearColor GetCommentColor ( const UEdGraphNode_Comment* CommentNode
)

 Gets the background color of a comment node. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)

static FString GetCommentText ( const UEdGraphNode_Comment* CommentNode
)

 Returns the comment text of a comment node. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)
Returns the selected function name on a Create Event node (the dropdown value). BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)
Returns a string which represents the current engine version (FEngineVersion::Current()) BlueprintEditorLibrary.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Blueprint Upgrade Tools"

static FEdGraphPinType GetMapType ( const FEdGraphPinType& KeyType,
const FEdGraphPinType& ValueType
)

   BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static TOptional< FEdGraphPinType > GetMemberVariableType ( const UBlueprint* Blueprint,
const FString& MemberVariableName
)

 Returns the type of a member variable, unset if no variable is found. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)

static FString GetNodeCategory ( const UK2Node* Node
)

 Returns this node's menu category BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static FIntPoint GetNodePos ( const UK2Node* Node
)

 Returns this node's visual position in the graph BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static TArray< UK2Node * > GetNodesInComment ( const UEdGraphNode_Comment* CommentNode
)

 Returns the K2 nodes contained within the given comment node. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)

static FVector2D GetNodeSize ( const UEdGraphNode* Node
)

 Returns the size (width, height) of a node as stored in the graph data. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)

static FString GetNodeTitle ( const UK2Node* Node
)

 Returns this node's title, as used when the node is displayed in a list BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static FEdGraphPinType GetObjectReferenceType ( const UClass* ObjectType
)

   BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static FString GetSavedByEngineVersion ( const UObject* Asset
)

 Returns a string representation of the engine version which the given asset was saved with. BlueprintEditorLibrary.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Blueprint Upgrade Tools"

static FEdGraphPinType GetSetType ( const FEdGraphPinType& ContainedType
)

   BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static FEdGraphPinType GetStructType ( const UScriptStruct* StructType
)

   BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static TArray< FBlueprintGraphPin > ListAllPins ( const UK2Node* Node,
TEnumAsByte< EEdGraphPinDirection > InDirection
)

 Begin UK2Node extension/script methods. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)
Lists functions compatible with the delegate signature of a Create Event node. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static TArray< FName > ListEventDispatchers ( const UBlueprint* Blueprint
)

 Returns the names of all event dispatchers defined on the Blueprint. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)
Lists all events visible on this Blueprint: locally defined custom events, overridable parent-class events, and event-shape interface members. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
Lists all non-event functions visible on this Blueprint: locally defined function graphs, overridable parent-class functions, and functions declared on interfaces (both explicitly implemented and inherited through a natively-implemented interface). BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static void ListGraphNames ( const UBlueprint* Blueprint,
TArray< FName >& OutGraphNames
)

 Lists the names of the editable graphs in the BP BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static TArray< UEdGraph * > ListGraphs ( UBlueprint* Blueprint
)

 Lists all of the graphs that a Blueprint contains. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"

static TArray< FBlueprintGraphPin > ListInputPins ( const UK2Node* Node
)

 Returns all visible input pins on this node BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static void ListMemberVariableNames ( const UBlueprint* Blueprint,
TArray< FString >& OutMemberVariableNames,
bool bIncludeInheritedMembers
)

 Lists the names of the member variables in the BP. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)

static TArray< FBlueprintGraphPin > ListOutputPins ( const UK2Node* Node
)

 Returns all visible output pins on this node BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static FString PinTypeToJsonSchema ( const FEdGraphPinType& PinType,
const UClass* SelfContext
)

 @ A json schema string describing the type BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)

static void RefreshAllOpenBlueprintEditors()

 Refresh any open blueprint editors BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static void RefreshOpenEditorsForBlueprint ( const UBlueprint* BP
)

 Attempt to refresh any open blueprint editors for the given asset BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"

static bool RemoveEventDispatcher ( UBlueprint* Blueprint,
FName Name
)

 Removes the event dispatcher with the given name from the Blueprint. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)

static bool RemoveEventDispatcherParameter ( UBlueprint* Blueprint,
FName DispatcherName,
FName ParamName
)

 Removes a parameter from an event dispatcher's signature. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)

static void RemoveFunctionGraph ( UBlueprint* Blueprint,
FName FuncName
)

 Deletes the function of the given name on this blueprint. Does NOT replace function call sites. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"

static void RemoveGraph ( UBlueprint* Blueprint,
UEdGraph* Graph
)

 Removes the given graph from the blueprint if possible BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"

static void RemoveUnusedNodes ( UBlueprint* Blueprint
)

 Remove any nodes in this blueprint that have no connections made to them. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"

static int32 RemoveUnusedVariables ( UBlueprint* Blueprint
)

 Deletes any unused blueprint created variables the given blueprint. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"

static void RenameGraph ( UEdGraph* Graph,
const FString& NewNameStr
)

 Attempts to rename the given graph with a new name BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"

static void ReparentBlueprint ( UBlueprint* Blueprint,
UClass* NewParentClass
)

 Attempts to reparent the given blueprint to the new chosen parent class. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"

static void ReplaceVariableReferences ( UBlueprint* Blueprint,
const FName OldVarName,
const FName NewVarName
)

 Replace any references of variables with the OldVarName to references of those with the NewVarName if possible BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"

static void SetBlueprintVariableCategory ( UBlueprint* Blueprint,
const FName& VariableName,
const FText& NewCategory
)

 Sets the user-defined category on a Blueprint member variable. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting"
  • Meta=(ScriptMethod)

static void SetBlueprintVariableExposeOnSpawn ( UBlueprint* Blueprint,
const FName& VariableName,
bool bExposeOnSpawn
)

 Sets "Expose On Spawn" to true/false on a Blueprint variable BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting"
  • Meta=(ScriptMethod)

static void SetBlueprintVariableExposeToCinematics ( UBlueprint* Blueprint,
const FName& VariableName,
bool bExposeToCinematics
)

 Sets "Expose To Cinematics" to true/false on a Blueprint variable BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting"
  • Meta=(ScriptMethod)

static void SetBlueprintVariableInstanceEditable ( UBlueprint* Blueprint,
const FName& VariableName,
bool bInstanceEditable
)

 Sets "Instance Editable" to true/false on a Blueprint variable BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting"
  • Meta=(ScriptMethod)

static void SetBlueprintVariableReplication ( UBlueprint* Blueprint,
const FName& VariableName,
EBlueprintVariableReplication Replication
)

 Sets the replication mode on a Blueprint variable. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting"
  • Meta=(ScriptMethod)

static void SetCommentColor ( UEdGraphNode_Comment* CommentNode,
FLinearColor Color
)

 Sets the background color of a comment node. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)

static void SetCommentText ( UEdGraphNode_Comment* CommentNode,
const FString& NewText
)

 Sets the comment text of a comment node. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Editor"
  • Meta=(ScriptMethod)

static void SetCreateDelegateFunction ( UK2Node_CreateDelegate* Node,
FName FunctionName
)

 End UK2Node extension/script methods BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static void SetNodePos ( UK2Node* Node,
FIntPoint pos
)

 Sets this node's visual position in the graph BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Graph Editing"
  • Meta=(ScriptMethod)

static void UpgradeOperatorNodes ( UBlueprint* Blueprint
)

 Replace any old operator nodes (float + float, vector + float, int + vector, etc) with the newer Promotable Operator version of the node. BlueprintEditorLibrary.h
  • BlueprintCallable
  • Category="Blueprint Upgrade Tools"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page