Orbdale Terrain · OrbdaleTerrainEditor module · member function
UOrbdaleTerrainEditorLibrary::
StartTool
Editor onlyBlueprintStart a tool of the mode's palette, as its button does: Sculpt, Smooth, Flatten, Paint, GroundClass, Holes, Plate, Corridor, FeatureList or New.
Declaration
UFUNCTION(BlueprintCallable, Category="Orbdale|Terrain|Editor")
static bool StartTool(const FString& ToolId);Blueprint Start Tool
The graph as text
- Start Tool (function call)
- In Tool Id (String): empty
- Out Return Value (Boolean): not connected
- Header
#include "OrbdaleTerrainEditorLibrary.h"- Module
PublicDependencyModuleNames.Add("OrbdaleTerrainEditor");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 UOrbdaleTerrainEditorLibrary)
- Blueprint
- Start Tool, in Orbdale › Terrain › Editor
Description
The tool starts on the level viewport's next tick. Leaving New this way makes no terrain: only its Create Terrain button (or NewTerrain) does.
Parameters
| Name | Type | Default | Meaning |
|---|---|---|---|
ToolId | const FString& | — | — |
Returns
false when the mode is not active or refuses the tool (no terrain, a tool another plugin disabled).