Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · member function

UOrreryTerrainSubsystem::

GetBrushMaskInfo

Blueprint

What the registry says about a mask.

Declaration

UFUNCTION(BlueprintPure, Category="Orrery|Terrain|Brush")
bool GetBrushMaskInfo(FOrreryTerrainBrushMaskId Id, FOrreryTerrainBrushMaskInfo& OutInfo) const;
Blueprint Get Brush Mask Info
The graph as text
  1. Get Brush Mask Info (pure function; Target is Orrery Terrain Subsystem)
    • In Target (self object): self
    • In Id (OrreryTerrainBrushMaskId): not connected
    • Out Out Info (OrreryTerrainBrushMaskInfo): not connected
    • Out Return Value (Boolean): not connected
Header
#include "OrreryTerrainSubsystem.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability
Stable: changes within a major version only add.
Thread
Every member function is game thread unless it says otherwise. (the rule of UOrreryTerrainSubsystem)
Blueprint
Get Brush Mask Info, in Orrery › Terrain › Brush

Parameters

NameTypeDefaultMeaning
IdFOrreryTerrainBrushMaskId——
OutInfoFOrreryTerrainBrushMaskInfo&——

Returns

false, with OutInfo untouched, when the terrain does not hold it.