Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainEditor module · member function

UOrreryTerrainEditorLibrary::

PressToolKey

Editor onlyBlueprint

Press a key in the terrain mode as the keyboard does in a level viewport: Enter commits a plate or corridor, Escape cancels (a commit waiting for its ground first), BackSpace takes a vertex back, Delete removes the selected feature.

Declaration

UFUNCTION(BlueprintCallable, Category="Orrery|Terrain|Editor")
static bool PressToolKey(const FString& Key);
Blueprint Press Tool Key
The graph as text
  1. Press Tool Key (function call)
    • In Key (String): empty
    • Out Return Value (Boolean): not connected
Header
#include "OrreryTerrainEditorLibrary.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrainEditor"); in an editor module’s Build.cs: an editor module, not in packaged games.
Stability
Stable: changes within a major version only add.
Thread
Game thread, editor only. (the rule of UOrreryTerrainEditorLibrary)
Blueprint
Press Tool Key, in Orrery › Terrain › Editor

Parameters

NameTypeDefaultMeaning
Keyconst FString&—

An FKey name (Enter, Escape, BackSpace, Delete, ...).

Returns

Whether the active tool took it; false for an unknown key or with no terrain mode active.