Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · member function

UOrreryTerrainBrushToolComponent::

SetToolActive

Blueprint

Turn the tool on or off.

Declaration

UFUNCTION(BlueprintCallable, Category="Orrery|Terrain|Tool")
void SetToolActive(bool bActive);
Blueprint Set Tool Active
The graph as text
  1. Set Tool Active (function call; Target is Orrery Terrain Brush Tool Component)
    • In Target (self object): self
    • In Active (Boolean): false
Header
#include "Tools/OrreryTerrainBrushToolComponent.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability
Stable: changes within a major version only add.
Thread
Game thread, local player only. (the rule of UOrreryTerrainBrushToolComponent)
Blueprint
Set Tool Active, in Orrery › Terrain › Tool

Description

On: finds or adds the sculpt component, adds the mapping context to the local player, binds the actions and starts drawing. Off: ends an open stroke and undoes all of that.

Parameters

NameTypeDefaultMeaning
bActivebool——