1. Epic GamesDeveloper
  3. UScriptableInteractiveTool

UScriptableInteractiveTool

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

API > API/Plugins > API/Plugins/ScriptableToolsFramework

Inheritance Hierarchy

References

   
Module ScriptableToolsFramework
Header /Engine/Plugins/Runtime/ScriptableToolsFramework/Source/ScriptableToolsFramework/Public/ScriptableInteractiveTool.h
Include #include "ScriptableInteractiveTool.h"

Syntax

UCLASS (Transient, Blueprintable)  
class UScriptableInteractiveTool : public UInteractiveTool

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bShowToolInEditor A generic flag to indicate whether this Tool should be shown in the UE Editor.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString CustomIconPath Relative Path to a custom Icon Image for this Tool.
Protected variable UProperty Transient duplicatetransient, nontransactional, skipserialization TObjectPtr< UScriptableTool_HUDAPI > DrawHUDHelper  
Protected variable UProperty Transient duplicatetransient, nontransactional, skipserialization TMap< FString, TObjectPtr< UCombinedTransformGizmo > > Gizmos Trying to avoid making a UStruct for this internal stuff
Public variable FString Identifier  
Protected variable TMap< FString, TWeakObjectPtr< UScriptableInteractiveToolPropertySet > > NamedPropertySets  
Public variable FString const FToolFloatPropertyModifiedDelegate & OnModified  
Public variable FString const FToolFNamePropertyModifiedDelegate & OnModified  
Public variable FString const FToolObjectPropertyModifiedDelegate & OnModified  
Public variable FString const FToolPropertyModifiedDelegate & OnModified  
Public variable FString const FToolStringPropertyModifiedDelegate & OnModified  
Public variable FString const FToolBoolPropertyModifiedDelegate & OnModified  
Public variable FString const FToolIntPropertyModifiedDelegate & OnModified  
Public variable FString const FToolEnumPropertyModifiedDelegate & OnModified  
Public variable FString EToolsFrameworkOutcomePins & Outcome  
Public variable FString PropertyName  
Protected variable UProperty Transient duplicatetransient, nontransactional, skipserialization TObjectPtr< UScriptableTool_RenderAPI > RenderHelper  
Public variable FString SaveKey  
Protected variable UProperty Transient duplicatetransient, nontransactional, skipserialization TWeakObjectPtr< UWorld > TargetWorld  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FText ToolCategory Category of this Tool, will be used in (eg) Tool Palette Section headers
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FText ToolLongName Long Name of this Tool, will be used in (eg) longer labels like the Accept/Cancel toolbar
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FText ToolName Name of this Tool, will be used in (eg) Toolbars
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EScriptableToolShutdownType ToolShutdownType Specifies how the user exits this Tool, either Accept/Cancel-style or Complete-style
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FText ToolTooltip Tooltip used for this Tool in (eg) icons/etc
Protected variable TArray< FAnyPropertyWatchInfo > WatchAnyPropertyInfo  
Protected variable TArray< FToolBoolPropertyModifiedDelegate > WatchBoolPropertyDelegates  
Protected variable TArray< FToolEnumPropertyModifiedDelegate > WatchEnumPropertyDelegates  
Protected variable TArray< FToolFloatPropertyModifiedDelegate > WatchFloatPropertyDelegates  
Protected variable TArray< FToolFNamePropertyModifiedDelegate > WatchFNamePropertyDelegates  
Protected variable TArray< FToolIntPropertyModifiedDelegate > WatchIntPropertyDelegates  
Protected variable TArray< FToolObjectPropertyModifiedDelegate > WatchObjectPropertyDelegates  
Protected variable TArray< FToolStringPropertyModifiedDelegate > WatchStringPropertyDelegates  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

AddLogMessage ( FText Message,
bool bHighlighted
)

 Append a Message to the UE Editor Log.
Public function Virtual Const bool  
Public function UFunction BlueprintCallable, Category void

ClearUserMessages ( bool bHelpMessage,
bool bWarningMessage
)

 Clear any active message shown via DisplayUserHelpMessage and/or DisplayUserWarningMessage
Public function UFunction BlueprintCallable, Category, Meta void

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

 Gizmo API
Public function UFunction BlueprintCallable, Category, Meta void

DestroyTRSGizmo ( FString Identifier,
EToolsFrameworkOutcomePins& Outcome
)

 Destroy a created Gizmo by name Identifier
Public function UFunction BlueprintCallable, Category void

DisplayUserHelpMessage ( FText Message
)

 Display a short Help message for the user, ie to guide them in Tool usage.
Public function UFunction BlueprintCallable, Category void

DisplayUserWarningMessage ( FText Message
)

 Display a Warning message to the user, ie to indicate a problem/issue occurred.
Public function Virtual void

DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

  
Public function UFunction BlueprintCallable, Category, Meta void

ForcePropertySetUpdateByName ( FString Identifier
)

 Force the Property Set associated with the given Identifier to be updated.
Protected function Virtual UBaseScriptableToolBuilder *

GetNewCustomToolBuilderInstance ( UObject* Outer
)

 Return instance of custom tool builder. Should only be called on CDO.
Public function UFunction BlueprintCallable, Category UWorld * Access the World this Tool is currently operating on.
Protected function Virtual Const UWorld *  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function UFunction Category, BlueprintImplementableEvent void

OnGizmoTransformChanged ( const FString& GizmoIdentifier,
FTransform NewTransform
)

 The OnGizmoTransformChanged event fires whenever the transform on any Gizmo created by CreateTRSGizmo() is modified.
Protected function Virtual void

OnGizmoTransformChanged_Handler ( FString GizmoIdentifier,
FTransform NewTransform
)

  
Public function UFunction Category, BlueprintImplementableEvent 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.
Protected function Virtual void

OnGizmoTransformStateChange_Handler ( FString GizmoIdentifier,
FTransform CurrentTransform,
EScriptableToolGizmoStateChangeType ChangeType
)

  
Public function Const UFunction Category blueprintnativeevent bool CanAccept function.
Public function Const bool  
Public function UFunction Category, BlueprintImplementableEvent void

OnScriptDrawHUD ( UPARAM(DisplayName="HUD Object") UScriptableTool_HUDAPI* DrawHUDAPI
)

 OnScriptDrawHUD is called every frame.
Public function UFunction Category, BlueprintImplementableEvent void

OnScriptRender ( UPARAM(DisplayName="Render Object") UScriptableTool_RenderAPI* RenderAPI
)

 OnScriptRender is called every frame.
Public function UFunction Category, BlueprintImplementableEvent void Implement OnScriptSetup to do initial setup/configuration of the Tool, such as adding Property Sets, creating Gizmos, etc
Public function UFunction Category, BlueprintImplementableEvent void

OnScriptShutdown ( EToolShutdownType ShutdownType
)

 OnScriptShutdown is called when the Tool is shutting down.
Public function UFunction Category, BlueprintImplementableEvent void

OnScriptTick ( float DeltaTime
)

 OnScriptTick is called every Editor Tick, ie basically every frame.
Public function Virtual void

OnTick ( float DeltaTime
)

  
Protected function Virtual void  
Public function UFunction BlueprintCallable, Category, Meta void

RemovePropertySetByName ( FString Identifier,
EToolsFrameworkOutcomePins& Outcome
)

 Remove a Property Set from the current Tool, found via it's unique Identifier.
Public function Virtual void

Render ( IToolsContextRenderAPI* RenderAPI
)

 Render and DrawHUD support
Public function UFunction BlueprintCallable, Category, Meta void

RequestToolShutdown ( bool bAccept,
bool bShowUserPopupMessage,
FText UserMessage
)

 Request that the active Tool be shut down.
Public function UFunction BlueprintCallable, Category, Meta void

SetGizmoTransform ( FString Identifier,
FTransform NewTransform,
bool bUndoable
)

 Update the Transform on the Gizmo specified by the name Identifier
Public function UFunction BlueprintCallable, Category, Meta void

SetGizmoVisible ( FString Identifier,
bool bVisible
)

 Set an existing Gizmo visible/hidden based on its name Identifier
Public function UFunction BlueprintCallable, Category, Meta void

SetPropertySetVisibleByName ( FString Identifier,
bool bVisible
)

 Set the visibility of a Property Set that is paired with the given unique Identifier.
Public function Virtual void

SetTargetWorld ( UWorld* World
)

  
Public function Virtual void

Setup ()

  
Public function Virtual void

Shutdown ( EToolShutdownType ShutdownType
)

  
Public function UFunction BlueprintCallable, Category, Meta  

UPARAM ( DisplayName
)

 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.
Public function UFunction BlueprintCallable, Category, Meta  

UPARAM ( DisplayName
)

 Restore the values of the specified PropertySet, optionally with a specific SaveKey string.
Public function UFunction BlueprintCallable, Category, Meta  

UPARAM ( DisplayName
)

 Save the values of the specified PropertySet, optionally with a specific SaveKey string.
Public function UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

 Property Watcher support Watch a Float-valued Property for changes (double precision)
Public function UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

 Watch an Integer-valued Property for changes
Public function UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

 Watch a Bool-valued Property for changes
Public function UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

 Watch an Enum-valued Property for changes.
Public function UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

 Watch a String-valued Property for changes
Public function UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

 Watch an (F)Name-valued Property for changes
Public function UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

 Watch an Object-valued Property for changes (ie UObject, UClass, etc)
Public function UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

 Watch any Property in a PropertySet for changes.
Public function UFunction BlueprintCallable, Category, Meta  

UPARAM ( DisplayName
)

 Get the current Transform on the Gizmo specified by the name Identifier

Classes

  Type Name Description
Protected struct FAnyPropertyWatchInfo    

Enums

  Type Name Description
Protected enum EAnyPropertyWatchTypes    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page