View source for Material map compile flags

{{lang|{{PAGENAME}}}}
Several special [[:Category:List of Shader Parameters|shader parameters]] exist that start with a <code>%</code> sign instead of <tt>$</tt>. These are read by the compile tools to alter the properties of the face or the brush they are attached to. Most are intended to produce the special <code>tools/</code> textures, but they may also be used for other materials.<br>
All flags are boolean properties and invisible to players. So far [[%compileladder|%CompileLadder]] is the only flag which may be visible to players, depending on the [[material proxies|proxies]] inside the material. [[%compileteam|%CompileTeam]] Is also the only flag that is not a boolean.

See also [[Tool textures|Tool Textures]] for more detail about the propeties of individual materials.

{{ModernExample|{{pre|
LightmappedGeneric
{
 $basetexture developer/custom_clip
  '''%compileclip 1'''
}
}}}}
{{ModernNote|As with shader parameters, the names of compile flags are '''not''' case sensitive: <tt>%compileclip 1</tt> and <tt>%CompileClip 1</tt> deliver the same result.}}
{{todo|These can also be applied directly into a [[VMF]]'s brush face, using {{code|"contents" "####"}} for contents flagsand {{code|"flags" "####"}} for surface flags, being the descendants of the [[WAL#Texture flags|WAL texture flags]] in {{quake2|2}}. Regular {{hammer4|2}} removes these when saving, but {{hammer++|2}} probably keeps them. Document these flags; see [https://github.com/ValveSoftware/source-sdk-2013/blob/master/mp/src/public/bspflags.h#L24-L97 {{mono|public/bspflags.h}}].}}

== Exclusive Flags ==
'''Only one''' of the following flags may be set on any given material.<br>
Every flag is available in all Source Engine branches, unless specifically mentioned in the <code>Availability</code> box<br>
====Clips====
{| class="standard-table"
! width="150px" | Name
! width="100px" | Seen in .vmt
! width="150px" | Availability
! Effect
|- id="%CompileClip"
| [[%CompileClip]]
| toolsclip 
| 
| Makes the brush block only [[player]]s and [[NPC]]s. This is equivalent to a combination of <tt>%PlayerClip</tt> and <tt>%CompileNPCClip</tt>.
|- id="%CompileNPCClip"
| [[%CompileNPCClip]]
| toolsnpcclip 
| 
| Makes the brush block only [[NPC]]s. This implies <tt>NoLight</tt> and </tt>NoDraw</tt>.<br>{{ModernNote|{{csgo}} Blocks [[bot]]s, even though they are [[player]]s.}}
|- id="%PlayerClip"
| [[%PlayerClip]]
| toolsplayerclip 
| 
| Makes the brush only block [[player]]s.
|- id="%compileplayercontrolclip"
| [[%CompilePlayerControlClip]]
| toolscontrolclip 
| {{hl2ep2|removed}}{{Gmod|also}}
| Unsure as to how this was meant to be used. Usually seen together with {{ent|func_vehicleclip}}.<br>Material also uses <code>[[$surfaceprop]] player_control_clip<code>.
|- id="%CompileGrenadeClip"
| [[%CompileGrenadeClip]]
| toolsgrenadeclip
| {{csgo|only}}
| Makes the brush only block grenades. 
|- id="%CompileDroneClip"
| [[%CompileDroneClip]]
| toolsdroneclip
| {{csgo|only}}
| Makes the brush only block drones. 
|}

====Other====
{| class="standard-table"
! width="150px" | Name
! width="100px" | Seen in .vmt
! width="150px" | Availability
! Effect
|- id="%Compile2DSky"
| [[%Compile2DSky]]
| toolsskybox2d 
| 
| Makes the face render the 2D [[Skybox]] only, in addition to emitting <tt>light_environment</tt> light.
|- id="%CompileFog"
| [[%CompileFog]]
| ToolsFog
| 
| This may be a deprecated flag that so far has not been seen as being useful.
|- id="%CompileNoChop"]]
| [[%CompileNoChop]]
| 
| 
| Prevents subdividing patches on the surface. Also affects how the face is converted to triangles. 
|- id="%CompileNoLight"
| [[%CompileNoLight]]
| nolight 
| {{as|since}}{{src13|also}}
| Disables generating lightmaps for a brush face. Useful for materials that don't need lighting info or are always invisible. This is disabled on water materials.
{{modernConfirm|Is this necessary for [[UnlitGeneric]] materials?}}
|- id="%CompileOrigin"
| [[%CompileOrigin]]
| toolsorigin  
| 
| {{modernDeprecated|Sets the rotation origin of a brush entity.<br>Leftover from {{mono|[[Tool textures (GoldSrc)|ORIGIN]]}} in {{GoldSrc}}. Still functional in some branches (such as {{src13sp}}), but is no longer necessary.}}
|- id="%CompileSkip"
| [[%CompileSkip]]
| toolsskip 
| 
| Removes the face during compilation, making the brush into sets of planes.
|- id="%CompileSky"
| [[%CompileSky]]
| toolsskybox 
| 
| Makes the face render the (2D/3D) [[Skybox]] and emit {{ent|light_environment}} light.
|- id="%CompileTrigger"
| [[%CompileTrigger]]
| toolstrigger 
| 
| Makes the brush suitable for [[Trigger]]s.
|}

== Additive Flags ==
Multiple of the following flags may be applied to any given material.<br>
Every flag is available in all Source Engine branches, unless specifically mentioned in the <code>Availability</code> box
{| class="standard-table"
! width="150px" | Name
! width="100px" | Seen in .vmt
! width="150px" | Availability
! Effect
|- id="%CompileBlockLOS"
| [[%CompileBlockLOS]]
| toolsblocklos 
| 
| Makes the brush block only the [[line of sight]] for [[NPC]]s.<br>{{ModernNote|Also works for [[bot]]s in {{csgo}}.}}
|- id="%CompileDetail" 
| [[%CompileDetail]]
| 
| 
| Forces the brush to no longer cut [[visleaf]]s, similar to {{ent|func_detail}}. 
|- id="%CompileHint"
| [[%CompileHint]]
| toolshint 
| 
| Makes the face hint-cut [[visleaf]]s. This implies <tt>NoLight</tt> and <tt>NoDraw</tt>.
|- id="%CompileInvisible"
| [[%CompileInvisible]]
| toolsinvisible 
| 
| Makes a surface behave like <tt>NoDraw</tt>, but still allows bullets to pass through it, except in {{csgo|2}}. This also implies <tt>NoLight</tt>.
|- id="%CompileLadder"
| [[%compileladder|%CompileLadder]]
| toolsladder 
| 
| Makes the brush usable as a {{ent|func_ladder}}.<br>Can be applied to any material, such as <code>metal/metalladder.vmt</code> for a cheap ladder without a prop. Else also add %compilenodraw to make it invisible.
|- id="%CompileNoDraw"
| [[%CompileNoDraw]]
| toolsnodraw 
| 
| Makes a brush behave like <code>tools/toolsnodraw</code>.
|- id="%CompileNonSolid"
| [[%CompileNonSolid]]
| 
| 
| Makes the brush not solid to anything. <br>{{ModernBug|{{l4d2}} Turns brushes non-solid '''and invisible''' but still casts shadows.}}{{tip|Equivalent to {{code|[[Tool textures (GoldSrc)|NOCLIP]]}} tool texture in {{Goldsrc|4}} ([[ZHLT]], [[VHLT]], and derivatives)}}
|- id="%CompileNoShadows" 
| [[%CompileNoShadows]]
|
|{{only|{{slamminsrc}}}}{{also|{{mapbase}}}}
| Prevents [[shadows]] from being cast onto the texture.
{{ModernBug|Non-functional in {{tf2}}.}}
|- id="%CompilePassBullets" 
| [[%CompilePassBullets]]
| 
| 
| Makes the brush behave like a grating, allowing bullets to pass through but blocking other objects. Useful for foliage or metal grates.<br>{{ModernNote|Allows explosions through, but not bullets in {{tf2}}.}}
{{ModernBug|Non-functional in {{csgo|2}} and {{css|2}}.}}
|- id="%CompileTeam"
| [[%25compileteam|%CompileTeam]]
| climb_versus
| {{l4ds|only}}
| Decides which team should be affected by this tool texture.
|- id="%CompileWater" 
| [[%CompileWater]]
| 
| 
| Marks the brush as a [[Water (shader)|water]]-type material. Makes it non-solid, allows swimming inside, etc. If <code>%CompileKeepLight</code> is also set, the brush will retain its lighting data.
|- id="%CompileSlime"
| [[%CompileSlime]]
| 
| 
| same as %CompileWater, but with green splash particles. <br>{{ModernBug|{{l4d2}} <tt>%CompileSlime</tt> uses default water splash particles.}}
|- id="%NoPortal"
| [[%NoPortal]]
| toolsblack_noportal
| {{Portalseries|only}}
| Makes the texture non-portalable unless [[Gel (Portal 2)|Conversion Gel]] is used.
|- id="%NoPaint"
| [[%NoPaint]]
| 
| {{portal2|only}}
| Makes the material unable to be painted by [[Gel (Portal 2)|Gel]]. 
|- id="%CompileStairs"
| [[%CompileStairs]]
| toolsstairs 
| {{infra|only}}
| Makes brushwork traversable up to an angle of 63.4349488, as opposed to the usual 45°.
|}
[[Category:Shader parameters]]