1. Epic GamesDeveloper
  3. FKismetDebugUtilities

FKismetDebugUtilities

API > API/Editor > API/Editor/UnrealEd

   
Name FKismetDebugUtilities
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/Kismet2/KismetDebugUtilities.h
Include Path #include "Kismet2/KismetDebugUtilities.h"

Syntax

class FKismetDebugUtilities

Constructors

Name Remarks Include Path Unreal Specifiers

FKismetDebugUtilities()

   Kismet2/KismetDebugUtilities.h  

Enums

Public

Name Remarks
EWatchTextResult  
FKismetDebugUtilities The maximum number of trace samples to gather before overwriting old ones.

Typedefs

Name Type Remarks Include Path
FOnWatchedPinsListChanged TMulticastDelegate_OneParam< void, class UBlueprint * > Delegate for when pins are added or removed from the watchlist. Kismet2/KismetDebugUtilities.h

Constants

Name Type Remarks Include Path
WatchedPinsListChangedEvent FOnWatchedPinsListChanged Notifies listeners when a watched pin is added or removed. Kismet2/KismetDebugUtilities.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void AddPinWatch ( const UBlueprint* Blueprint,
FBlueprintWatchedPin&& WatchedPin
)

 Adds a pin property watch Kismet2/KismetDebugUtilities.h  

static void AttemptToBreakExecution ( UBlueprint* BlueprintObj,
const UObject* ActiveObject,
const FFrame& StackFrame,
const FBlueprintExceptionInfo& Info,
UEdGraphNode* NodeStoppedAt,
int32 DebugOpcodeOffset
)

   Kismet2/KismetDebugUtilities.h  

static bool BlueprintHasBreakpoints ( const UBlueprint* Blueprint
)

 Queries whether a blueprint has breakpoints in it Kismet2/KismetDebugUtilities.h  

static bool BlueprintHasPinWatches ( const UBlueprint* Blueprint
)

 Returns whether any pins are watched for a Blueprint Kismet2/KismetDebugUtilities.h  

static bool CanInspectPinValue ( const UEdGraphPin* Pin
)

 Determines if the given pin's value can be inspected Kismet2/KismetDebugUtilities.h  

static bool CanWatchPin ( const UBlueprint* Blueprint,
const UEdGraphPin* Pin,
const TArray< FName >& InPathToProperty
)

 Returns whether a pin property can be watched Kismet2/KismetDebugUtilities.h  

static void CheckBreakConditions ( UEdGraphNode* NodeStoppedAt,
bool bHitBreakpoint,
int32 BreakpointOffset,
bool& InOutBreakExecution
)

   Kismet2/KismetDebugUtilities.h  

static void CleanupBreakpoints ( const UBlueprint* Blueprint
)

   Kismet2/KismetDebugUtilities.h  

static void CleanupWatches ( const UBlueprint* Blueprint
)

   Kismet2/KismetDebugUtilities.h  

static void ClearBreakpoints ( const UBlueprint* Blueprint
)

 Deletes all breakpoints in this blueprint Kismet2/KismetDebugUtilities.h  

static void ClearBreakpointsForPath ( const FString& BlueprintPath
)

   Kismet2/KismetDebugUtilities.h  

static void ClearPinWatches ( const UBlueprint* Blueprint
)

 Removes all Watched pins from a blueprint Kismet2/KismetDebugUtilities.h  

static void CreateBreakpoint ( const UBlueprint* Blueprint,
UEdGraphNode* Node,
bool bIsEnabled
)

 Adds a breakpoint to the provided node Kismet2/KismetDebugUtilities.h  

static bool DoesPinHaveWatches ( const UBlueprint* Blueprint,
const UEdGraphPin* Pin
)

 Returns whether there are any watched properties for a given pin Kismet2/KismetDebugUtilities.h  

static void EndOfScriptExecution ( const FBlueprintContextTracker& BlueprintContext
)

 Called on terminatation of the current script execution so we can reset any break conditions Kismet2/KismetDebugUtilities.h  

static FBlueprintBreakpoint * FindBreakpointByPredicate ( const UBlueprint* Blueprint,
const TFunctionRef< bool(const FBlueprintBreakpoint&)> Predicate
)

 Returns the first breakpoint that matches the provided predicate or nullptr if nothing matched Kismet2/KismetDebugUtilities.h  

static FBlueprintBreakpoint * FindBreakpointForNode ( const UEdGraphNode* OwnerNode,
const UBlueprint* OwnerBlueprint,
bool bCheckSubLocations
)

 Returns the breakpoint associated with a node, or NULL Kismet2/KismetDebugUtilities.h  

static const UClass * FindClassForNode ( const UObject* Object,
const UFunction* Function
)

 Return proper class for breakpoint. Kismet2/KismetDebugUtilities.h  

static FProperty * FindClassPropertyForNode ( UBlueprint* Blueprint,
const UEdGraphNode* Node
)

 Looks thru the debugging data for any class variables associated with the node (e.g., temporary variables or timelines) Kismet2/KismetDebugUtilities.h  

static FProperty * FindClassPropertyForPin ( UBlueprint* Blueprint,
const UEdGraphPin* Pin
)

 Looks thru the debugging data for any class variables associated with the pin. Kismet2/KismetDebugUtilities.h  

static EWatchTextResult FindDebuggingData ( UBlueprint* Blueprint,
UObject* ActiveObject,
const UEdGraphPin* WatchPin,
const FProperty*& OutProperty,
const void*& OutData,
const void*& OutDelta,
UObject*& OutParent,
TArray< UObject* >& SeenObjects,
bool* bOutIsDirectPtr
)

 Helper function for converting between blueprint and debuggable data output params are only valid if the return result is EWatchTextResult::EWTR_Valid. Kismet2/KismetDebugUtilities.h  

static UEdGraphPin * FindPinWatchByPredicate ( const UBlueprint* Blueprint,
const TFunctionRef< bool(const UEdGraphPin*)> Predicate
)

 Returns the first watched pin that matches the provided predicate or nullptr if nothing matched Kismet2/KismetDebugUtilities.h  

static UEdGraphNode * FindSourceNodeForCodeLocation ( const UObject* Object,
const UFunction* Function,
int32 DebugOpcodeOffset,
bool bAllowImpreciseHit
)

 Find the node that resulted in code at the specified location in the Object, or NULL if there was a problem (e.g., no debugging information was generated) Kismet2/KismetDebugUtilities.h  

static void ForeachBreakpoint ( const UBlueprint* Blueprint,
TFunctionRef< void(FBlueprintBreakpoint&)> Task
)

 Performs a task on every breakpoint in the provided blueprint Kismet2/KismetDebugUtilities.h  

static void ForeachPinPropertyWatch ( const UBlueprint* Blueprint,
TFunctionRef< void(FBlueprintWatchedPin&)> Task
)

 Performs a task on every watched pin in the provided blueprint Kismet2/KismetDebugUtilities.h  

static void ForeachPinWatch ( const UBlueprint* Blueprint,
TFunctionRef< void(UEdGraphPin*)> Task
)

 Performs a task on every watched pin in the provided blueprint Kismet2/KismetDebugUtilities.h  

static FText GetAndClearLastExceptionMessage()

 This doesn't work properly if there is more than one blueprint editor open at once either (one will consume it, the others will be left in the cold) Kismet2/KismetDebugUtilities.h  

static void GetBreakpointInstallationSites ( const FBlueprintBreakpoint& Breakpoint,
TArray< uint8* >& InstallSites
)

 Returns the installation site(s); don't cache these pointers! Kismet2/KismetDebugUtilities.h  

static TArray< FBlueprintBreakpoint > * GetBreakpoints ( const UBlueprint* Blueprint
)

 Retrieve the Array of breakpoints associated with a blueprint. Kismet2/KismetDebugUtilities.h  

static UWorld * GetCurrentDebuggingWorld()

 Returns the most recent hit breakpoint; if a debugging session has started in PIE/SIE; otherwise none Kismet2/KismetDebugUtilities.h  

static UEdGraphNode * GetCurrentInstruction()

 Returns the current instruction; if a debugging session has started; otherwise none Kismet2/KismetDebugUtilities.h  

static EWatchTextResult GetDebugInfo ( TSharedPtr< FPropertyInstanceInfo >& OutDebugInfo,
UBlueprint* Blueprint,
UObject* ActiveObject,
const UEdGraphPin* WatchPin
)

 Gets the debug info for a specified site. Kismet2/KismetDebugUtilities.h  

static void GetDebugInfo_InContainer ( int32 Index,
TSharedPtr< FPropertyInstanceInfo >& DebugInfo,
const FProperty* Property,
const void* Data
)

   Kismet2/KismetDebugUtilities.h  

static void GetDebugInfoInternal ( TSharedPtr< FPropertyInstanceInfo >& DebugInfo,
const FProperty* Property,
const void* PropertyValue
)

 Retrieves Debug info from a Property and a pointer to it's associated data. Kismet2/KismetDebugUtilities.h  

static UEdGraphNode * GetMostRecentBreakpointHit()

 Returns the most recent hit breakpoint; if a debugging session has started; otherwise none Kismet2/KismetDebugUtilities.h  
Retrieve the user settings associated with a blueprint. Kismet2/KismetDebugUtilities.h  

static const TSimpleRingBuffer< FKismetTraceSample > & GetTraceStack()

 Get the trace stack. Kismet2/KismetDebugUtilities.h  

static void GetValidBreakpointLocations ( const UK2Node_MacroInstance* MacroInstanceNode,
TArray< const UEdGraphNode* >& BreakpointLocations
)

 Returns the set of valid macro source node breakpoint location(s) for the given macro instance node. Kismet2/KismetDebugUtilities.h  

static TArray< FBlueprintWatchedPin > * GetWatchedPins ( const UBlueprint* Blueprint
)

 Retrieve the Array of watched pins associated with a blueprint. Kismet2/KismetDebugUtilities.h  

static EWatchTextResult GetWatchText ( FString& OutWatchText,
UBlueprint* Blueprint,
UObject* ActiveObject,
const UEdGraphPin* WatchPin
)

 Gets the watched tooltip for a specified site. Kismet2/KismetDebugUtilities.h  

static bool HasDebuggingData ( const UBlueprint* Blueprint
)

 Is there debugging data available for this blueprint? Kismet2/KismetDebugUtilities.h  

static bool IsBreakpointValid ( const FBlueprintBreakpoint& Breakpoint
)

 Is the node a valid breakpoint target? (i.e., the node is impure and ended up generating code) Kismet2/KismetDebugUtilities.h  

static bool IsPinBeingWatched ( const UBlueprint* Blueprint,
const UEdGraphPin* Pin,
const TArray< FName >& InPathToProperty
)

 Returns whether a pin property is being watched Kismet2/KismetDebugUtilities.h  

static bool IsSingleStepping()

 Whether or not we are single stepping. Kismet2/KismetDebugUtilities.h  

static void NotifyDebuggerOfEndOfGameFrame ( UWorld* CurrentWorld
)

 Notify the debugger of the end of the game frame. Kismet2/KismetDebugUtilities.h  

static void NotifyDebuggerOfStartOfGameFrame ( UWorld* CurrentWorld
)

 Notify the debugger of the start of the game frame. Kismet2/KismetDebugUtilities.h  

static void OnScriptException ( const UObject* ActiveObject,
const FFrame& StackFrame,
const FBlueprintExceptionInfo& Info
)

   Kismet2/KismetDebugUtilities.h  

static void PostDuplicateBlueprint ( UBlueprint* SrcBlueprint,
UBlueprint* DupBlueprint,
const TArray< UEdGraphNode* >& DupNodes
)

 Duplicates debug data from original blueprint to new duplicated blueprint Kismet2/KismetDebugUtilities.h  

static void ReapplyBreakpoint ( FBlueprintBreakpoint& Breakpoint
)

 Reapplies the breakpoint (used after recompiling to ensure it is set if needed) Kismet2/KismetDebugUtilities.h  

static void RemoveBreakpointFromNode ( const UEdGraphNode* OwnerNode,
const UBlueprint* OwnerBlueprint
)

 Start the process of deleting this breakpoint Kismet2/KismetDebugUtilities.h  

static void RemoveBreakpointsByPredicate ( const UBlueprint* Blueprint,
const TFunctionRef< bool(const FBlueprintBreakpoint&)> Predicate
)

 Removes any breakpoint that matches the provided predicate Kismet2/KismetDebugUtilities.h  

static void RemoveEmptySettings ( const FString& BlueprintPath
)

   Kismet2/KismetDebugUtilities.h  

static bool RemovePinPropertyWatchesByPredicate ( const UBlueprint* Blueprint,
const TFunctionRef< bool(const FBlueprintWatchedPin&)> Predicate
)

 Removes any watched pin that matches the provided predicate Kismet2/KismetDebugUtilities.h  

static bool RemovePinWatch ( const UBlueprint* Blueprint,
const UEdGraphPin* Pin,
const TArray< FName >& InPathToProperty
)

 Removes a pin property Watch Kismet2/KismetDebugUtilities.h  

static bool RemovePinWatchesByPredicate ( const UBlueprint* Blueprint,
const TFunctionRef< bool(const UEdGraphPin*)> Predicate
)

 Removes any watched pin that matches the provided predicate Kismet2/KismetDebugUtilities.h  

static void RequestAbortingExecution()

 Request abort the current frame execution Kismet2/KismetDebugUtilities.h  

static void RequestSingleStepIn()

 Request an attempt to single-step to the next node Kismet2/KismetDebugUtilities.h  

static void RequestStepOut()

 Request an attempt to step out of the current graph Kismet2/KismetDebugUtilities.h  

static void RequestStepOver()

 Request an attempt to step over to the next node in this graph or the calling graph Kismet2/KismetDebugUtilities.h  

static void RestoreBreakpointsOnLoad ( const UBlueprint* Blueprint
)

 Handles breakpoint validation/restoration after loading the given Blueprint Kismet2/KismetDebugUtilities.h  

static void SaveBlueprintEditorSettings()

 Save any modifications made to breakpoints Kismet2/KismetDebugUtilities.h  

static void SetBreakpointEnabled ( FBlueprintBreakpoint& Breakpoint,
bool bIsEnabled
)

 Set or clear the enabled flag for the breakpoint Kismet2/KismetDebugUtilities.h  

static void SetBreakpointEnabled ( const UEdGraphNode* OwnerNode,
const UBlueprint* OwnerBlueprint,
bool bIsEnabled
)

   Kismet2/KismetDebugUtilities.h  

static void SetBreakpointEnabledForSingleStep ( FBlueprintBreakpoint& Breakpoint,
bool bDeleteAfterStep
)

 Sets this breakpoint up as a single-step breakpoint (will disable or delete itself after one go if the breakpoint wasn't already enabled) Kismet2/KismetDebugUtilities.h  

static void SetBreakpointInternal ( FBlueprintBreakpoint& Breakpoint,
bool bShouldBeEnabled
)

 Install/uninstall the breakpoint into/from the script code for the generated class that contains the node Kismet2/KismetDebugUtilities.h  

static void SetBreakpointLocation ( FBlueprintBreakpoint& Breakpoint,
UEdGraphNode* NewNode
)

 Set the node that the breakpoint should focus on Kismet2/KismetDebugUtilities.h  

static void TogglePinWatch ( const UBlueprint* Blueprint,
const UEdGraphPin* Pin
)

 Toggles whether a pin is being watched Kismet2/KismetDebugUtilities.h  

static bool TracepointBreakAllowedOnOwningWorld ( const UObject* ObjOuter
)

 Looks along the outer chain to find the owning world and disallowing breaking on tracepoints for editor preview and inactive worlds. Kismet2/KismetDebugUtilities.h  

static void UpdateBreakpointStateWhenHit ( const UEdGraphNode* OwnerNode,
const UBlueprint* OwnerBlueprint
)

 Update the internal state of the breakpoint when it got hit Kismet2/KismetDebugUtilities.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page