1. Epic GamesDeveloper
  3. UScriptableInteractiveTool

UScriptableInteractiveTool

[UScriptableInteractiveTool](API\Plugins\ScriptableToolsFramework\UScriptableInteractiveTool) is an extension of [UInteractiveTool](API\Runtime\InteractiveToolsFramework\UInteractiveTool) that allows the Tool functionality to be defined via Blueprints.

API > API/Plugins > API/Plugins/ScriptableToolsFramework

UScriptableInteractiveTool is an extension of UInteractiveTool that allows the Tool functionality to be defined via Blueprints.

   
Name UScriptableInteractiveTool
Type class
Header File /Engine/Plugins/Runtime/ScriptableToolsFramework/Source/ScriptableToolsFramework/Public/ScriptableInteractiveTool.h
Include Path #include "ScriptableInteractiveTool.h"

Syntax

UCLASS (Transient, Blueprintable)  
class UScriptableInteractiveTool : public UInteractiveTool

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Structs

Name Remarks
FAnyPropertyWatchInfo  

Enums

Protected

Name Remarks
EAnyPropertyWatchTypes  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bShowToolInEditor bool A generic flag to indicate whether this Tool should be shown in the UE Editor. ScriptableInteractiveTool.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Scriptable Tool Settings"
  • Meta=(DisplayName="Visible in Editor")
CustomIconPath FString Relative Path to a custom Icon Image for this Tool. ScriptableInteractiveTool.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Scriptable Tool Settings"
  • Meta=(DisplayName="Custom Icon Path")
EditCondition     ScriptableInteractiveTool.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Scriptable Tool Settings"
  • Meta=(DisplayName="Tool Builder Class", EditCondition="ToolStartupRequirements==EScriptableToolStartupRequirements::Custom", EditConditionHides, MustImplement="/Script/ScriptableToolsFramework.CustomScriptableToolBuilderBaseInterface")
EditConditionHides     ScriptableInteractiveTool.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Scriptable Tool Settings"
  • Meta=(DisplayName="Tool Builder Class", EditCondition="ToolStartupRequirements==EScriptableToolStartupRequirements::Custom", EditConditionHides, MustImplement="/Script/ScriptableToolsFramework.CustomScriptableToolBuilderBaseInterface")
GroupTags FScriptableToolGroupSet   ScriptableInteractiveTool.h
  • EditAnywhere
  • Transient
  • Category="Scriptable Tool Settings"
MustImplement     ScriptableInteractiveTool.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Scriptable Tool Settings"
  • Meta=(DisplayName="Tool Builder Class", EditCondition="ToolStartupRequirements==EScriptableToolStartupRequirements::Custom", EditConditionHides, MustImplement="/Script/ScriptableToolsFramework.CustomScriptableToolBuilderBaseInterface")
ToolCategory FText Category of this Tool, will be used in (eg) Tool Palette Section headers ScriptableInteractiveTool.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Scriptable Tool Settings"
  • Meta=(DisplayName="Category")
ToolLongName FText Long Name of this Tool, will be used in (eg) longer labels like the Accept/Cancel toolbar ScriptableInteractiveTool.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Scriptable Tool Settings"
  • Meta=(DisplayName="Long Name")
ToolName FText Name of this Tool, will be used in (eg) Toolbars ScriptableInteractiveTool.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Scriptable Tool Settings"
ToolShutdownType EScriptableToolShutdownType Specifies how the user exits this Tool, either Accept/Cancel-style or Complete-style ScriptableInteractiveTool.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Scriptable Tool Settings"
  • Meta=(DisplayName="Shutdown Type")
ToolStartupRequirements EScriptableToolStartupRequirements   ScriptableInteractiveTool.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Scriptable Tool Settings"
  • Meta=(DisplayName="Tool Startup Requirements")
ToolTooltip FText Tooltip used for this Tool in (eg) icons/etc ScriptableInteractiveTool.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Scriptable Tool Settings"
  • Meta=(DisplayName="Tooltip")

Functions

Public

Name Remarks Include Path Unreal Specifiers
Create and return a new, independent line set, used for drawing persistent line objects in the scene. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Drawing"

void AddLogMessage ( FText Message,
bool bHighlighted
)

 Append a Message to the UE Editor Log. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Messaging"
Create and return a new, independent point set, used for drawing persistent point objects in the scene. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Drawing"
Property Set support Create a new Tool Property Set (ie BP subclass of UScriptableInteractiveToolPropertySet) with the given string Identifier and attach it to the Tool. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|PropertySets"
  • Meta=(ExpandEnumAsExecs="Outcome", Identifier="Settings")
Create and return a new, independent triangle set, used for drawing persistent triangle and quad objects in the scene. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Drawing"

void ClearOverlayWidget()

   ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Widgets"

void ClearUserMessages ( bool bHelpMessage,
bool bWarningMessage
)

 Clear any active message shown via DisplayUserHelpMessage and/or DisplayUserWarningMessage ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Messaging"

void CreateTRSGizmo ( FString Identifier,
FTransform InitialTransform,
FScriptableToolGizmoOptions GizmoOptions,
EToolsFrameworkOutcomePins& Outcome
)

 Gizmo API ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Gizmos"
  • Meta=(ExpandEnumAsExecs="Outcome", Identifier="Gizmo1")

void DestroyTRSGizmo ( FString Identifier,
EToolsFrameworkOutcomePins& Outcome
)

 Destroy a created Gizmo by name Identifier ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Gizmos"
  • Meta=(ExpandEnumAsExecs="Outcome", Identifier="Gizmo1")

void DisplayUserHelpMessage ( FText Message
)

 Display a short Help message for the user, ie to guide them in Tool usage. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Messaging"

void DisplayUserWarningMessage ( FText Message
)

 Display a Warning message to the user, ie to indicate a problem/issue occurred. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Messaging"

void ForcePropertySetUpdateByName ( FString Identifier
)

 Force the Property Set associated with the given Identifier to be updated. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|PropertySets"
  • Meta=(Identifier="Settings")

UScriptableToolLineSet * GetDefaultLineSet()

 Retrieve the default line set object for the tool, used for drawing persistent line objects in the scene. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Drawing"

UScriptableToolPointSet * GetDefaultPointSet()

 Retrieve the default point set object for the tool, used for drawing persistent point objects in the scene. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Drawing"

UScriptableToolTriangleSet * GetDefaultTriangleSet()

 Retrieve the default triangle set object for the tool, used for drawing persistent triangle and quad objects in the scene. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Drawing"

FTransform GetGizmoTransform ( FString Identifier
)

 Get the current Transform on the Gizmo specified by the name Identifier ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Gizmos"
  • Meta=(Identifier="Gizmo1")

TArray< UToolTarget * > GetToolTargets()

   ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|ToolTargets"

UWorld * GetToolWorld()

 Access the World this Tool is currently operating on. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool"

virtual UWorld * GetWorld()

   ScriptableInteractiveTool.h  

void OnGizmoTransformChanged ( const FString& GizmoIdentifier,
FTransform NewTransform
)

 The OnGizmoTransformChanged event fires whenever the transform on any Gizmo created by CreateTRSGizmo() is modified. ScriptableInteractiveTool.h
  • BlueprintImplementableEvent
  • Category="ScriptableTool|Events"

void OnGizmoTransformStateChange ( const FString& GizmoIdentifier,
FTransform CurrentTransform,
EScriptableToolGizmoStateChangeType ChangeType
)

 The OnGizmoTransformStateChange event fires whenever the user start/ends a Gizmo transform, or when an Undo/Redo event occurs. ScriptableInteractiveTool.h
  • BlueprintImplementableEvent
  • Category="ScriptableTool|Events"
CanAccept function. ScriptableInteractiveTool.h
  • BlueprintNativeEvent
  • Category="ScriptableTool|Events"

bool OnScriptCanAccept_Implementation()

   ScriptableInteractiveTool.h  
OnScriptDrawHUD is called every frame. ScriptableInteractiveTool.h
  • BlueprintImplementableEvent
  • Category="ScriptableTool|Events"
OnScriptRender is called every frame. ScriptableInteractiveTool.h
  • BlueprintImplementableEvent
  • Category="ScriptableTool|Events"

void OnScriptSetup()

 Implement OnScriptSetup to do initial setup/configuration of the Tool, such as adding Property Sets, creating Gizmos, etc ScriptableInteractiveTool.h
  • BlueprintImplementableEvent
  • Category="ScriptableTool|Events"

void OnScriptShutdown ( EToolShutdownType ShutdownType
)

 OnScriptShutdown is called when the Tool is shutting down. ScriptableInteractiveTool.h
  • BlueprintImplementableEvent
  • Category="ScriptableTool|Events"

void OnScriptTick ( float DeltaTime
)

 OnScriptTick is called every Editor Tick, ie basically every frame. ScriptableInteractiveTool.h
  • BlueprintImplementableEvent
  • Category="ScriptableTool|Events"

void RemovePropertySetByName ( FString Identifier,
EToolsFrameworkOutcomePins& Outcome
)

 Remove a Property Set from the current Tool, found via it's unique Identifier. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|PropertySets"
  • Meta=(ExpandEnumAsExecs="Outcome", Identifier="Settings")

void RequestToolShutdown ( bool bAccept,
bool bShowUserPopupMessage,
FText UserMessage
)

 Request that the active Tool be shut down. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool"
  • Meta=(Identifier="Settings")
Restore the values of the specified PropertySet, optionally with a specific SaveKey string. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|PropertySets"
  • Meta=(Identifier="Settings")
Save the values of the specified PropertySet, optionally with a specific SaveKey string. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|PropertySets"
  • Meta=(Identifier="Settings")

void SetGizmoTransform ( FString Identifier,
FTransform NewTransform,
bool bUndoable
)

 Update the Transform on the Gizmo specified by the name Identifier ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Gizmos"
  • Meta=(Identifier="Gizmo1")

void SetGizmoVisible ( FString Identifier,
bool bVisible
)

 Set an existing Gizmo visible/hidden based on its name Identifier ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Gizmos"
  • Meta=(Identifier="Gizmo1")

void SetOverlayWidget ( UUserWidget* Widget,
bool bMakeDraggable
)

   ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Widgets"

void SetPropertySetVisibleByName ( FString Identifier,
bool bVisible
)

 Set the visibility of a Property Set that is paired with the given unique Identifier. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|PropertySets"
  • Meta=(Identifier="Settings")

void SetTargets ( TArray< TObjectPtr< UToolTarget > > TargetsIn
)

   ScriptableInteractiveTool.h  

virtual void SetTargetWorld ( UWorld* World
)

   ScriptableInteractiveTool.h  

UScriptableInteractiveToolPropertySet * WatchBoolProperty ( UScriptableInteractiveToolPropertySet* PropertySet,
FString PropertyName,
const FToolBoolPropertyModifiedDelegate& OnModified
)

 Watch a Bool-valued Property for changes ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|PropertySets"
Watch an Enum-valued Property for changes. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|PropertySets"

UScriptableInteractiveToolPropertySet * WatchFloatProperty ( UScriptableInteractiveToolPropertySet* PropertySet,
FString PropertyName,
const FToolFloatPropertyModifiedDelegate& OnModified
)

 Property Watcher support Watch a Float-valued Property for changes (double precision) ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|PropertySets"

UScriptableInteractiveToolPropertySet * WatchIntProperty ( UScriptableInteractiveToolPropertySet* PropertySet,
FString PropertyName,
const FToolIntPropertyModifiedDelegate& OnModified
)

 Watch an Integer-valued Property for changes ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|PropertySets"

UScriptableInteractiveToolPropertySet * WatchNameProperty ( UScriptableInteractiveToolPropertySet* PropertySet,
FString PropertyName,
const FToolFNamePropertyModifiedDelegate& OnModified
)

 Watch an (F)Name-valued Property for changes ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|PropertySets"

UScriptableInteractiveToolPropertySet * WatchObjectProperty ( UScriptableInteractiveToolPropertySet* PropertySet,
FString PropertyName,
const FToolObjectPropertyModifiedDelegate& OnModified
)

 Watch an Object-valued Property for changes (ie UObject, UClass, etc) ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|PropertySets"
Watch any Property in a PropertySet for changes. ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|PropertySets"

UScriptableInteractiveToolPropertySet * WatchStringProperty ( UScriptableInteractiveToolPropertySet* PropertySet,
FString PropertyName,
const FToolStringPropertyModifiedDelegate& OnModified
)

 Watch a String-valued Property for changes ScriptableInteractiveTool.h
  • BlueprintCallable
  • Category="ScriptableTool|PropertySets"

Overridden from UInteractiveTool

Name Remarks Include Path Unreal Specifiers

virtual bool CanAccept()

   ScriptableInteractiveTool.h  

virtual void DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

   ScriptableInteractiveTool.h  

virtual bool HasAccept()

   ScriptableInteractiveTool.h  

virtual bool HasCancel()

   ScriptableInteractiveTool.h  

virtual void OnTick ( float DeltaTime
)

   ScriptableInteractiveTool.h  

virtual void Render ( IToolsContextRenderAPI* RenderAPI
)

 Render and DrawHUD support ScriptableInteractiveTool.h  

virtual void Setup()

   ScriptableInteractiveTool.h  

virtual void Shutdown ( EToolShutdownType ShutdownType
)

   ScriptableInteractiveTool.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual UBaseScriptableToolBuilder * GetNewCustomToolBuilderInstance ( UObject* Outer
)

 Return instance of custom tool builder. Should only be called on CDO. ScriptableInteractiveTool.h  

virtual void OnGizmoTransformChanged_Handler ( FString GizmoIdentifier,
FTransform NewTransform
)

   ScriptableInteractiveTool.h  

virtual void OnGizmoTransformStateChange_Handler ( FString GizmoIdentifier,
FTransform CurrentTransform,
EScriptableToolGizmoStateChangeType ChangeType
)

   ScriptableInteractiveTool.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   ScriptableInteractiveTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page