Navigation
API > API/Plugins > API/Plugins/ScriptableToolsFramework > API/Plugins/ScriptableToolsFramework/BaseTools > API/Plugins/ScriptableToolsFramework/BaseTools/UScriptableSingleClickTool
References
| Module | ScriptableToolsFramework |
| Header | /Engine/Plugins/Runtime/ScriptableToolsFramework/Source/ScriptableToolsFramework/Public/BaseTools/ScriptableSingleClickTool.h |
| Include | #include "BaseTools/ScriptableSingleClickTool.h" |
UFUNCTION (BlueprintNativeEvent, Category="Click Events")
void OnHitByClick
(
FInputDeviceRay ClickPos,
const FScriptableToolModifierStates & Modifiers
)
Remarks
OnHitByClick is called when the Tool has indicated it would like to consume a click event (via TestIfHitByClick), and the click was not cancelled or consumed by a nearer object.
Parameters
| Name | Description |
|---|---|
| ClickPos | the position of the click, including both a 3D ray from the eye, and (optionally) a 2D mouse position |
| Modifiers | current modifier key/button state |