SKismetInspector

Widget that shows properties and tools related to the selected node(s)

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Kismet

Header

/Engine/Source/Editor/Kismet/Public/SKismetInspector.h

Include

#include "SKismetInspector.h"

Syntax

class SKismetInspector : public SCompoundWidget

Remarks

Widget that shows properties and tools related to the selected node(s)

Variables

Name Description

Protected variable

bool

 

bComponenetDetailsCustomizationEnabled

Component details customization enabled.

Protected variable

TWeakPtr< FBlue...

 

BlueprintEditorPtr

Pointer back to the kismet 2 tool that owns us

Protected variable

bool

 

bRefreshOnTick

When TRUE, the Kismet inspector needs to refresh the details view on Tick

Protected variable

bool

 

bShowComponents

Should we currently show components

Protected variable

bool

 

bShowInspectorPropertyView

Should we currently show the property view

Protected variable

bool

 

bShowPublicView

If true show the public view control

Protected variable

bool

 

bShowTitleArea

If true show the kismet inspector title widget

Protected variable

TSharedPtr< SBo...

 

ContextualEditingBorderWidget

Border widget that wraps a dynamic context-sensitive widget for editing objects that the property window is displaying

Protected variable

TSharedPtr< cla...

 

EditNameWidget

The widget used to edit the names of properties

Protected variable

FIsPropertyEdit...

 

IsPropertyEditingEnabledDelegate

User defined delegate for IsPropertyEditingEnabled:

Protected variable

TWeakPtr< SDock...

 

OwnerTab

The tab that owns this details view.

Protected variable

TSharedPtr< cla...

 

PropertyView

Property viewing widget

Protected variable

FText

 

PropertyViewTitle

String used as the title above the property window

Protected variable

ECheckBoxState

 

PublicViewState

State of CheckBox representing whether to show only the public variables

Protected variable

FShowDetailsOpt...

 

RefreshOptions

Details options that are used by the inspector on the next refresh.

Protected variable

TArray< UObject...

 

RefreshPropertyObjects

Holds the property objects that need to be displayed by the inspector starting on the next tick

Protected variable

TSet< TWeakFiel...

 

SelectedObjectProperties

Set of object properties that should be visible

Protected variable

TArray< TWeakOb...

 

SelectedObjects

Selected objects for this detail view

Protected variable

TSharedPtr< FSt...

 

StructToDisplay

Struct to preview

Protected variable

TSharedPtr< cla...

 

StructureDetailsView

Sturct Detail View

Protected variable

FOnFinishedChan...

 

UserOnFinishedChangingProperties

User defined delegate for OnFinishedChangingProperties

Functions

Name Description

Protected function

void

 

AddPropertiesRecursive

(
    FProperty* Property
)

Add this property and all its child properties to SelectedObjectProperties

Public function

void

 

Construct

(
    const FArguments& InArgs
)

Public function

void

 

EnableComponentDetailsCustomization

(
    bool bEnable
)

Turns on or off details customization for components

Protected function Const

FText

 

GetContextualEditingWidgetTitle()

Generates the text for the title in the contextual editing widget

Protected function Const

EVisibility

 

GetInheritedBlueprintComponentWarningVisibility()

Returns whether the warning about an inherited component not being editable should be visible

Public function Const

TSharedPtr< ...

 

GetOwnerTab()

Public function Const

TSharedPtr< ...

 

GetPropertyView()

Protected function Const

EVisibility

 

GetPropertyViewVisibility()

Returns whether the property view be visible

Protected function Const

ECheckBoxSta...

 

GetPublicViewCheckboxState()

Public function Const

const TArray...

 

GetSelectedObjects()

Returns the list of selected objects

Protected function Const

bool

 

IsAnyParentContainerSelected

(
    const FPropertyAndParent& Property...
)

Protected function Const

bool

 

IsPropertyEditingEnabled()

Returns whether the properties in the view should be editable

Public function Const

bool

 

IsPropertyVisible

(
    const FPropertyAndParent& Property...
)

Used to control visibility of a property in the property window

Public function Const

bool

 

IsSelected

(
    UObject* Object
)

Protected function Const

bool

 

IsStructViewPropertyReadOnly

(
    const FPropertyAndParent& Property...
)

Is struct view property read only

Protected function

TSharedRef< ...

 

MakeContextualEditingWidget

(
    FKismetSelectionInfo& SelectionInf...,
    const FShowDetailsOptions& Options
)

Generates a widget that is used to edit the specified object array contextually.

Protected function

void

 

OnInheritedBlueprintComponentWarningHyperlinkClicked

(
    const FSlateHyperlinkRun::FMetadata...
)

Opens the parent blueprint when the hyperlink in the warning is clicked

Public function

void

 

SetOwnerTab

(
    TSharedRef< SDockTab > Tab
)

Protected function

void

 

SetPropertyWindowContents

(
    TArray< UObject* > Objects
)

Show properties of the selected object

Protected function

void

 

SetPublicViewCheckboxState

(
    ECheckBoxState InIsChecked
)

Public function

void

 

ShowDetailsForObjects

(
    const TArray< UObject* >& Pro...,
    const FShowDetailsOptions& Options
)

Update the inspector window to show information on the supplied objects

Public function

void

 

ShowDetailsForSingleObject

(
    UObject* Object,
    const FShowDetailsOptions& Options
)

Update the inspector window to show information on the supplied object

Public function

void

 

ShowSingleStruct

(
    TSharedPtr< FStructOnScope > InStru...
)

Update the inspector window to show single struct.

Protected function

void

 

UpdateFromObjects

(
    const TArray< UObject* >& Pro...,
    FKismetSelectionInfo& SelectionInf...,
    const FShowDetailsOptions& Options
)

Update the inspector window to show information on the supplied objects

Protected function

void

 

UpdateFromSingleStruct

(
    const TSharedPtr< FStructOnScope > ...
)

Update the inspector window to show information on the single struct

Overridden from SWidget

Name Description

Public function Virtual

void

 

Tick

(
    const FGeometry& AllottedGeometry,
    const double InCurrentTime,
    const float InDeltaTime
)

Ticks this widget with Geometry.

Classes

Name

Description

Public struct

FArguments

Public struct

FShowDetailsOptions

Options for ShowDetails

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss