UE2:BrushBuilder (U2)

Object >> BrushBuilder

Package:

Editor

Direct subclasses:

ConeBuilder, CubeBuilder, CurvedStairBuilder, CylinderBuilder, LinearStairBuilder, SheetBuilder, SpiralStairBuilder, TerrainBuilder, TetrahedronBuilder, VolumetricBuilder

This class in other games:

UT, U2XMP, UE2Runtime, UT2003, UT2004, UT3, UDK

BrushBuilder: 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.

Properties

Property group 'BrushBuilder'

BitmapFilename

Type: string

Default value: "BBGeneric"

ToolTip

Type: string

Default value: "Generic Builder"

Internal variables

Group

Type: name

Modifiers: private

MergeCoplanars

Type: bool

Modifiers: private

Polys

Type: array<BuilderPoly>

Modifiers: private

Vertices

Type: array<Object.Vector>

Modifiers: private

Structs

BuilderPoly

array<int> VertexIndices

int Direction

name Item

int PolyFlags

Functions

Native functions

BadParameters

native function bool BadParameters (optional string msg)

BeginBrush

native function BeginBrush (bool MergeCoplanars, name Group)

EndBrush

native function bool EndBrush ()

GetPolyCount

native function int GetPolyCount ()

GetVertex

native function Object.Vector GetVertex (int i)

GetVertexCount

native function int GetVertexCount ()

Poly3i

native function Poly3i (int Direction, int i, int j, int k, optional name ItemName, optional int PolyFlags)

Poly4i

native function Poly4i (int Direction, int i, int j, int k, int l, optional name ItemName, optional int PolyFlags)

PolyBegin

native function PolyBegin (int Direction, optional name ItemName, optional int PolyFlags)

PolyEnd

native function PolyEnd ()

Polyi

native function Polyi (int i)

Vertex3f

native function int Vertex3f (float x, float y, float z)

Vertexv

native function int Vertexv (Object.Vector v)

Events

Build

event bool Build ()