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

ABrush

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

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

Syntax

class ABrush : public AActor

Variables

	Name	Description
uint32: 1	bColored
uint32: 1	bDisplayShadedVolume	If true, display the brush with a shaded volume
uint32: 1	bInManipulation	Flag set when we are in a manipulation (scaling, translation, brush builder param change etc.)
uint32: 1	bNotForClientOrServer	If true, this brush is a builder or otherwise does not need to be loaded into the game
uint32: 1	bPlaceableFromClassBrowser	If true, this brush class can be placed using the class browser like other simple class types
TObjectPtr< cla...	Brush
TObjectPtr< cla...	BrushBuilder
FColor	BrushColor	Information.
TEnumAsByte< en...	BrushType	Type of brush
uint32: 1	bSolidWhenSelected
int32	PolyFlags
TArray< struct ...	SavedSelections	Stores selection information from geometry mode.
float	ShadedVolumeOpacityValue	Value used to set the opacity for the shaded volume, between 0-1

Constructors

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

Functions

	Name	Description
void	ClearNotForClientOrServer()	Indicate that brush need should be loaded on client or servers
void	CopyPosRotScaleFrom ( ABrush* Other )
const UBrush...	GetBrushBuilder()
UBrushCompon...	GetBrushComponent()	Returns BrushComponent subobject
FOnBrushRegi...	GetOnBrushRegisteredDelegate()	Function to get the 'brush registered' delegate
FColor	GetWireColor()	Figures out the best color to use for this brushes wireframe drawing.
void	InitPosRotScale()
bool	IsBrushShape()
bool	IsNotForClientOrServer()	Return if true if this brush is not used for gameplay (i.e. builder brush)
bool	IsStaticBrush()
bool	IsVolumeBrush()
bool	NeedsRebuild ( TArray< TWeakObjectPtr< ULevel > > ... )	Called to see if any of the levels need rebuilding
void	OnRebuildDone()	Called upon finishing the csg rebuild to clear the rebuild bool.
void	RebuildNavigationData()
void	SetNeedRebuild ( ULevel* InLevel )	Called to make not of the level that needs rebuilding
void	SetNotForClientOrServer()	Indicate that this brush need not be loaded on client or servers
void	SetSuppressBSPRegeneration ( bool bSuppress )

Overridden from AActor

	Name	Description
void	CheckForErrors()	Function that gets called from within Map_Check to allow this actor to check itself for any potential errors and register them with map check dialog.
void	Destroyed()	Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
FName	GetCustomIconName()	Returns a custom brush icon name to use in place of the automatic class icon where actors are represented via 2d icons in the editor (e.g scene outliner and menus)
bool	IsLevelBoundsRelevant()	Indicates whether this actor should participate in level bounds calculations
void	PostEditMove ( bool bFinished )	Called after an actor has been moved in the editor
void	PostRegisterAllComponents()	Called after all the components in the Components array are registered, called both in editor and during gameplay
bool	SetIsHiddenEdLayer ( bool bIsHiddenEdLayer )	Changes bHiddenEdLayer flag and returns true if flag changed.
void	SetIsTemporarilyHiddenInEditor ( bool bIsHidden )	Explicitly sets whether or not this actor is hidden in the editor for the duration of the current editor session
bool	SupportsExternalPackaging()	Does this actor supports external packaging?
bool	SupportsLayers()	Returns true if the actor supports modifications to its Layers property

Overridden from UObject

	Name	Description
bool	Modify ( bool bAlwaysMarkDirty )	That the object will be modified.
bool	NeedsLoadForClient()	Called during saving to determine the load flags to save with the object.
bool	NeedsLoadForServer()	Called during saving to determine the load flags to save with the object.
void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Typedefs

Name	Description
FOnBrushRegistered	Delegate used for notifications when PostRegisterAllComponents is called for a Brush

Constants

Name	Description
bSuppressBSPRegeneration	Global bool to suppress automatic BSP regeneration
GGeometryRebuildCause	Debug purposes only; an attempt to catch the cause of UE-36265
LevelsToRebuild	An array to keep track of all the levels that need rebuilding.
OnBrushRegistered	Delegate called when PostRegisterAllComponents is called for a Brush Define static delegate