Template:KV BaseAnimating
... 
Template Documentation
…
This template uses a Testcases subpage
You can test how this page looks with it's different skins and parsers.
You can test how this page looks with it's different skins and parsers.
Todo: Consolidate overlap with {{KV Studiomodel}}.
Info holder of all relevant keyvalues inherited from theCBaseAnimating C++ class. The template has a very specific syntax that you must follow to apply properly, because new games have added new features throughout the years. See Help:Templates for more info on named parameters.
SomeCBaseAnimatingkeyvalues are not exclusive to this class, but rather is only of relevance only on theCBaseAnimatingclass. See the Uncovered Keyvalues page to know more.
Note:After you edit this template, please make sure you also edit the targeted entity's page. Per-game keyvalues may be duplicated, for technical reasons. See also FGD Template Prototype.Contents
Usage
These must be used in a specific syntax! ALL parameters must be given a value of 1, such as|portal2=1. Only one game parameter can be used at once.
{{KV BaseAnimating|portal2=1}}
Parameters
If you leave the parameter field empty (using no arguments), the template will automatically fallback to displaying keyvalues from the current default game.
All parameters for this template:
base- No game-specific information is displayed (other than DXLevelChoice), and base engine features only. (The
/ 
iteration engine)l4d- Set template KVs specific to
. ('SystemLevelChoice')l4d2- Set template KVs specific to
. ('SystemLevelChoice' + Glow backface)as- Display keys present since
. ('SystemLevelChoice' + MoveType and CollisionGroup)portal2- [CURRENT DEFAULT] Display keys present since
. ('SystemLevelChoice' + MoveType and CollisionGroup + SuppressAnimSounds and various projected texture settings)
Note:If nothing is set, the template will show things unique to pre-P2 versions of the engine.Refer to the Examples section for samples.
Examples
Show Info Specific to a Game
This makes information relevant only to be displayed.
{{KV BaseAnimating|l4d=1}}
will:
BaseAnimating:
BaseAnimating:
- Skin
(skin or ModelSkin<integer>) - Some models have multiple skins. This value selects from the index, starting with 0.
- Collisions
(solid)<choices> - Method of collision for this entity.
- Body Group
(body or SetBodyGroup)<integer> !FGD - Sets the the active
$bodygroup.
- Model Index
(modelindex)<short> !FGD - Given the number index from dumping the
cl_precacheinfo modelprecachetable, sets entity model to the index.
Warning:If an entity has animations that will be played, then the set model also must have its own sequences, else the game crashes.
Animating
- Sequence
(sequence)<integer> !FGD - Default animation sequence for the model to be playing after spawning.
- Playback Rate
(playbackrate)<float> !FGD - A multiplier of the framerate at which animations are played, negative values are accepted. Default is 1.0.
- Texture Frame
(texframeindex)<integer> !FGD - The initial frame number for all animated textures on this entity.
Effects - Render
- Start Fade Distance
(fademindist)<float> - Distance at which the entity starts fading. If 0 or less, the entity will disappear instantly when end fade is hit. The value will scale appropriately if the entity is in a 3D Skybox.
- End Fade Distance
(fademaxdist)<float> - Distance at which the entity ends fading. If 0 or less, the entity won't disappear at all. The value will scale appropriately if the entity is in a 3D Skybox.
- Fade Scale
(fadescale)<float> - If specified in the
worldspawn, or if the engine is running below DirectX 8, entities will fade out even if the fade distances above aren't specified. This value gives more control over when this happens: numbers smaller than 1 cause the entity to fade out at further distances, and greater than 1 cause it to fade out at closer distances. Using 0 turns off the forced fade altogether. See also$noforcedfade.
- FX Amount/Transparency (0–255)
(renderamt)<integer> - Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.
- Render Color (R G B)
(rendercolor)<color255> - Color tint.
- Render FX
(renderfx)<choices> - Various somewhat legacy alpha effects.
 Bug:Alpha effects from 0 to 10 are unavailable due to the bug in code in  Counter-Strike: Global Offensive
|
Confirm:- Render Mode
(rendermode)<choices> - Set a non-standard rendering mode on this entity.
|
Effects - Environment
- Disable Shadows
(disableshadows)<boolean> - Prevent the entity from creating cheap render-to-texture shadows. Does not affect shadow mapping.
- Disable Receiving Shadows
(disablereceiveshadows)<boolean> - Prevent the entity from receiving shadows on itself.
- Shadow Cast Distance
(shadowcastdist)<integer> - Sets how far the entity casts dynamic shadows. 0 means default distance from the
shadow_controlentity.
- Lighting Origin
(LightingOrigin)<targetname> - Select an entity (not
info_lighting!) from which to sample lighting instead of the entity's origin.
MiscellaneousSystemLevelChoice:
- Minimum / Maximum Effect Details Level
(mincpulevel / maxcpulevel)<choices> (in all games since) - Don't render for players with Effect Details levels that exceed the minimum or maximum.[Key names are related to
cpu_levelcvar used by Effect Details.]
|
- Minimum / Maximum Shader Details Level
(mingpulevel / maxgpulevel)<choices> (in all games since) - Don't render for players with Shader Details levels that exceed the minimum or maximum.[Key names are related to
gpu_levelcvar used by Shader Details.]
|
Show Info Specific to Base Engine
Information relevant only to base engine are displayed. ( / )
{{KV BaseAnimating|base=1}}
will:
BaseAnimating:
BaseAnimating:
- Skin
(skin or ModelSkin<integer>) - Some models have multiple skins. This value selects from the index, starting with 0.
- Collisions
(solid)<choices> - Method of collision for this entity.
- Body Group
(body or SetBodyGroup)<integer> !FGD - Sets the the active
$bodygroup.
- Model Index
(modelindex)<short> !FGD - Given the number index from dumping the
cl_precacheinfo modelprecachetable, sets entity model to the index.Warning:If an entity has animations that will be played, then the set model also must have its own sequences, else the game crashes. - Model Scale
(modelscale)<float> (in all games since
) - A multiplier for the size of the model. Negative values are accepted. Does not alter the physics collisions in most cases, however.Warning:Negative or extremely high values can cause crashes!Note:Scale may not appear in
Hammer 4.x, but will appear in-game (tested in 
). This is fixed in 
Hammer++.
DXLevelChoice:
- Minimum / Maximum DX Level
(mindxlevel / maxdxlevel)<choices> (removed since) - The entity will not exist if the engine is running outside the given range of DirectX Versions.
Warning:If these are used, the object may break when the user switches their DirectX settings.
|
Animating
- Sequence
(sequence)<integer> !FGD - Default animation sequence for the model to be playing after spawning.
- Playback Rate
(playbackrate)<float> !FGD - A multiplier of the framerate at which animations are played, negative values are accepted. Default is 1.0.
- Texture Frame
(texframeindex)<integer> !FGD - The initial frame number for all animated textures on this entity.
Effects - Render
- Start Fade Distance
(fademindist)<float> - Distance at which the entity starts fading. If 0 or less, the entity will disappear instantly when end fade is hit. The value will scale appropriately if the entity is in a 3D Skybox.
- End Fade Distance
(fademaxdist)<float> - Distance at which the entity ends fading. If 0 or less, the entity won't disappear at all. The value will scale appropriately if the entity is in a 3D Skybox.
- Fade Scale
(fadescale)<float> - If specified in the
worldspawn, or if the engine is running below DirectX 8, entities will fade out even if the fade distances above aren't specified. This value gives more control over when this happens: numbers smaller than 1 cause the entity to fade out at further distances, and greater than 1 cause it to fade out at closer distances. Using 0 turns off the forced fade altogether. See also$noforcedfade.
- FX Amount/Transparency (0–255)
(renderamt)<integer> - Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.
- Render Color (R G B)
(rendercolor)<color255> - Color tint.
- Render FX
(renderfx)<choices> - Various somewhat legacy alpha effects.
Bug:Alpha effects from 0 to 10 are unavailable due to the bug in code in Counter-Strike: Global Offensive
|
- Render Mode
(rendermode)<choices> - Set a non-standard rendering mode on this entity.
|
Effects - Environment
- Disable Shadows
(disableshadows)<boolean> - Prevent the entity from creating cheap render-to-texture shadows. Does not affect shadow mapping.
- Disable Receiving Shadows
(disablereceiveshadows)<boolean> - Prevent the entity from receiving shadows on itself.
- Shadow Cast Distance
(shadowcastdist)<integer> - Sets how far the entity casts dynamic shadows. 0 means default distance from the
shadow_controlentity.
- Lighting Origin
(LightingOrigin)<targetname> - Select an entity (not
info_lighting!) from which to sample lighting instead of the entity's origin. Lighting Origin Offset(not in(LightingOriginHack)<targetname>
) !FGD 
- Deprecated. The
info_lighting_relativefrom which to sample lighting instead of the entity's origin. Use Lighting Origin instead.
Using Template Defaults
Without using any arguments, the template fallbacks to a default, which is the latest Source game.
{{KV BaseAnimating}}
will:
BaseAnimating:
SystemLevelChoice:
BaseAnimating:
- Skin
(skin or ModelSkin<integer>) - Some models have multiple skins. This value selects from the index, starting with 0.
- Collisions
(solid)<choices> - Method of collision for this entity.
- Body Group
(body or SetBodyGroup)<integer> !FGD - Sets the the active
$bodygroup.
- Model Index
(modelindex)<short> !FGD - Given the number index from dumping the
cl_precacheinfo modelprecachetable, sets entity model to the index.Warning:If an entity has animations that will be played, then the set model also must have its own sequences, else the game crashes. - Model Scale
(modelscale)<float> (in all games since) - A multiplier for the size of the model. Negative values are accepted. Does not alter the physics collisions in most cases, however.Warning:Negative or extremely high values can cause crashes!Note:Scale may not appear in Hammer 4.x, but will appear in-game (tested in ). This is fixed in Hammer++.
Animating
- Sequence
(sequence)<integer> !FGD - Default animation sequence for the model to be playing after spawning.
- Playback Rate
(playbackrate)<float> !FGD - A multiplier of the framerate at which animations are played, negative values are accepted. Default is 1.0.
- Texture Frame
(texframeindex)<integer> !FGD - The initial frame number for all animated textures on this entity.
Effects - Render
- Start Fade Distance
(fademindist)<float> - Distance at which the entity starts fading. If 0 or less, the entity will disappear instantly when end fade is hit. The value will scale appropriately if the entity is in a 3D Skybox.
- End Fade Distance
(fademaxdist)<float> - Distance at which the entity ends fading. If 0 or less, the entity won't disappear at all. The value will scale appropriately if the entity is in a 3D Skybox.
- Fade Scale
(fadescale)<float> - If specified in the
worldspawn, or if the engine is running below DirectX 8, entities will fade out even if the fade distances above aren't specified. This value gives more control over when this happens: numbers smaller than 1 cause the entity to fade out at further distances, and greater than 1 cause it to fade out at closer distances. Using 0 turns off the forced fade altogether. See also$noforcedfade.
- FX Amount/Transparency (0–255)
(renderamt)<integer> - Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.
- Render Color (R G B)
(rendercolor)<color255> - Color tint.
- Render FX
(renderfx)<choices> - Various somewhat legacy alpha effects.
Bug:Alpha effects from 0 to 10 are unavailable due to the bug in code in Counter-Strike: Global Offensive
|
- Render Mode
(rendermode)<choices> - Set a non-standard rendering mode on this entity.
|
Effects - Environment
- Disable Shadows
(disableshadows)<boolean> - Prevent the entity from creating cheap render-to-texture shadows. Does not affect shadow mapping.
- Disable Receiving Shadows
(disablereceiveshadows)<boolean> - Prevent the entity from receiving shadows on itself.
- Shadow Cast Distance
(shadowcastdist)<integer> - Sets how far the entity casts dynamic shadows. 0 means default distance from the
shadow_controlentity.
- Lighting Origin
(LightingOrigin)<targetname> - Select an entity (not
info_lighting!) from which to sample lighting instead of the entity's origin. Lighting Origin Offset(not in(LightingOriginHack)<targetname>) !FGD - Deprecated. The
info_lighting_relativefrom which to sample lighting instead of the entity's origin. Use Lighting Origin instead. - Disable Flashlight
(disableflashlight)<boolean> (in all games since) - Used to disable projected texture lighting and shadows on this entity. Identical to EF_NOFLASHLIGHT.
- Disable ShadowDepth
(disableshadowdepth)<boolean> (in all games since) - Makes this entity not cast a shadow from
env_projectedtextureentities. Identical to EF_NOSHADOWDEPTH.
- Projected Texture Cache
(shadowdepthnocache)<choices> (in all games since) - Used to hint projected texture system whether it is sufficient to cache shadow volume of this entity or to force render it every frame instead. Identical to
EF_SHADOWDEPTH_NOCACHE.- 0: Default
- 1: No cache—render every frame
- 2: Cache it—render only once
Miscellaneous
- Glow Backface Multiple
(glowbackfacemult)<float> (only in) !FGD - If this object has a glow effect, multiply the effect by this much on the sides of the object that are facing away from the viewer.
- Move Type
(MoveType)<choices> (in all games since) !FGD - Sets a movetype for this entity, which changes its movement behavior.
|
- Collision Group
(CollisionGroup)<choices> (in all games since) !FGD - Sets a collision group for this entity, which changes its collision behavior.
|
- No Animation Sounds
(SuppressAnimSounds)<boolean> (in all games since) !FGD - Silences sounds linked to animations.DXLevelChoice:
- Minimum / Maximum DX Level
(mindxlevel / maxdxlevel)<choices> (removed since) - The entity will not exist if the engine is running outside the given range of DirectX Versions.
Warning:If these are used, the object may break when the user switches their DirectX settings.
|
- Minimum / Maximum Effect Details Level
(mincpulevel / maxcpulevel)<choices> (in all games since) - Don't render for players with Effect Details levels that exceed the minimum or maximum.[Key names are related to
cpu_levelcvar used by Effect Details.]
|
- Minimum / Maximum Shader Details Level
(mingpulevel / maxgpulevel)<choices> (in all games since) - Don't render for players with Shader Details levels that exceed the minimum or maximum.[Key names are related to
gpu_levelcvar used by Shader Details.]
|
See also
- {{KV BaseEntity}}
- {{I BaseEntity}}
- {{I BaseAnimating}}
- {{O BaseAnimating}}
The above documentation is transcluded from Template:KV BaseAnimating/doc. (edit | history)
Editors can experiment in this template's sandbox (edit) and testcases (edit) pages.
Add categories to the /doc subpage. Subpages of this page.
Tests
| Key (?) | Variable | Source (?) | Property Name | Default Value | Description |
|---|---|---|---|---|---|
| model | <string> | BaseAnimating | World Model | The model this entity should appear as. 128-character limit. |
|
| skin or ModelSkin |
<integer> | BaseAnimating | Skin | 0 | Some models have multiple skins. This value selects from the index, starting with 0. |
| solid | <choices> | BaseAnimating | Collisions | Use VPhysics | Method of collision for this entity.
Values: |
| hitboxset | <string> | BaseAnimating | Hitbox Set | ||
| body or SetBodyGroup | <integer> | BaseAnimating | Body Group | 0 | Sets the the active submodel ( $bodygroup).Warning:Submodel changes do not appear in Hammer, which may result in an inaccurate preview. |
| modelindex | <short> | BaseAnimating | Model Index | Given the number index from dumping the cl_precacheinfo modelprecache table, sets entity model to the index. Warning:If an entity has animations that will be played, then the set model also must have its own sequences, else the game crashes. |
|
| modelscale | <float> | BaseAnimating | Model Scale | 1.0 | (in all games since A multiplier for the size of the model. Negative values are accepted. Scales the physics model if the entity has a VPhysics object. )Warning:Negative or extremely high values can cause crashes!Note:Scale may not appear in Hammer 4.x, but will appear in-game (tested in ). This is fixed in Hammer++ and  Strata Source Hammer.Warning:Scaling physics objects is extremely expensive, and it can take x100 longer (~5 milliseconds) to spawn the entity! This is because it has to re-generate a new physics mesh each time. If this is an issue, recompile the model with the scaling baked in, or apply modelscale after spawning (only the visual will be scaled). |
Animating | |||||
| sequence | <integer> | BaseAnimating | Sequence | Default animation sequence for the model to be playing after spawning. |
|
| playbackrate | <float> | BaseAnimating | Playback Rate | ||
| cycle | <float> | BaseAnimating | Cycle | The current frame of the current animation, on a range from 0-1. |
|
| texframeindex | <integer> | BaseAnimating | Texture Frame | The initial frame number for all animated textures on this entity. |
|
Effects - Render | |||||
| fademindist | <float> | BaseAnimating | Start Fade Distance | -1 | Distance at which the entity starts fading. If 0 or less, the entity will disappear instantly when end fade is hit. The value will scale appropriately if the entity is in a 3D Skybox. |
| fademaxdist | <float> | BaseAnimating | End Fade Distance | 0 | Distance at which the entity ends fading. If 0 or less, the entity won't disappear at all. The value will scale appropriately if the entity is in a 3D Skybox. |
| fadescale | <float> | BaseAnimating | Fade Scale | 1 | If specified in the worldspawn, or if the engine is running below DirectX 8, entities will fade out even if the fade distances above aren't specified. This value gives more control over when this happens: numbers smaller than 1 cause the entity to fade out at further distances, and greater than 1 cause it to fade out at closer distances. Using 0 turns off the forced fade altogether. See also $noforcedfade. |
| renderamt | <integer> | BaseAnimating | FX Amount/Transparency (0–255) | 255 | Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible. |
| rendercolor | <color255> | BaseAnimating | Render Color (R G B) | 255 255 255 | Color tint. |
| renderfx | <choices> | BaseAnimating | Render FX | Normal | Various somewhat legacy alpha effects.
Values:
|
| rendermode | <choices> | BaseAnimating | Render Mode | Normal | |
Effects - Environment | |||||
| disableshadows | <boolean> | BaseAnimating | Disable Shadows | No | Prevent the entity from creating cheap render-to-texture shadows. Does not affect shadow mapping. |
| disablereceiveshadows | <boolean> | BaseAnimating | Disable Receiving Shadows | No | Prevent the entity from receiving shadows on itself. |
| shadowcastdist | <integer> | BaseAnimating | Shadow Cast Distance | 0 | Sets how far the entity casts dynamic shadows. 0 means default distance from the shadow_control entity. |
| LightingOrigin | <targetname> | BaseAnimating | Lighting Origin | Select an entity (not info_lighting!) from which to sample lighting instead of the entity's origin. |
|
| LightingOriginHack | <targetname> | BaseAnimating | Lighting Origin Offset | The info_lighting_relative from which to sample lighting instead of the entity's origin. Use Lighting Origin instead. |
|
| disableflashlight | <boolean> | BaseAnimating | Disable Flashlight | No | (in all games since Used to disable projected texture lighting and shadows on this entity. Identical to EF_NOFLASHLIGHT.) |
| disableshadowdepth | <boolean> | BaseAnimating | Disable ShadowDepth | No | (in all games since Makes this entity not cast a shadow from )env_projectedtexture entities. Identical to EF_NOSHADOWDEPTH. |
| shadowdepthnocache | <choices> | BaseAnimating | Projected Texture Cache | Default | (in all games since Used to hint projected texture system whether it is sufficient to cache shadow volume of this entity or to force render it every frame instead. Identical to)EF_SHADOWDEPTH_NOCACHE.
Values:
|
