CBaseAnimating: Difference between revisions

Latest revision as of 08:52, 31 October 2025

Stub

This article or section is a stub. You can help by expanding it.

Class hierarchy
CBaseAnimating ↳CBaseEntity
`baseanimating.cpp`

See also: Category:CBaseAnimating

CBaseAnimating is the C++ class from which all entities with models inherit, even if they don't actually move.

Important:Following Keyvalues / Inputs / Outputs are available for all entities that inherit this class, but may be overwritten by game code.

See also: More mapping friendly listing for generic KIO of all model entities

Keyvalues

KeyValue method

Doesn't override CBaseEntity's KeyValue method so no special keys are present. Keyfields ↓, Input keys ↓, Outputs ↓

Keyfields

m_nBody <FIELD_INTEGER> (body)

the active $bodygroup

m_nHitboxSet <FIELD_INTEGER> (hitboxset)

the active $hboxset ^[confirm]^[Elaborate?]

m_nSequence <FIELD_INTEGER> (sequence)

m_flPlaybackRate <FIELD_FLOAT> (playbackrate)

m_flCycle <FIELD_FLOAT> (cycle)

m_iszLightingOrigin <FIELD_STRING> (LightingOrigin)

m_iszLightingOriginRelative (not in )<FIELD_STRING> (LightingOriginHack)

m_bSuppressAnimSounds (in )<FIELD_BOOLEAN> (SuppressAnimSounds)

m_flModelScale (in all games since )<FIELD_FLOAT> (modelscale)

Note:No key is linked to this field in

, modelscale is in

-based branches and ModelScale since

Confirm:Verify somehow whether it exists in

or

. It doesn't exist in

or earlier.

m_flFadeScale (removed since )<FIELD_FLOAT> (fadescale)

Note:m_flFadeScale along with m_fadeMinDist/m_fadeMaxDist were removed from CBaseAnimating and moved to CBaseEntity class so they are available to all entities

Inputs

Input keys

m_nSkin <FIELD_INTEGER> (skin)

The active skin

m_nBody <FIELD_INTEGER> (SetBodyGroup)

m_nBody ↑

Note:m_fadeMinDist/m_fadeMaxDist were removed from CBaseAnimating and moved to CBaseEntity class so they are available to all entities

m_fadeMinDist (removed since )<FIELD_FLOAT> (fademindist)

m_fadeMaxDist (removed since )<FIELD_FLOAT> (fademaxdist)

Input functions

Ignite <FIELD_VOID> linked function: InputIgnite

description todo

IgniteLifetime <FIELD_FLOAT> linked function: InputIgniteLifetime

description todo

IgniteNumHitboxFires (removed since )<FIELD_INTEGER> linked function: InputIgniteNumHitboxFires

description todo

IgniteHitboxFireScale (removed since )<FIELD_FLOAT> linked function: InputIgniteHitboxFireScale

description todo

Note:Since

following two inputs call the same function that Ignite input calls

IgniteNumHitboxFires (in all games since )<FIELD_INTEGER> linked function: InputIgnite

description todo

IgniteHitboxFireScale (in all games since )<FIELD_FLOAT> linked function: InputIgnite

description todo

BecomeRagdoll <FIELD_VOID> linked function: InputBecomeRagdoll

description todo

SetModel (only in )<FIELD_STRING> linked function: InputSetModel

description todo

SetCycle (only in )<FIELD_FLOAT> linked function: InputSetCycle

description todo

SetPlaybackRate (only in )<FIELD_FLOAT> linked function: InputSetPlaybackRate

description todo

SetLightingOriginHack (not in )<FIELD_STRING> linked function: InputSetLightingOriginRelative

description todo

SetModelScale (removed since )<FIELD_VECTOR> linked function: InputSetModelScale

description todo

SetLightingOrigin <FIELD_STRING> linked function: InputSetLightingOrigin

description todo

Outputs

m_OnIgnite <COutputEvent> (OnIgnite)

m_OnFizzled (in )<COutputEvent> (OnFizzled)

Other fields

Keyless fields

m_flGroundSpeed <FIELD_FLOAT>

m_flLastEventCheck <FIELD_TIME>

m_bSequenceFinished <FIELD_BOOLEAN>

m_bSequenceLoops <FIELD_BOOLEAN>

m_iIKCounter <FIELD_INTEGER>

m_bClientSideAnimation <FIELD_BOOLEAN>

m_bClientSideFrameReset <FIELD_BOOLEAN>

m_nNewSequenceParity <FIELD_INTEGER>

m_nResetEventsParity <FIELD_INTEGER>

m_nMuzzleFlashParity <FIELD_CHARACTER>

m_hLightingOrigin <FIELD_EHANDLE>

m_flDissolveStartTime <FIELD_TIME>

m_fBoneCacheFlags <FIELD_SHORT>

m_flFrozen (in all games since )<FIELD_FLOAT>

m_flFrozenThawRate (in all games since )<FIELD_FLOAT>

m_flFrozenMax (in all games since )<FIELD_FLOAT>

m_hLightingOriginRelative (not in )<FIELD_EHANDLE>

m_flModelWidthScale (only in )<FIELD_FLOAT>

Array fields

m_flPoseParameter[24] <FIELD_FLOAT>

m_flEncodedController[4] <FIELD_FLOAT>

Custom fields

m_pIk <FIELD_CUSTOM>

Entity debugging

See also: CBaseEntity#Entity debugging

`ent_text`

Additional information added to ent_text overlay by this class

Sequence: (<sequence number>) <sequence name>
Activity: <activity name> (only if there is one)
Cycle: <cycle> (<animation time>)

exact format:

"Sequence: (%3d) %s",GetSequence(), GetSequenceName( GetSequence() )
"Activity %s", GetSequenceActivityName(GetSequence()) (only if there is one) 
"Cycle: %.5f (%.5f)", (float)GetCycle(), m_flAnimTime.Get()

@@ Line 1: / Line 1: @@
 {{LanguageBar}}
-{{tabs|CBaseAnimating|goldsrc=1|source=1|main=source}}
+{{stub}}
-{{CD|CBaseAnimating|base=CBaseEntity|file1=[https://github.com/ValveSoftware/source-sdk-2013/blob/master/mp/src/game/server/baseanimating.cpp baseanimating.cpp]}}
+{{TabsBar|main=gs|base=CBaseAnimating}}
+{{CD|CBaseAnimating|base=CBaseEntity|file1=[https://github.com/ValveSoftware/source-sdk-2013/blob/master/src/game/server/baseanimating.cpp baseanimating.cpp]}}
 {{seealso|[[:Category:CBaseAnimating]]}}
@@ Line 7: / Line 8: @@
 {{important|Following Keyvalues / Inputs / Outputs are available for all entities that inherit this class, but may be overwritten by game code.}}
+{{toc-right}}
+{{Seealso|[[Model entity/Generic Keyvalues, Inputs and Outputs|More mapping friendly listing for generic KIO of all model entities]]}}
 == Keyvalues ==
-{{KV|[[Skin]]|intn=skin or ModelSkin {{as}}|int|Some models have multiple skins. This value selects from the index, starting with 0.}}
+=== KeyValue method ===
-{{KV|Collisions|intn=solid|choices|Method of collision for this entity.<!--
+Doesn't override [[CBaseEntity#::KeyValue_method|CBaseEntity]]'s KeyValue method so no special keys are present.
--->{{Expand|title=Choices|margin_left=2em|margin_bottom=0|
+{{↓|Keyfields}}, {{↓|Input keys}}, {{↓|Outputs}}
-:*'''0''': None
-:*'''1''': BSP ([[QPhysics]])
-{{Bug|In {{portal2|4}}, if an entity using QPhysics collisions is hit by [[Gel]], the game will crash!}}
-:*'''2''': [[Bounding box|Bounding Box]]
-:*'''3''': Oriented Bounding Box (Use for runtime spawned rotated brush entities)
-:*'''4''': Oriented Bounding Box, constrained to [[QAngle|Yaw]] only
-:*'''5''': Custom/Test (Usually no collision with anything)
-:*'''6''': [[VPhysics]]}}
-}}
-{{KV|[[Hitbox]] Set|intn=hitboxset|string|Sets the {{Ent|$hboxset}} to use.|nofgd=1}}
+=== Keyfields ===
-{{KV|Body Group|intn=body or SetBodyGroup|int|Sets the the active {{Ent|$bodygroup}}.{{note|If both {{code|body}} and {{code|SetBodyGroup}} are present (even if set to 0), {{code|body}} will be prioritized.}}|nofgd=1}}
+{{DEFINE_KEYFIELD|m_nBody|FIELD_INTEGER|body|the active [[$bodygroup]]}}
-<!-- We should make a new page for "model index"? -->
+{{DEFINE_KEYFIELD|m_nHitboxSet|FIELD_INTEGER|hitboxset|the active [[$hboxset]] {{confirm}}{{elaborate}}}}
-{{KV|Model Scale|intn=modelscale|float|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 {{hammer4|2}}, but will appear in-game. This is fixed in {{hammer++|2}}.}}|since=EP2}}
+{{DEFINE_KEYFIELD|m_nSequence|FIELD_INTEGER|sequence}}
+{{DEFINE_KEYFIELD|m_flPlaybackRate|FIELD_FLOAT|playbackrate}}
+{{DEFINE_KEYFIELD|m_flCycle|FIELD_FLOAT|cycle}}
-<!--
+{{DEFINE_KEYFIELD|m_iszLightingOrigin|FIELD_STRING|LightingOrigin}}
-  ++ Animating ++
+{{DEFINE_KEYFIELD|m_iszLightingOriginRelative|FIELD_STRING|LightingOriginHack|game={{not|{{l4ds}}}}}}
--->
-{{style|color:white;font-size:14px;padding-bottom:5px|'''Animating'''}}
-{{KV|Sequence|intn=sequence|int|Default animation sequence for the model to be playing after spawning.|nofgd=1}}
-{{KV|Playback Rate|intn=playbackrate|float|A multiplier of the [[framerate]] at which animations are played, negative values are accepted. Default is 1.0.|nofgd=1}}
-{{KV|Cycle|intn=cycle|float|The current frame of the current animation, on a range from 0-1.|nofgd=1}}
-<!--
-  ++ Effects - Render ++
--->
-{{style|border-bottom:1px solid #3A3937;display:block;  color:white;font-size:16px;padding-bottom:6px|'''Effects - Render'''}}
-{{KV|Start Fade Distance|intn=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]].}}
+{{DEFINE_KEYFIELD|m_bSuppressAnimSounds|FIELD_BOOLEAN|SuppressAnimSounds|game={{Portal 2|in}}}}
-{{KV|End Fade Distance|intn=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.}}
-{{KV|Fade Scale|intn=fadescale|float|If specified in the {{Ent|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 {{Ent|$noforcedfade}}.}}
-<!--
+{{DEFINE_KEYFIELD|m_flModelScale|FIELD_FLOAT|modelscale|game={{since|{{l4d2}}{{src13}}}}}}
-  ++ Effects - Environment ++
+:{{Note|No key is linked to this field in {{l4d2}}, <code>modelscale</code> is in {{src13}}-based branches and <code>ModelScale</code> since {{as}}}}
--->
+:{{confirm|Verify somehow whether it exists in {{src09}} or {{srcmp}}. It doesn't exist in {{src07}} or earlier.}}
-{{style|border-bottom:1px solid #3A3937;display:block;  color:white;font-size:16px;padding-bottom:6px|'''Effects - Environment'''}}
-{{KV|Lighting Origin|intn=LightingOrigin|targetname|Select an entity (not {{Ent|info_lighting}}!) from which to sample lighting instead of the entity's [[origin]] or [[$illumposition]].}}
+{{DEFINE_KEYFIELD|m_flFadeScale|FIELD_FLOAT|fadescale|game={{l4d|removed}}}}
+:{{Note|m_flFadeScale along with m_fadeMinDist/m_fadeMaxDist were removed from CBaseAnimating and moved to CBaseEntity class so they are available to all entities}}
-{{KV|Lighting Origin Offset|intn=LightingOriginHack|targetname|The {{Ent|info_lighting_relative}} from which to sample lighting instead of the entity's origin or $illumposition. Use <tt>Lighting Origin</tt> instead.|not={{l4ds}}|nofgd=1|deprecated=1}}
+== Inputs ==
+=== Input keys ===
+{{DEFINE_INPUT|m_nSkin|FIELD_INTEGER|skin|The active [[skin]]}}
+{{DEFINE_INPUT|m_nBody|FIELD_INTEGER|SetBodyGroup|{{↑|m_nBody}}}}
+{{Note|m_fadeMinDist/m_fadeMaxDist were removed from CBaseAnimating and moved to CBaseEntity class so they are available to all entities}}
+{{DEFINE_INPUT|m_fadeMinDist|FIELD_FLOAT|fademindist|game={{l4d|removed}}}}
+{{DEFINE_INPUT|m_fadeMaxDist|FIELD_FLOAT|fademaxdist|game={{l4d|removed}}}}
+=== Input functions ===
+{{DEFINE_INPUTFUNC|FIELD_VOID|Ignite|InputIgnite}}
+{{DEFINE_INPUTFUNC|FIELD_FLOAT|IgniteLifetime|InputIgniteLifetime}}
+{{DEFINE_INPUTFUNC|FIELD_INTEGER|IgniteNumHitboxFires|InputIgniteNumHitboxFires|game={{l4d2|removed}}}}
+{{DEFINE_INPUTFUNC|FIELD_FLOAT|IgniteHitboxFireScale|InputIgniteHitboxFireScale|game={{l4d2|removed}}}}
+{{note|Since {{l4d2}} following two inputs call the same function that <code>Ignite</code> input calls }}
+{{DEFINE_INPUTFUNC|FIELD_INTEGER|IgniteNumHitboxFires|InputIgnite|game={{l4d2|since}}}}
+{{DEFINE_INPUTFUNC|FIELD_FLOAT|IgniteHitboxFireScale|InputIgnite|game={{l4d2|since}}}}
+{{DEFINE_INPUTFUNC|FIELD_VOID|BecomeRagdoll|InputBecomeRagdoll}}
-{{KV|Disable Flashlight|intn=disableflashlight|boolean|Used to disable [[env_projectedtexture|projected texture]] lighting and shadows on this entity. Identical to <tt>[[Effect flags|EF_NOFLASHLIGHT]]</tt>.|since=P2}}
-{{KV|Disable ShadowDepth|intn=disableshadowdepth|boolean|Makes this entity not cast a shadow from {{Ent|env_projectedtexture}} entities. Identical to <tt>[[Effect flags|EF_NOSHADOWDEPTH]]</tt>.|since=P2}}
-{{KV|Projected Texture Cache|intn=shadowdepthnocache|choices|Used to hint [[env_projectedtexture|projected texture system]] whether it is sufficient to cache shadow volume of this entity or to force render it every frame instead. Identical to<code>[[Effect flags|EF_SHADOWDEPTH_NOCACHE]]</code>.
-:*0: Default
-:*1: No cache—render every frame
-:*2: Cache it—render only once|since=P2}}
-<!--
+{{DEFINE_INPUTFUNC|FIELD_STRING|SetModel|InputSetModel|game={{tf2|only}}}}
-  ++ Misc ++
+{{DEFINE_INPUTFUNC|FIELD_FLOAT|SetCycle|InputSetCycle|game={{tf2|only}}}}
-Game-Specific Configs
+{{DEFINE_INPUTFUNC|FIELD_FLOAT|SetPlaybackRate|InputSetPlaybackRate|game={{tf2|only}}}}
--->{{style|border-bottom:1px solid #3A3937; display:block; color:white; font-size:16px; padding-bottom:6px|'''Miscellaneous'''}}
-{{KV|No Animation Sounds|intn=SuppressAnimSounds|boolean|Silences sounds linked to animations.|since=P2|nofgd=1}}
+{{DEFINE_INPUTFUNC|FIELD_STRING|SetLightingOriginHack|InputSetLightingOriginRelative|game={{l4ds|not}}}}
-{{KV DXLevelChoice}}
-== Inputs ==
-{{IO|skin|param=int|Selects a [[skin]] from the model's index, starting with 0.}}
+{{DEFINE_INPUTFUNC|FIELD_VECTOR|SetModelScale|InputSetModelScale|game={{l4d|removed}}}}
-{{IO|SetBodyGroup|param=int|Sets the the active {{ent|$bodygroup}}.}}
-{{IO|Ignite|Makes the entity catch on fire indefinitely.}}
+{{DEFINE_INPUTFUNC|FIELD_STRING|SetLightingOrigin|InputSetLightingOrigin}}
-{{IO|IgniteLifetime|param=float|Makes the entity catch on fire for a given amount of time.}}
-{{IO|IgniteNumHitboxFires|param=int|Makes the entity catch on fire with a given number of [[hitbox]] fire particles. Does not function correctly in {{l4d2}} onward.|removed={{l4d2}}}}
-{{IO|IgniteHitboxFireScale|param=float|Makes the entity catch on fire with a given scale for [[hitbox]] fire particles. Does not function correctly in {{l4d2}} onward.|removed={{l4d2}}}}
-{{IO|BecomeRagdoll|Kills the entity and creates a client-side ragdoll from the model. Input is only passed if the model contains {{ent|$collisionjoints}}. For other models, {{ent|phys_convert}} can be used instead.}}
-{{IO|SetLightingOrigin|param=targetname|Sets the entity's lighting origin to use this entity's position.}}
-{{IO|SetLightingOriginHack|param=targetname|Offsets the entity's lighting origin by their distance from an {{ent|info_lighting_relative}}. Use <code>SetLightingOrigin</code> instead.|deprecated=1|removed={{l4d}}}}
-{{IO|fademindist|param=float|Sets distance at which the entity starts fading. If <0, the entity will disappear instantly when end fade is hit. The value will scale appropriately if the entity is in a [[3D Skybox]].}}
-{{IO|fademaxdist|param=float|Sets distance at which the entity ends fading. If <0, the entity won't disappear at all. The value will scale appropriately if the entity is in a [[3D Skybox]].}}
-{{IO|SetModelScale|param=vector|only={{src13}}|Multiplies the size of the model. Does not alter the physics collisions in most cases. Can take two values separated by a space, in which case the first value would be the target model scale and the second value would be the number of seconds the change in scale will be spread over. If there is no second value, the model will scale instantly.{{tip|The <code>modelscale</code> keyvalue can be [[AddOutput]]ed as a workaround for other games with this input missing.}}
-:{{warning|Negative or extremely high values can cause crashes!}}}}
-{{IO|SetCycle|param=float|Skip to a specific point in the current animation.|only={{tf2}}}}
-{{IO|SetModel|param=string|Changes the model to the specified path. Form of <tt>models/ammo/ammo_us.mdl</tt>.
-:{{important|Absolutely NO quotes! Make sure you use the forward slash '/'. [[Merasmus]] says to heed this advice, else thou shalt corrupt the VMF.}}|only={{tf2}}}}
 == Outputs ==
-{{IO|OnIgnite|nofgd=1|Fired when the entity catches fire, such as from an {{ent|env_entity_igniter}} or the <code>Ignite</code> inputs.}}
+{{DEFINE_OUTPUT|m_OnIgnite|OnIgnite|COutputEvent}}
-{{IO|OnFizzled|only={{portal2}}|Fired when this entity is fizzled by a {{ent|trigger_portal_cleanser}} or, for {{ent|prop_weighted_cube}}, the Dissolve or SilentDissolve inputs. :{{bug|It does not fire when the object is fizzled by other means such as {{ent|env_entity_dissolver}}.}}
+{{DEFINE_OUTPUT|m_OnFizzled|OnFizzled|COutputEvent|game={{Portal 2|in}}}}
-}}
+== Other fields ==
+=== Keyless fields ===
+{{DEFINE_FIELD|m_flGroundSpeed|FIELD_FLOAT}}
+{{DEFINE_FIELD|m_flLastEventCheck|FIELD_TIME}}
+{{DEFINE_FIELD|m_bSequenceFinished|FIELD_BOOLEAN}}
+{{DEFINE_FIELD|m_bSequenceLoops|FIELD_BOOLEAN}}
+{{DEFINE_FIELD|m_iIKCounter|FIELD_INTEGER}}
+{{DEFINE_FIELD|m_bClientSideAnimation|FIELD_BOOLEAN}}
+{{DEFINE_FIELD|m_bClientSideFrameReset|FIELD_BOOLEAN}}
+{{DEFINE_FIELD|m_nNewSequenceParity|FIELD_INTEGER}}
+{{DEFINE_FIELD|m_nResetEventsParity|FIELD_INTEGER}}
+{{DEFINE_FIELD|m_nMuzzleFlashParity|FIELD_CHARACTER}}
+{{DEFINE_FIELD|m_hLightingOrigin|FIELD_EHANDLE}}
+{{DEFINE_FIELD|m_flDissolveStartTime|FIELD_TIME}}
+{{DEFINE_FIELD|m_fBoneCacheFlags|FIELD_SHORT}}
+{{DEFINE_FIELD|m_flFrozen|FIELD_FLOAT|game={{l4d2|since}}}}
+{{DEFINE_FIELD|m_flFrozenThawRate|FIELD_FLOAT|game={{l4d2|since}}}}
+{{DEFINE_FIELD|m_flFrozenMax|FIELD_FLOAT|game={{l4d2|since}}}}
+{{DEFINE_FIELD|m_hLightingOriginRelative|FIELD_EHANDLE|game={{l4ds|not}}}}
+{{DEFINE_FIELD|m_flModelWidthScale|FIELD_FLOAT|game={{l4d|only}}}}
+=== Array fields ===
+{{DEFINE_ARRAY|m_flPoseParameter|FIELD_FLOAT|24}}
+{{DEFINE_ARRAY|m_flEncodedController|FIELD_FLOAT|4}}
+=== Custom fields ===
+{{DEFINE_FIELD|m_pIk|FIELD_CUSTOM}} <!-- DEFINE_CUSTOM_FIELD -->
+== Entity debugging ==
+{{Seealso|[[CBaseEntity#Entity debugging]]}}
-== Debugging ==
 === {{cmd|ent_text}} ===
 Additional information added to ent_text overlay by this class

CBaseAnimating: Difference between revisions

Latest revision as of 08:52, 31 October 2025

Contents