1. Epic GamesDeveloper
  3. Kismet

Kismet

API > API/Editor

   
Name Kismet
Type Editor
Location /Engine/Source/Editor/Kismet/
Module Build Rules Kismet.Build.cs

Classes

Name Remarks
FBlueprintAssetHandler Singleton class that marshals different blueprint asset handlers for different asset class types
FBlueprintComponentsApplicationMode  
FBlueprintDefaultsApplicationMode  
FBlueprintEditor Main Kismet asset editor
FBlueprintEditorApplicationMode  
FBlueprintEditorModule The blueprint editor module provides the blueprint editor application.
FBlueprintEditorToolbar  
FBlueprintEditorUnifiedMode  
FBlueprintInterfaceApplicationMode  
FBlueprintMacroApplicationMode  
FBlueprintManagedListDetails Blueprint managed list details
FBlueprintMemberReferenceDetails Property type customization for FMemberReference.
FBlueprintNamespaceHelper A helper class for managing namespace info for a single Blueprint context.
FBlueprintNamespaceRegistry A shared utility class that keeps track of registered Blueprint namespace identifiers sourced from objects and assets in the editor.
FCategorySectionHelper  
FDebugLineItem The base class for a line entry in the debugging tree view.
FDetailsDiff Struct to handle showing details for an object and provide an interface for listing all differences
FFiBMetaData  
FFindInBlueprintSearchManager Singleton manager for handling all Blueprint searches, helps to manage the going progress of Blueprints, and is thread-safe.
FFindInBlueprintsGraph Graphs, such as functions and macros, are stored here
FFindInBlueprintsGraphNode Graph nodes use this class to store their data
FFindInBlueprintsNoResult Class used to denote an empty search result
FFindInBlueprintsPin Pins use this class to store their data
FFindInBlueprintsProperty Property data is stored here
FFindInBlueprintsResult Item that matched the search results
FFullBlueprintEditorCommands  
FImaginaryBlueprint An "imaginary" representation of a UBlueprint, featuring raw strings or other imaginary objects in the place of more structured substances
FImaginaryComponent An "imaginary" representation of a FProperty of an instanced component, featuring raw strings or other imaginary objects in the place of more structured substances
FImaginaryFiBData  
FImaginaryGraph An "imaginary" representation of a UEdGraph, featuring raw strings or other imaginary objects in the place of more structured substances
FImaginaryGraphNode An "imaginary" representation of a UEdGraphNode, featuring raw strings or other imaginary objects in the place of more structured substances
FImaginaryPin An "imaginary" representation of a UEdGraphPin, featuring raw strings or other imaginary objects in the place of more structured substances
FImaginaryProperty An "imaginary" representation of a FProperty, featuring raw strings or other imaginary objects in the place of more structured substances
FKismet2Menu Kismet menu
FKismetVariableDragDropAction DragDropAction class for dropping a Variable onto a graph
FMyBlueprintCommands  
FMyBlueprintItemDragDropAction DragDropAction class for drag and dropping an item from the My Blueprints tree (e.g., variable or function)
FPinValueInspectorTooltip Class holding functions to spawn a pin value inspector tooltip
FSCSDiff Struct to support diffing the component tree for a blueprint
FSCSEditorTreeNode FSCSEditorTreeNode
FSCSEditorTreeNodeActorBase  
FSCSEditorTreeNodeChildActor  
FSCSEditorTreeNodeComponent  
FSCSEditorTreeNodeComponentBase  
FSCSEditorTreeNodeInstanceAddedComponent  
FSCSEditorTreeNodeInstancedInheritedComponent  
FSCSEditorTreeNodeRootActor  
FSCSEditorTreeNodeSeparator  
FSearchableValueInfo  
FStreamSearch Async task for searching Blueprints
SBlueprintDiff Visual Diff between two Blueprints
SBlueprintEditorSelectedDebugObjectWidget  
SBlueprintNamespaceEntry A custom widget class that provides support for Blueprint namespace entry and/or selection.
SBlueprintRevisionMenu  
SDetailsDiff Visual Diff between two Assets
SFilterableObjectList  
SFindInBlueprints Widget for searching for (functions/events) across all blueprints or just a single blueprint
SFixupSelfContextDialog Widget to prompt the user to fixup self context on bad K2Node_CallFunction Pastes
SKismetDebugTreeView  
SKismetInspector Widget that shows properties and tools related to the selected node(s)
SMyBlueprint  
SPinValueInspector Inspects the referenced pin object's underlying property value and presents it within a tree view.
SSCS_RowWidget  
SSCS_RowWidget_ActorRoot  
SSCS_RowWidget_Separator  
SSCSEditor  
SSCSEditorDragDropTree SSCSEditorDragDropTree - implements STreeView for our specific node type and adds drag/drop functionality.
TFunctionRef  
UBlueprintCompilerExtension  
UBlueprintEditorToolMenuContext  
UBlueprintPaletteFavorites  
USCSEditorExtensionContext  
USSCSEditorMenuContext  
USubobjectEditorExtensionContext  

Structs

Name Remarks
FBlueprintActionMenuBuilder Responsible for constructing a list of viable blueprint actions.
FBlueprintActionMenuItem Wrapper around a UBlueprintNodeSpawner, which takes care of specialized node spawning.
FBlueprintActionMenuUtils  
FBlueprintCompilationManager  
FBlueprintCompiledData  
FBlueprintDebugObjectInstance  
FBlueprintDragDropMenuItem At certain times we want a single menu entry that represents a set of UBlueprintNodeSpawners (generally when all those UBlueprintNodeSpawners wrap the same UField).
FBlueprintEditorApplicationModes  
FBlueprintEditorTabs  
FBlueprintNamespaceUtilities A wrapper struct around various Blueprint namespace utility and support methods.
FBPCompileRequest  
FCompilerResultsSummoner  
FComponentEventConstructionData The structure used to construct the "Add Event" menu entries
FComponentUniqueDisplay Struct to contain search results and help compare them for uniqueness.
FCustomDebugObject  
FDetailsDiffPanel Panel used to display the details
FDiffPanel Panel used to display the blueprint
FDiffResultItem Individual Diff item shown in the list of diffs
FDisableGatheringDataOnScope  
FFavoritedBlueprintPaletteItem  
FFiBMD  
FFindInBlueprintCachingOptions Options to configure the bulk caching task
FFindInBlueprintSearchTags Const values for Find-in-Blueprints to tag searchable data
FFixupSelfContextItem  
FReplaceNodeReferencesHelper A helper class for Replacing Variable references in blueprints
FReviewComment  
FReviewCommentContext  
FReviewTopic  
FSearchData Tracks data relevant to a Blueprint for searches
FSearchDataVersionInfo Consolidated version info for a Blueprint search data entry
FSearchTagDataPair Used for external gather functions to add Key/Value pairs to be placed into Json
FSelectionDetailsSummoner  
FSimpleFTextKeyStorage Stores an FText as if it were an FString, does zero advanced comparisons needed for true FText comparisons.
FStreamSearchOptions  

Interfaces

Name Remarks
IBlueprintAssetHandler Interface used to define how to interact with a blueprint within an asset
IBlueprintEditor Blueprint editor public interface
IBlueprintSelectionNotifier Modular feature interface for Blueprint Editor selection notifications Implemented by plugins that want to be notified when Blueprint Editor selection changes
IReviewCommentAPI  
ISCSEditorCustomization Customization class that allows per-component type handling of various SCS editor functionality.
ISCSEditorUICustomization SCSEditor UI customization
IUserDefinedEnumEditor Enum editor public interface
IUserDefinedStructureEditor Enum editor public interface

Typedefs

Name Type Remarks Include Path
FDebugTreeItemPtr TSharedPtr< class FDebugLineItem > Shared pointer to a debugging tree line entry. Debugging/SKismetDebugTreeView.h
FGetSelectedObjectsDelegate TBaseDelegate_OneParam< void, TArray< FComponentEventConstructionData > & > The delegate that the caller must supply to BuildComponentActionsSubMenu that returns the currently selected items BlueprintEditor.h
FImaginaryFiBDataSharedPtr TSharedPtr< FImaginaryFiBData, ESPMode::ThreadSafe >   FindInBlueprintManager.h
FImaginaryFiBDataWeakPtr TWeakPtr< FImaginaryFiBData, ESPMode::ThreadSafe > Shared pointers to cached imaginary data (must be declared as thread-safe). FindInBlueprintManager.h
FInspectorSelectionSet TSet< class UObject * >   SKismetInspector.h
FNodeCreationAnalytic TBaseDelegate_NoParams< void > Delegate for Node Creation Analytics BlueprintEditor.h
FOnGetFunctionCustomizationInstance TBaseDelegate_OneParam< TSharedPtr< IDetailCustomization >, TSharedPtr< IBlueprintEditor > > Delegate used to customize function display BlueprintEditorModule.h
FOnGetGraphCustomizationInstance TBaseDelegate_OneParam< TSharedPtr< IDetailCustomization >, TSharedPtr< IBlueprintEditor > > Delegate used to customize graph display BlueprintEditorModule.h
FOnGetLocalVariableCustomizationInstance TBaseDelegate_OneParam< TSharedPtr< IDetailCustomization >, TSharedPtr< IBlueprintEditor > > Delegate used to customize local variable display BlueprintEditorModule.h
FOnGetVariableCustomizationInstance TBaseDelegate_OneParam< TSharedPtr< IDetailCustomization >, TSharedPtr< IBlueprintEditor > > Delegate used to customize variable display BlueprintEditorModule.h
FOnMyBlueprintActionSelected TBaseDelegate_OneParam< void, UObject * >   SBlueprintDiff.h
FOnSearchComplete TBaseDelegate_OneParam< void, TArray< FImaginaryFiBDataSharedPtr > & >   FindInBlueprints.h
FPinValueInspectorTreeViewNodePtr TSharedPtr< struct FPinValueInspectorTreeViewNode >   SPinValueInspector.h
FSCSEditorActorNodePtrType TSharedPtr< class FSCSEditorTreeNodeActorBase >   SSCSEditor.h
FSCSEditorChildActorNodePtrType TSharedPtr< class FSCSEditorTreeNodeChildActor >   SSCSEditor.h
FSCSEditorCustomizationBuilder TBaseDelegate_OneParam< TSharedRef< class ISCSEditorCustomization >, TSharedRef< IBlueprintEditor > >   BlueprintEditorModule.h
FSCSEditorTreeNodePtrType TSharedPtr< class FSCSEditorTreeNode > SCS editor tree node pointer types. SSCSEditor.h
FSearchResult TSharedPtr< FFindInBlueprintsResult >   FindInBlueprintManager.h
SSCSTreeType SSCSEditorDragDropTree   SSCSEditor.h
STreeViewType STreeView< FSearchResult >   FindInBlueprints.h

Enums

Public

Name Remarks
EAddOrUpdateBlueprintSearchMetadataFlags Options for FFindInBlueprintSearchManager::AddOrUpdateBlueprintSearchMetadata()
EComponentEditorMode::Type Component editor mode
EContextTargetFlags::Type  
EDefaultBlueprintNamespaceType Default namespace type for objects/assets if one is not explicitly assigned.
EFiBCacheBarWidget Cache bar widgets.
EFiBCacheOpFlags Flags to control the UX while caching
EFiBCacheOpType Which assets to index for caching
EFiBIndexAllPermission Whether the Find-in-Blueprints window allows the user to load and resave all assets with out-of-date Blueprint search metadata.
EFiBSearchBarWidget Search bar widgets.
EFiBVersion FiB data versioning
ENodeCreateAction::Type Describes user actions that created new node
ERefreshBlueprintEditorReason::Type Describes the reason for Refreshing the editor
EReviewCommentTaskState  
EReviewTopicType Swarm stores shelved file reviews separately from comments on submitted CLs
ESearchableValueStatus  
ESearchDataStateFlags State flags for search database entries
ESearchQueryFilter Filters are used by functions for searching to decide whether items can call certain functions or match the requirements of a function
NodeSectionID::Type Enums to use when grouping the blueprint members in the list panel.

Functions

Public

Name Remarks Include Path Unreal Specifiers

FName CallStackViewer::GetTabName()

   CallStackViewer.h  

void CallStackViewer::RegisterTabSpawner ( FTabManager& TabManager
)

   CallStackViewer.h  

void CallStackViewer::UpdateDisplayedCallstack ( TArrayView< const FFrame*const > ScriptStack
)

   CallStackViewer.h  

void ClearWatchListFromBlueprint ( TWeakObjectPtr< UBlueprint > BlueprintObj
)

 Called when a BlueprintObj should no longer be watched WatchPointViewer.h  

void ContinueExecution()

 Called when we unpause execution and set watch values back to the blueprint versions WatchPointViewer.h  

CSV_DECLARE_CATEGORY_EXTERN ( FindInBlueprint
)

 CSV stats profiling category FindInBlueprintManager.h  

bool DiffWidgetUtils::HasNextDifference ( SListView< TSharedPtr< struct FDiffSingleResult > >& ListView,
const TArray< TSharedPtr< struct FDiffSingleResult > >& ListViewSource
)

   SBlueprintDiff.h  

bool DiffWidgetUtils::HasPrevDifference ( SListView< TSharedPtr< struct FDiffSingleResult > >& ListView,
const TArray< TSharedPtr< struct FDiffSingleResult > >& ListViewSource
)

   SBlueprintDiff.h  

void DiffWidgetUtils::SelectNextRow ( SListView< TSharedPtr< struct FDiffSingleResult > >& ListView,
const TArray< TSharedPtr< struct FDiffSingleResult > >& ListViewSource
)

   SBlueprintDiff.h  

void DiffWidgetUtils::SelectPrevRow ( SListView< TSharedPtr< struct FDiffSingleResult > >& ListView,
const TArray< TSharedPtr< struct FDiffSingleResult > >& ListViewSource
)

   SBlueprintDiff.h  
  BlueprintActionMenuBuilder.h  
  FindInBlueprintManager.h  
  FindInBlueprintManager.h  
  FindInBlueprintManager.h  

FText FindInBlueprintsHelpers::AsFText ( TSharedPtr< FJsonValue > InJsonValue,
const TMap< int32, FText >& InLookupTable
)

 Looks up a JsonValue's FText from the passed lookup table FindInBlueprints.h  

FText FindInBlueprintsHelpers::AsFText ( int32 InValue,
const TMap< int32, FText >& InLookupTable
)

 Looks up a JsonValue's FText from the passed lookup table FindInBlueprints.h  

bool FindInBlueprintsHelpers::ConstructSearchTermFromFunction ( const UFunction* Function,
FString& SearchTerm
)

 Constructs a search term for a function using Find-in-Blueprints search syntax FindInBlueprints.h  

void FindInBlueprintsHelpers::ExpandAllChildren ( FSearchResult InTreeNode,
TSharedPtr< STreeView< TSharedPtr< FFindInBlueprintsResult > > > InTreeView
)

 Iterates through all the given tree node's children and tells the tree view to expand them FindInBlueprints.h  

UClass * FindInBlueprintsHelpers::GetFunctionOriginClass ( const UFunction* Function
)

 Utility function to find the ancestor class or interface from which a function is inherited. FindInBlueprints.h  

FString FindInBlueprintsHelpers::GetPinTypeAsString ( const FEdGraphPinType& InPinType
)

 Retrieves the pin type as a string value FindInBlueprints.h  

bool FindInBlueprintsHelpers::IsTextEqualToString ( const FText& InText,
const FString& InString
)

   FindInBlueprints.h  

bool FindInBlueprintsHelpers::ParsePinType ( FText InKey,
FText InValue,
FEdGraphPinType& InOutPinType
)

 Parses a pin type from passed in key names and values FindInBlueprints.h  

FName GetTabName()

   WatchPointViewer.h  

uint32 GetTypeHash ( const FReviewTopic& Topic
)

   ReviewComments.h  

void OnRenameAsset ( const FAssetData& AssetData,
const FString& OldAssetName
)

 Called when an asset is renamed; updates the watches on the asset WatchPointViewer.h  

void RegisterTabSpawner ( FTabManager& TabManager
)

   WatchPointViewer.h  

void RemoveWatchesForAsset ( const FAssetData& AssetData
)

 Called when we want to remove watches in the watch window from a blueprint does NOT remove watches from the pins in the blueprint object WatchPointViewer.h  

void RemoveWatchesForBlueprint ( TWeakObjectPtr< UBlueprint > BlueprintObj
)

 Called when we want to remove watches in the watch window from a blueprint does NOT remove watches from the pins in the blueprint object WatchPointViewer.h  

class UE_DEPRECATED (

  1. 0,
    "USCSEditorExtensionContext has been deprecated,
    use USubobjectEditorExtensionContext instead."
    )
   SCSEditorExtensionContext.h  

class UE_DEPRECATED (

  1. 0,
    "SSCSEditor has been deprecated,
    use a child class of SSubobjectEditor instead."
    )
   SSCSEditor.h  

class UE_DEPRECATED (

  1. 0,
    "USSCSEditorMenuContext has been deprecated,
    use USubobjectEditorMenuContext instead."
    )
   SSCSEditorMenuContext.h  

void UpdateWatchListFromBlueprint ( TWeakObjectPtr< UBlueprint > BlueprintObj
)

 Called when we are adding or changing watches from BlueprintObj WatchPointViewer.h  

Static

Name Remarks Include Path Unreal Specifiers

static uint32 FindInBlueprintsHelpers::GetTypeHash ( const FindInBlueprintsHelpers::FSimpleFTextKeyStorage& InObject
)

   FindInBlueprints.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page