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, except for [[%compileteam|%CompileTeam]].

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

{{ModernExample|{{pre|
LightmappedGeneric
{
 $basetexture developer/custom_clip
  '''%compileclip 1'''
}
}}}}
{{note|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.}}
{{note|These flags are associated with contents and surface flags which are stored in the BSP can can be stored in the VMF; see [[BSP flags (Source)]] for more information.}}
{{todo|DeathByNuke's [[VBSP]] has {{cmd|%CompileChopLow}}, {{cmd|%CompileChopHigh}}, and {{cmd|%CompileChopAll}}, which affect how brush faces are spilt when touching other brush faces; document these.}}

== 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"
! VMT flag
! [[BSP flags]] assigned
! Seen in VMT(s)
! Availability
! Description
|- id="%CompileClip"
| [[%CompileClip]]
| CONTENTS_PLAYERCLIP<br>CONTENTS_MONSTERCLIP<br>SURF_NODRAW<br>SURF_NOLIGHT<br><span style="color:#f66">removes&nbsp;SURF_BUMPLIGHT</span>
| 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]]
| CONTENTS_MONSTERCLIP<br>SURF_NODRAW<br>SURF_NOLIGHT<br><span style="color:#f66">removes&nbsp;SURF_BUMPLIGHT</span>
| toolsnpcclip 
| 
| Makes the brush block only [[NPC]]s. This implies <tt>NoLight</tt> and </tt>NoDraw</tt>.<br>{{note|{{csgo}} Blocks [[bot]]s, even though they are [[player]]s.}}
|- id="%PlayerClip"
| [[%PlayerClip]]
| CONTENTS_PLAYERCLIP<br>SURF_NODRAW<br>SURF_NOLIGHT<br><span style="color:#f66">removes&nbsp;SURF_BUMPLIGHT</span>
| toolsplayerclip 
| 
| Makes the brush only block [[player]]s.
|- id="%compileplayercontrolclip"
| [[%CompilePlayerControlClip]]
| CONTENTS_DETAIL<br>CONTENTS_MIST<br>SURF_NODRAW<br>SURF_NOLIGHT<br><span style="color:#f66">removes&nbsp;SURF_BUMPLIGHT</span>
| toolscontrolclip 
| {{src07|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]]
| CONTENTS_DETAIL<br>CONTENTS_GRENADECLIP<br>SURF_NODRAW<br>SURF_NOLIGHT<br><span style="color:#f66">removes&nbsp;SURF_BUMPLIGHT</span>
| toolsgrenadeclip
| {{csgo|since}}
| Makes the brush only block grenades. 
|- id="%CompileDroneClip"
| [[%CompileDroneClip]]
| {{confirm}}
| toolsdroneclip
| {{since|{{csgo mode|dangerzone}}}}
| Makes the brush only block drones. 
|}

====Other====
{| class="standard-table"
! VMT flag
! [[BSP flags]] assigned
! Seen in VMT(s)
! Availability
! Description
|- id="%Compile2DSky"
| [[%Compile2DSky]]
| SURF_SKY<br>SURF_SKY2D<br>SURF_NOLIGHT<br><span style="color:#f66">removes&nbsp;SURF_BUMPLIGHT</span>
| toolsskybox2d 
| 
| Makes the face render the 2D [[Skybox]] only, in addition to emitting <tt>light_environment</tt> light.
|- id="%CompileFog"
| [[%CompileFog]]
| none
| ToolsFog
| 
| This may be a deprecated flag that so far has not been seen as being useful.
|- id="%CompileHint"
| [[%CompileHint]]
| SURF_NODRAW<br>SURF_NOLIGHT<br>SURF_HINT<br><span style="color:#f66">removes&nbsp;SURF_BUMPLIGHT</span>
| toolshint 
| 
| Makes the face hint-cut [[visleaf]]s. This implies <tt>NoLight</tt> and <tt>NoDraw</tt>.
|- id="%CompileNoChop"]]
| [[%CompileNoChop]]
| SURF_NOCHOP
| 
| 
| Prevents subdividing patches on the surface for lightmapping ("[[chop]]ping"). Also affects how the face is converted to triangles. A brush face using a material with this parameter will be limited to 31x31 luxels.
|- id="%CompileNoLight"
| [[%CompileNoLight]]
| SURF_NOLIGHT<br><span style="color:#f66">removes&nbsp;SURF_BUMPLIGHT</span>
| 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?}}
{{important|No effect in {{hammer++|4}} lighting preview.}}
|- id="%CompileNoShadows" 
| [[%CompileNoShadows]]
| SURF_NOSHADOWS
|
|{{only|{{slamminsrc}}}}
{{also|{{mapbase}}}}
| Prevents dynamic [[shadows]] from being cast onto the surface.
|- id="%CompileOrigin"
| [[%CompileOrigin]]
| CONTENTS_ORIGIN<br>CONTENTS_DETAIL<br>SURF_NODRAW<br>SURF_NOLIGHT<br><span style="color:#f66">removes&nbsp;SURF_BUMPLIGHT</span>
| toolsorigin  
| 
| {{deprecated}} Sets the origin of a brush entity ({{code|origin}} KV), for purposes such as rotation.<br>Leftover from {{mono|[[Tool textures (GoldSrc)|ORIGIN]]}} in {{gldsrc}}. Still functional, but is no longer necessary, as the {{code|origin}} KV is acknowledged by [[VBSP]] and can be visualized directly in {{hammer4|2}}.
|- id="%CompileSkip"
| [[%CompileSkip]]
| SURF_NODRAW<br>SURF_NOLIGHT<br>SURF_SKIP<br><span style="color:#f66">removes&nbsp;SURF_BUMPLIGHT</span>
| toolsskip 
| 
| Removes the face during compilation, making the brush into sets of planes.
|- id="%CompileSky"
| [[%CompileSky]]
| SURF_SKY<br>SURF_NOLIGHT<br><span style="color:#f66">removes&nbsp;SURF_BUMPLIGHT</span>
| toolsskybox 
| 
| Makes the face render the (2D/3D) [[Skybox]] and emit {{ent|light_environment}} light.
|- id="%CompileTrigger"
| [[%CompileTrigger]]
| SURF_NOLIGHT<br>SURF_TRIGGER<br><span style="color:#f66">removes&nbsp;SURF_BUMPLIGHT</span>
| toolstrigger 
| 
| Makes the brush suitable for [[Trigger]]s. Implies {{code|%CompileNoLight}}. If {{code|-nodrawtriggers}} is used, also assigns SURF_NODRAW.
|}

== Additive Flags ==
Multiple of the following flags may be applied to any given material, unless it has one of the exclusive flags above.<br>
Every flag is available in all Source Engine branches, unless specifically mentioned in the <code>Availability</code> box
{| class="standard-table"
! VMT flag
! [[BSP flags]] assigned
! Seen in VMT(s)
! Availability
! Description
|- id="%CompileBlockLOS"
| [[%CompileBlockLOS]]
| CONTENTS_BLOCKLOS
| toolsblocklos 
| 
| Makes the brush block only the [[line of sight]] for [[NPC]]s.<br>{{note|Also works for [[bot]]s in {{csgo}}.}}
|- id="%CompileDetail" 
| [[%CompileDetail]]
| CONTENTS_DETAIL
| 
| 
| Forces the brush to no longer cut [[visleaf]]s, similar to {{ent|func_detail}}. 
|- id="%CompileInvisible"
| [[%CompileInvisible]]
| CONTENTS_GRATE<br>SURF_NODRAW<br>SURF_NOLIGHT<br><span style="color:#f66">removes&nbsp;CONTENTS_SOLID</span><br><span style="color:#f66">removes&nbsp;SURF_BUMPLIGHT</span>
| toolsinvisible 
| 
| Shortcut for {{cmd|%CompileNoDraw}} + {{cmd|%CompilePassBullets}}. 
|- id="%CompileKeepLight" 
| [[%CompileKeepLight]]
| none
| 
| 
| Tells the compiler to not set SURF_NOLIGHT when using {{code|-xbox}} VBSP parameter if {{code|%CompileWater}} is used, unless the shader is set to [[Water (shader)|Water]](if before {{l4d2}}) or [[UnlitGeneric]].
|- id="%CompileLadder"
| [[%CompileLadder]]
| CONTENTS_LADDER
| toolsladder 
| 
| Makes the brush usable as a ladder, without needing to be tied to {{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]]
| SURF_NODRAW<br>SURF_NOLIGHT<br><span style="color:#f66">removes&nbsp;SURF_BUMPLIGHT</span>
| toolsnodraw 
| 
| Makes a brush behave like <code>tools/toolsnodraw</code>.
|- id="%CompileNonSolid"
| [[%CompileNonSolid]]
| CONTENTS_OPAQUE{{why}}
| 
| 
| Makes the brush not solid to anything. ''All'' faces of the brush must have %CompileNonSolid for the brush to be nonsolid.<br>{{bug|{{l4d2}} The material will be invisible if used on a brush with solid contents.}}
|- id="%CompilePassBullets" 
| [[%CompilePassBullets]]
| CONTENTS_GRATE<br><span style="color:#f66">removes&nbsp;CONTENTS_SOLID</span>
| 
| 
| Makes the brush behave like a grating, allowing bullets to pass through but blocking other objects. Useful for foliage or metal grates.<br>{{bug|Allows explosions through, but not bullets in {{tf2}}.}}
{{bug|Non-functional in {{csgo|2}} and {{css|2}}.}}
|- id="%CompileTeam"
| [[%CompileTeam]]
| CONTENTS_TEAM1<br>''or''<br>CONTENTS_TEAM2
| climb_versus
| {{l4ds|since}}
| Decides which team should be affected by this tool texture. Unlike other compile parameters, this isn't a Boolean, but instead is an integer which is either 1 or 2.
|- id="%CompileWater" 
| [[%CompileWater]]
| CONTENTS_WATER<br>SURF_WARP<br>SURF_NOSHADOWS<br>SURF_NODECALS<br><span style="color:#f66">removes&nbsp;CONTENTS_SOLID<br>removes&nbsp;CONTENTS_DETAIL</span>
| 
| 
| Marks the brush as a [[Water (shader)|water]]-type material. Makes it non-solid, allows swimming inside, etc.
|- id="%CompileWet"
| [[%CompileWet]]
| SURF_WET
|
| {{src07|removed}}
| {{modernDeprecated|Sets unused legacy {{quake2|2}} flag (eventually replaced with SURF_NOPORTAL; deprecated in favor of [[surface properties]].}}
|- id="%CompileSlime"
| [[%CompileSlime]]
| CONTENTS_SLIME<br>SURF_NODECALS<br><span style="color:#f66">removes&nbsp;CONTENTS_SOLID<br>removes&nbsp;CONTENTS_DETAIL</span>
| 
| 
| same as %CompileWater, but with green splash particles. <br>{{bug|{{l4d2}} <tt>%CompileSlime</tt> uses default water splash particles.}}
|- id="%HotSurface"
| [[%HotSurface]]
| SURF_NOPORTAL
| 
| {{csgo|since}}{{confirm}}
| 
|- id="%NoPortal"
| [[%NoPortal]]
| SURF_NOPORTAL
| toolsblack_noportal
| {{src07|since}}
| {{portalseries}} Makes the texture non-portalable unless [[Gel (Portal 2)|Conversion Gel]] is used.
|- id="%NoPaint"
| [[%NoPaint]]
| SURF_NODECAL<br>(aliased&nbsp;to&nbsp;SURF_NOPAINT)
| 
| {{portal2|since}}
| Makes the material unable to be painted by [[Gel (Portal 2)|Gel]]. Implies {{cmd|$nodecal}}.
|- id="%CompileStairs"
| [[%CompileStairs]]
| {{confirm}}
| toolsstairs 
| {{infra|only}}
| Makes brushwork traversable up to an angle of 63.4349488, as opposed to the usual 45°.
|- 
|}
[[Category:Shader parameters]]