Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · member function

UOrreryTerrainBrushToolComponent::

DrawToolHUD

Blueprint

Draws the HUD text and the cursor ring on the player's canvas, once per frame while the tool is active.

Declaration

UFUNCTION(BlueprintNativeEvent, Category="Orrery|Terrain|Tool")
void DrawToolHUD(UCanvas* Canvas);
Blueprint Event DrawToolHUD
The graph as text
  1. Event DrawToolHUD (event)
    • Out Output Delegate (delegate): not connected
    • Out Canvas (Canvas object): not connected
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
Event DrawToolHUD, in Orrery › Terrain › Tool

Description

Override in a subclass or a Blueprint to restyle or replace it.

Parameters

NameTypeDefaultMeaning
CanvasUCanvas*—

The HUD canvas; valid for this call only.