func_brush

This article needs more  links to other articles to help  integrate it into the encyclopedia. Please help improve this article by adding links  that are relevant to the context within the existing text.
January 2024

Class hierarchy
CFuncBrush ↳CBaseEntity
modelentities.cpp

func_brush is an e2 available in all Source games. It's a generic brush entity with various features.

It combines the functions of func_wall, func_illusionary and func_wall_toggle from Goldsource. The older entities can still be used, for an insignificant amount of memory saved.

Important:This is a preserved entity in .
If the game has round restart mechanics this entity may not behave as expected:

More info

On a new round entities with this classname will intentionally not reset. You can use logic_auto to emulate resetting it. Killing it removes it forever, as it is not respawned on a new round. It cannot be spawned with a point_template. Parenting this with non-preserved entities may have undesirable effects.

Note:Func_brush is not a preserved entity in Left 4 Dead 2.

Todo: Test other games

In code, it is represented by theCFuncBrushclass, defined in themodelentities.cppfile.

Keyvalues

Solidity (Solidity) <choices>

Used to control the solidity/collision of these brushes.

• 0: Toggle - The solidity can be toggled together with its visibility.
• 1: Never Solid
• 2: Always Solid

Solid BSP (solidbsp) <boolean>

Set this to BSP if the player seems to rotate oddly relative to the surface.

• 0: VPhysics
• 1: BSP (QPhysics)

NPC class excluded from collisions (excludednpc) <classname>

If an NPC classname (i.e. npc_zombie) is specified here, NPCs of that type won't collide with these brushes.

Invert NPC class exclusion (invert_exclusion) <boolean>

If set, then the excluded NPC class will consider this brush solid, and all other NPC classes will consider it non-solid.

Start Disabled (StartDisabled) <boolean>

Stay dormant until activated (with theEnableinput).

{{Bug|Start Disabled doesn't seem to work in

Workaround:Use logic_auto with an output to Disable the func_brush

Tip:If Solidity is Toggle, disabling will also make the entity non-solid.

This template (and its redirect) is  Deprecated. Its use is not recommended and its functionality may be compromised.
Please use {{Brush rendering note}} instead.
You can help our editors by replacing or deleting this template on the Pages that use this template. Once no more pages use this template, it should be Marked for deletion.

Note:Archived page history

Important:These pages are linked often from page history logs so Special:WhatLinksHere will not show anything.

Flags

Ignore player +USE - Entity will ignore all Use inputs, including ones from the player. : [2]

Inputs

SetExcluded

Change the NPC class that does not collide with the brush.

SetInvert

Whether to reverse the NPC class exclusion rule.

Toggle  !FGD

Toggles the enabled state of the entity

EnableDisable:

Enable / Disable

Enable/disable this entity from performing its task. It might also disappear from view.

SetDamageFilter <targetnameRedirectInput/string>

Sets a filter for this entity for when it receives damage.

EnableDamageForces

Allows the entity to be pushed by damage done to it (usually force amount correlates with the damage done).

DisableDamageForces

Prevents the entity from being pushed by damage done to it.

Todo: move/mention at proper place