FInteractiveToolActionSet

[FInteractiveToolActionSet](API\Runtime\InteractiveToolsFramework\FInteractiveToolActionSet) maintains a list of [FInteractiveToolAction](API\Runtime\InteractiveToolsFramework\FInteractiveToolAction).

Choose your operating system:

Windows

macOS

Linux

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveToolActionSet.h

Include

#include "InteractiveToolActionSet.h"

Syntax

class FInteractiveToolActionSet

Remarks

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

Variables

Name Description

Protected variable

TArray< FIntera...

 

Actions

Functions

Name Description

Public function Const

void

 

CollectActions

(
    TArray< FInteractiveToolAction >& ...
)

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

Public function Const

void

 

ExecuteAction

(
    int32 ActionID
)

Execute the action identified by ActionID

Public function Const

const FInter...

 

FindActionByID

(
    int32 ActionID
)

Find an existing Action by ID

Public function

void

 

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.