Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UBrushBuilder

Base class of UnrealEd brush builders.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBrushBuilder

UEditorBrushBuilder

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/BrushBuilder.h
Include	#include "Engine/BrushBuilder.h"

Syntax

class UBrushBuilder : public UObject

Remarks

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.

Variables

	Name	Description
FString	BitmapFilename
FName	Layer
uint32: 1	MergeCoplanars
uint32: 1	NotifyBadParams	If false, disabled the bad param notifications
TArray< struct ...	Polys
FString	ToolTip	Localized FString that will be displayed as the name of this brush builder in the editor
TArray< FVector...	Vertices

Constructors

	Name	Description
	UBrushBuilder ( const FObjectInitializer& ObjectIn... )

Functions

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss