Func brush

From Valve Developer Community

The title given to this article is incorrect due to technical limitations. The correct title is func_brush.

This Brush-based Entity is available in all Source Games.

Table of contents
1 Entity description
2 Keyvalues
3 Flags
4 Inputs
5 Outputs
[edit]

Entity description

A brush entity with various features. Has replaced the obsolete func_wall, func_illusionary and func_wall_toggle entities by adding more functionality.

[edit]

Keyvalues

Defines the name that other entities refer to this entity by.
  • hammerid [Episode Two Update]
<integer readonly> This id is used for debugging purposes in Hammer.
Specifies the targetname of this entity's Parent in a movement hierarchy. Child entities move with their Parent.
  • origin
<origin> The position of this entity's center in the world. Rotating entities rotate around their origin.
  • renderfx
<choices>
Literal Value Description
0 Normal
1 Slow Pulse
2 Fast Pulse
3 Slow Wide Pulse
4 Fast Wide Pulse
5 Slow Fade Away
6 Fast Fade Away
7 Slow Become Solid
8 Fast Become Solid
9 Slow Strobe
10 Fast Strobe
11 Faster Strobe
12 Slow Flicker
13 Fast Flicker
14 Constant Glow
15 Distort
16 Hologram (Distort + fade)
17 Scale up
22 Spotlight FX
23 Cull By Distance (TEST)
24 Fade Wider Pulse
  • rendermode
<choices> Used to set a non-standard rendering mode on this entity. See also 'FX Amount' and 'FX Color'.
Literal Value Render Mode Description (Click for more info.)
0 Normal Default rendering.
1 Color Obsolete.
2 Texture Plain opacity.
3 Glow No Z buffer checks. Fixed size on screen.
4 Solid / Alphatest Obsolete. (Use alphatest capabilities in materials instead.)
5 Additive Obsolete. Add this entity's color to what's behind it.
7 Additive Fractional Frame Obsolete? Blend between animation frames.
8 Alpha Add (Not in FGD.) Add alpha.
9 World Space Glow No Z buffer checks. Fixed size in world (as opposed to on screen).
10 Dont Render / None Don't render.
  • renderamt
<integer> FX Amount (0 - 255) - How opaque the entity will be rendered. (0 is fully transparent, while 255 is fully opaque). Will not work if the rendermode keyvalue is set to Normal or Dont Render.
  • rendercolor
<color255> FX Color - What color the entity will be rendered in (to the degree of the opacity set with renderamt).
  • globalname
<string> Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with globalnames matching entities in the previous map will have the previous map's state copied over their state.
  • StartDisabled
<boolean>
  • disableshadows
<boolean> Used to disable dynamic shadow casting from this entity.
  • _minlight
<float> The minimum level of ambient light that hits this brush.
  • Solidity
<choices> Used to control the solidity/collision of these brushes.
Literal Value Description
0 Toggle
1 Never Solid
2 Always Solid
  • solidbsp
<boolean> Set this if this brush is in hierarchy with a moving object of some kind, and the player can stand on this brush.
  • excludednpc
<target_destination> If an NPC classname (i.e. npc_zombie) is specified here, NPCs of that type won't collide with these brushes.
  • invert_exclusion [Episode One Update]
<boolean> If set, then the excluded NPC class will consider this brush solid, and all other NPC classes will consider it non-solid.
[edit]

Flags

  • 2 : Ignore player +USE
[edit]

Inputs

  • Kill
Removes this entity from the world.
Removes this entity and all its children from the world.
  • AddOutput <string>
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>
Causes this entity's OnUser1-4 outputs to be fired. See User Inputs and Outputs.
Set the rendercolor.
Set the renderamt.
Changes the entity's parent in the movement hierarchy.
Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the Parent's Origin and Angles at the time it is attached.
Removes this entity from its current movement hierarchy.
  • DisableShadow
Turn shadow off.
  • EnableShadow
Turn shadow on.
  • Enable
Enable this entity.
  • Disable
Disable this entity.
  • SetExcluded <target_destination> [Episode Two Update]
Set excludednpc
  • SetInvert <integer> [Episode Two Update]
Set invert_exclusion
[edit]

Outputs

Fired in response to FireUser1-4 inputs. See User Inputs and Outputs.
!activator = activator
Retrieved from "http://developer.valvesoftware.com/wiki/Func_brush"