Func brush: Difference between revisions
Jump to navigation
Jump to search
Note:The brush can be partly entered about 0.5 units. Other brush entities don't seem to behave this way (observed in 
by placing 2 brushes flush next to each other, making one func_brush and then when walking along them you'll get stopped at the point they meet which won't happen if for example func_wall_toggle is used)
Setting
Note:For Keyvalues and Inputs affecting brush rendering, see Brush entity/Rendering related keyvalues and inputs
m (grammar) |
SirYodaJedi (talk | contribs) No edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{LanguageBar}} | {{LanguageBar}} | ||
{{tabsBar|main=s2|base=func_brush}} | |||
{{CD|CFuncBrush|file1=modelentities.cpp}} | {{CD|CFuncBrush|file1=modelentities.cpp}} | ||
{{toc-right}} | {{toc-right}} | ||
{{preserved entity}} | |||
{{this is a|brush entity|name=func_brush}} It's a generic brush entity with various features. | {{this is a|brush entity|name=func_brush}} It's a generic brush entity with various features. | ||
It combines the functions of {{ent|func_wall}}, {{ent|func_illusionary}}, and {{ent|func_wall_toggle}} from {{quake|2}} and {{goldsrc|2}}. The older entities can still be used, for an insignificant amount of memory saved. | It combines the functions of {{ent|func_wall}}, {{ent|func_illusionary}}, and {{ent|func_wall_toggle}} from {{quake|2}} and {{goldsrc|2}}. The older entities can still be used, for an insignificant amount of memory saved. | ||
{{note|The brush can be partly entered about 0.5 units. Other brush entities don't seem to behave this way (observed in {{l4d2}} by placing 2 brushes flush next to each other, making one func_brush and then when walking along them you'll get stopped at the point they meet which won't happen if for example func_wall_toggle is used)<br/> | {{note|The brush can be partly entered about 0.5 units. Other brush entities don't seem to behave this way (observed in {{l4d2}} by placing 2 brushes flush next to each other, making one func_brush and then when walking along them you'll get stopped at the point they meet which won't happen if for example func_wall_toggle is used)<br/> | ||
| Line 12: | Line 12: | ||
==Keyvalues== | ==Keyvalues== | ||
{{Brush rendering note}} | {{Brush rendering note}} | ||
{{KV Targetname}} | {{KV Targetname}} | ||
{{KV|Solidity|intn=Solidity|choices|Used to control the solidity/collision of these brushes. | {{KV|Solidity|intn=Solidity|integer choices|Used to control the solidity/collision of these brushes. | ||
:*0: Toggle - The solidity can be toggled together with its visibility. | :*0: Toggle - The solidity can be toggled together with its visibility. | ||
:*1: Never Solid | :*1: Never Solid | ||
| Line 32: | Line 31: | ||
==Inputs== | ==Inputs== | ||
{{I|SetExcluded|Change the NPC class that does not collide with the brush.}} | {{I|SetExcluded|param=string|Change the NPC class that does not collide with the brush.}} | ||
{{I|SetInvert|Whether to reverse the NPC class exclusion rule.}} | {{I|SetInvert|param=bool|Whether to reverse the NPC class exclusion rule.}} | ||
{{I|Enable|Make the brush visible and if <code>solidity</code> is '''not''' set to <code>Never Solid</code> make it '''solid'''}} | {{I|Enable|Make the brush visible and if <code>solidity</code> is '''not''' set to <code>Never Solid</code> make it '''solid'''}} | ||
{{I|Disable|Make the brush invisible and if <code>solidity</code> is '''not''' set to <code>Always Solid</code> make it '''non-solid''' | {{I|Disable|Make the brush invisible and if <code>solidity</code> is '''not''' set to <code>Always Solid</code> make it '''non-solid''' | ||
Latest revision as of 07:46, 4 May 2025
 Class hierarchy
|
|---|
| CFuncBrush |
| modelentities.cpp
|
This is a preserved entity in 
If the game has round restart mechanics this entity may not behave as expected.
If the game has round restart mechanics this entity may not behave as expected.
func_brush is a brush entity 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 
Quake and 
GoldSrc. The older entities can still be used, for an insignificant amount of memory saved.
Note:The brush can be partly entered about 0.5 units. Other brush entities don't seem to behave this way (observed in by placing 2 brushes flush next to each other, making one func_brush and then when walking along them you'll get stopped at the point they meet which won't happen if for example func_wall_toggle is used)Setting
solidbsp keyvalue to 1 seems to fix the issue.Keyvalues
Note:For Keyvalues and Inputs affecting brush rendering, see Brush entity/Rendering related keyvalues and inputs- Name (targetname) <string>[ Edit ]
- The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g.
parentnameortarget).
Also displayed in Hammer's 2D views and Entity Report.See also: Generic Keyvalues, Inputs and Outputs available to all entities
- Solidity (Solidity) <integer 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
Bug:npc_combine_s can walk through no matter what type of solidity is set by using scripted_sequence [todo tested in ?]
- Solid BSP (solidbsp) <boolean>
- Set this to BSP if the player seems to rotate oddly relative to the surface.
- 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.
- Note:Not usable with anything in
- 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.
- StartDisabled (StartDisabled) <boolean>
- If true brush will start invisible, and if
solidityis not set toAlways Solidit will also be non-solid 
Tip:If Solidity is Toggle, disabling will also make the entity non-solid.
Flags
- Ignore player +USE : [2]
- Entity will ignore all Use inputs, including ones from the player.
Inputs
- SetExcluded <string>
- Change the NPC class that does not collide with the brush.
- SetInvert <boolean>
- Whether to reverse the NPC class exclusion rule.
- Enable
- Make the brush visible and if
solidityis not set toNever Solidmake it solid
- Disable
- Make the brush invisible and if
solidityis not set toAlways Solidmake it non-solid 
Warning:The invisiblity is achieved by applying EF_NODRAW which makes the entity ignored on client therefore if solidity was Always Solid moving against the brush collision will feel jittery (tested in: l4d2)
- Toggle !FGD
- Toggles the enabled state of the entity