View source for $lod

{{LanguageBar|title = $lod}}
{{this is a|QC command|name=$lod}}

{{toc-right}}{{src topicon}}  It is also available in {{hlps2|4}}. It is a [[QC command]] describing how to reduce the [[LOD system|level of detail]] when rendering the model at a given size. It handles the removal or replacement of [[expensive]] parts of the model so it can be rendered more efficiently. There can be up to 8 levels.

{{tip|[[Studiomdl]] will transfer weightmapping and flexes from the reference mesh.}}

== Limitations ==
{{warning|New [[material]]s cannot be introduced in an LOD SMD. All mesh using newly introduced materials will not be compiled into the model and simply disappear.
{{ModernFix|Use <code>replacematerial</code> instead.}} }}
{{warning|{{csgo|4}} does not support level of detail. $lod will be ignored, but the model will still work. Try to avoid using this command in {{csgo}}.
{{modernConfirm|Was this broken in an update, or did LODs not work in the 2012 build (available as public beta)?}} }}
{{warning|Edges that end up split or merged in a LOD, while it has not been like that in the original mesh, will cause the edge to disappear in the LOD.<br>In other words, Adding sharp edges to fix a smoothing issue on a LOD will cause that edge to not show up. {{confirm|This does not always appear to be the case.}} }}
{{warning|Each LOD will have its own model, even if it does not use <code>$replacemodel</code>. Those models add to the total polycount. If your model has very high polycount and you add a LOD just to collapse bones, it will double the overall polycount.<br>
Therefore it might be best to either not have any LOD at all, or using a '''highly''' decimated version of the model.}}

== Syntax ==
<source lang=php>
$lod <threshold>
{
	<options>
}

$shadowlod // Used to generate cheap render-to-texture shadows (not shadow maps)
{
	<options>
}
</source>

; <code>threshold</code>
: Defines when the LOD takes effect. Its value is (100 / screen pixels per unit) [http://www.interlopers.net/forum/viewtopic.php?f=25&t=29954], which means that distance at which the transition happens depends on the size of the user's monitor and their [[FOV]], not simply the model's distance from the camera. Someone with a truly massive screen may never see an LOD!
: The threshold formula makes it difficult to determine what values to use, however. The best way of working things out is to load your model into [[HLMV]], switch to the Model tab, enable Auto LOD, and use {{key|RMB}} to zoom in and out.
{{note|Floating point values can be used if wrapped in quotes. i.e. $lod "10.5"}}

=== Options ===
{{note|LOD blocks do not inherit from previous blocks. They always modify the reference mesh.}}

; <code>replacemodel <Reference smd> <LOD smd> [reverse]</code>	
: Replaces the given reference SMD (can by anything from <code>[[$body]]</code>, <code>[[$bodygroup]]</code> or <code>[[$model]]</code>) with an LOD version.<br>
: <code>Reverse</code> is used to correct reversed normals on the LOD, which can be caused by SMD export problems. <!-- See also [[Talk:$body]]-->{{bug|LOD meshes for [[$bodygroup|Bodygroups]] defined outside the <code>.qc</code> file (i.e. via <code>$include file.qci</code>) or inside of [[$pushd]]/[[$popd]] blocks will not be correctly assigned.<br> Contents of <code>.qci</code> files must be merged into the main <code>.qc</code> file to work. Any usage of <code>$pushd</code> or <code>$popd</code> must be replaced with full relative paths, using <code>..\</code> and forward-slashes to work.|only=}}
; <code>removemodel <Reference smd></code>	
: The specified SMD will not be rendered at all at this level of detail.<br>{{bug|Causes compiles to fail with an EXCEPTION_ACCESS_VIOLATION error in [[studiomdl]] builds later than 2006.<br>Instead, use "replacemodel" to swap the specified model for one that is a single tiny triangle hidden inside the mesh. Invisible textures can be used hide it better, should the little triangle ever be seen.{{workaround|See [[$no_draw]].}} |only=}}
; <code>replacematerial <Reference material> <LOD material></code>	
: Replaces all instances of the reference [[material]] with another. Useful for removing expensive processes like [[$bumpmap]] and disabling the [[Eye]] shader. Paths are relative to <code>[[$cdmaterials]]</code>.{{bug|If you use <code>replacemodel</code> to replace the mesh, and then set <code>replacematerial</code>'s 2nd argument to one of the materials found in the LOD mesh, it will cause the entire mesh to be removed.|only=}}
; <code>removemesh <Reference material></code>
: Removes all triangles attached to the named material. Unlike in <code>replacematerial</code>, paths are relative to the root materials folder. {{bug|If a material's VMT is not present in the game's folder, studiomdl sees a material named "__error" instead; the compiler does not detect VMTs from mounted GCFs/games.|only=}}
; <code>nofacial</code>
: Disables [[facial animation]].
; <code>bonetreecollapse <Reference bone></code>
: Causes children of the specified bone to be removed. Their attached vertices return to the reference position. This is commonly used on fingers. Remember that it only applies to clients!{{note|This don't affect the bones with their parents that have an [[$attachment|attachment]].<br>This means that if you collapse bonetree from ValveBiped.Bip01_R_UpperArm but ValveBiped.Bip01_R_Hand has an attachment, such bones as ValveBiped.Bip01_R_Hand and ValveBiped.Bip01_R_Forearm will not be deleted.}}
;<code>replacebone <Reference bone> <LOD bone></code>
:The precursor of <code>bonetreecollapse</code>. Replacing bones is much more complex, but allows all kinds of unusual bone optimisations that a simple collapse wouldn't achieve.<!-- go on ... give us another clue!-->
; <code>use_shadowlod_materials</code>
: {{todo|Describe (Perhaps $shadowlod models without this use a simple opaque textureless material?); sets {{code|STUDIOHDR_FLAGS_USE_SHADOWLOD_MATERIALS}} flag, which is explained like so in {{file|public/studio.h}}: {{quote|This flag is set when we should use the actual materials on the shadow LOD instead of overriding them with the default one (necessary for translucent shadows)}} }}

== Example ==

<source lang=php>
$lod 12
{
	replacemodel "Police_reference" "lod1_Police_reference"
	replacemodel "Manhack_reference" "lod1_Manhack_reference"
}

$lod 18
{
	replacemodel "Police_reference" "lod2_Police_reference"
	replacemodel "Manhack_reference" "lod2_Manhack_reference"
	bonetreecollapse "ValveBiped.Bip01_R_Hand"
	bonetreecollapse "ValveBiped.Bip01_L_Hand"
}

$lod 42
{
	replacemodel "Police_reference" "lod3_Police_reference"
	replacemodel "Manhack_reference" "lod3_Manhack_reference"
	bonetreecollapse "ValveBiped.Bip01_R_Hand"
	bonetreecollapse "ValveBiped.Bip01_L_Hand"
}
</source>

== See also ==
* [[LOD Models]]
* [[LOD system|LOD system]]

[[Category:QC Commands|lod]]