Navigation
API > API/Plugins > API/Plugins/ScriptableToolsFramework
| Name | UScriptableToolViewportWidgetAPI |
| Type | class |
| Header File | /Engine/Plugins/Runtime/ScriptableToolsFramework/Source/ScriptableToolsFramework/Public/Utility/ScriptableToolContextObjects.h |
| Include Path | #include "Utility/ScriptableToolContextObjects.h" |
Syntax
UCLASS (MinimalAPI)
class UScriptableToolViewportWidgetAPI : public UScriptableToolContextObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UScriptableToolContextObject → UScriptableToolViewportWidgetAPI
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ClearOverlaidWidgetFunc | TUniqueFunction< void(TSharedRef< SWidget > InOverlaidWidget)> | Utility/ScriptableToolContextObjects.h | ||
| CurrentOverlaidWidget | TWeakPtr< SWidget > | Utility/ScriptableToolContextObjects.h | ||
| ReplaceOverlaidWidgetFunc | TUniqueFunction< void(TSharedRef< SWidget > InOverlaidWidget)> | Utility/ScriptableToolContextObjects.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearOverlayWidget() |
Utility/ScriptableToolContextObjects.h | ||
void Initialize
(
TUniqueFunction< void(TSharedRef< SWidget > InOverlaidWidget)> ReplaceOverlaidWidgetFuncIn, |
Utility/ScriptableToolContextObjects.h | ||
void SetOverlayWidget
(
TSharedRef< SWidget > InOverlaidWidget |
Utility/ScriptableToolContextObjects.h |
Overridden from UScriptableToolContextObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnToolEnded
(
UInteractiveTool* DeadTool |
Called whenever a tool is ended, for instance to let a context object remove listeners associated with that tool (it shouldn't have to do so, but may choose to for robustness). | Utility/ScriptableToolContextObjects.h | |
virtual void Shutdown () |
Called by the mode when shutting context objects down, allowing them to do any cleanup. | Utility/ScriptableToolContextObjects.h |