UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FInteractiveToolActionSet Class Reference

#include <InteractiveToolActionSet.h>

Public Member Functions

INTERACTIVETOOLSFRAMEWORK_API void RegisterAction (UInteractiveTool *Tool, int32 ActionID, const FString &ActionName, const FText &ShortUIName, const FText &DescriptionText, EModifierKey::Type Modifiers, const FKey &ShortcutKey, TFunction< void()> ActionFunction)
 
INTERACTIVETOOLSFRAMEWORK_API const FInteractiveToolActionFindActionByID (int32 ActionID) const
 
INTERACTIVETOOLSFRAMEWORK_API void CollectActions (TArray< FInteractiveToolAction > &OutActions) const
 
INTERACTIVETOOLSFRAMEWORK_API void ExecuteAction (int32 ActionID) const
 

Protected Attributes

TArray< FInteractiveToolActionActions
 

Detailed Description

FInteractiveToolActionSet maintains a list of FInteractiveToolAction. Each UInteractiveTool contains an instance of this class.

Member Function Documentation

◆ CollectActions()

void FInteractiveToolActionSet::CollectActions ( TArray< FInteractiveToolAction > &  OutActions) const

Return the internal list of registered Actions by adding to the OutActions array

◆ ExecuteAction()

void FInteractiveToolActionSet::ExecuteAction ( int32  ActionID) const

Execute the action identified by ActionID

◆ FindActionByID()

const FInteractiveToolAction * FInteractiveToolActionSet::FindActionByID ( int32  ActionID) const

Find an existing Action by ID

Returns
located Action, or nullptr if not found

◆ RegisterAction()

void FInteractiveToolActionSet::RegisterAction ( UInteractiveTool Tool,
int32  ActionID,
const FString &  ActionName,
const FText ShortUIName,
const FText DescriptionText,
EModifierKey::Type  Modifiers,
const FKey ShortcutKey,
TFunction< void()>  ActionFunction 
)

Register an Action with the ActionSet. This function is intended to be called by UInteractiveTool::RegisterActions() implementations

Member Data Documentation

◆ Actions

TArray<FInteractiveToolAction> FInteractiveToolActionSet::Actions
protected

The documentation for this class was generated from the following files: