UBrushBuilder | Unreal Engine 5.7 Documentation

Base class of UnrealEd brush builders.

Tips for writing brush builders:

Always validate the user-specified and call BadParameters function if anything is wrong, instead of actually building geometry. If you build an invalid brush due to bad user parameters, you'll cause an extraordinary amount of pain for the poor user.
When generating polygons with more than 3 vertices, BE SURE all the polygon's vertices are coplanar! Out-of-plane polygons will cause geometry to be corrupted.


Name	UBrushBuilder
Type	class
Header File	/Engine/Source/Runtime/Engine/Classes/Engine/BrushBuilder.h
Include Path	#include "Engine/BrushBuilder.h"

Syntax

UCLASS (Abstract, HideCategories=(Object), MinimalAPI)  
class UBrushBuilder : public UObject

Name	Remarks	Include Path	Unreal Specifiers
UBrushBuilder ( const FObjectInitializer& ObjectInitializer )		Engine/BrushBuilder.h

Name	Type	Remarks	Include Path	Unreal Specifiers
BitmapFilename	FString		Engine/BrushBuilder.h
NotifyBadParams	uint32	If false, disabled the bad param notifications	Engine/BrushBuilder.h	Transient
ToolTip	FString	Localized FString that will be displayed as the name of this brush builder in the editor	Engine/BrushBuilder.h

Name	Remarks	Include Path
virtual bool BadParameters ( const FText& msg )		Engine/BrushBuilder.h
virtual void BeginBrush ( bool InMergeCoplanars, FName InLayer )	@ todo document all below	Engine/BrushBuilder.h
virtual bool Build ( UWorld* InWorld, ABrush* InBrush )	Builds the brush shape for the specified ABrush or the builder brush if Brush is nullptr.	Engine/BrushBuilder.h
virtual bool EndBrush ( UWorld* InWorld, ABrush* InBrush )		Engine/BrushBuilder.h
virtual int32 GetPolyCount()		Engine/BrushBuilder.h
virtual FVector GetVertex ( int32 i ) const		Engine/BrushBuilder.h
virtual int32 GetVertexCount()		Engine/BrushBuilder.h
virtual void Poly3i ( int32 Direction, int32 i, int32 j, int32 k, FName ItemName, bool bIsTwoSidedNonSolid )		Engine/BrushBuilder.h
virtual void Poly4i ( int32 Direction, int32 i, int32 j, int32 k, int32 l, FName ItemName, bool bIsTwoSidedNonSolid )		Engine/BrushBuilder.h
virtual void PolyBegin ( int32 Direction, FName ItemName )		Engine/BrushBuilder.h
virtual void PolyEnd()		Engine/BrushBuilder.h
virtual void Polyi ( int32 i )		Engine/BrushBuilder.h
virtual int32 Vertex3f ( float X, float Y, float Z )		Engine/BrushBuilder.h
virtual int32 Vertexv ( FVector v )		Engine/BrushBuilder.h