CBaseAnimating: Difference between revisions
m (→::KeyValue method: -> KeyValue method) |
mNo edit summary Tag: Reverted |
||
| Line 11: | Line 11: | ||
{{Seealso|[[Model entity/Generic Keyvalues, Inputs and Outputs|More mapping friendly listing for generic KIO of all model entities]]}} | {{Seealso|[[Model entity/Generic Keyvalues, Inputs and Outputs|More mapping friendly listing for generic KIO of all model entities]]}} | ||
== Keyvalues == | ==Keyvalues== | ||
=== KeyValue method === | ===KeyValue method=== | ||
Doesn't override [[CBaseEntity#::KeyValue_method|CBaseEntity]]'s KeyValue method so no special keys are present. | Doesn't override [[CBaseEntity#::KeyValue_method|CBaseEntity]]'s KeyValue method so no special keys are present. | ||
{{↓|Keyfields}}, {{↓|Input keys}}, {{↓|Outputs}} | {{↓|Keyfields}}, {{↓|Input keys}}, {{↓|Outputs}} | ||
=== Keyfields === | ===Keyfields=== | ||
{{DEFINE_KEYFIELD|m_nBody|FIELD_INTEGER|body|the active [[$bodygroup]]}} | {{DEFINE_KEYFIELD|m_nBody|FIELD_INTEGER|body|the active [[$bodygroup]]}} | ||
{{DEFINE_KEYFIELD|m_nHitboxSet|FIELD_INTEGER|hitboxset|the active [[$hboxset]] {{confirm}}{{elaborate}}}} | {{DEFINE_KEYFIELD|m_nHitboxSet|FIELD_INTEGER|hitboxset|the active [[$hboxset]] {{confirm}}{{elaborate}}}} | ||
| Line 35: | Line 35: | ||
:{{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}} | :{{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 == | ==Inputs== | ||
=== Input keys === | ===Input keys=== | ||
{{DEFINE_INPUT|m_nSkin|FIELD_INTEGER|skin|The active [[skin]]}} | {{DEFINE_INPUT|m_nSkin|FIELD_INTEGER|skin|The active [[skin]]}} | ||
{{DEFINE_INPUT|m_nBody|FIELD_INTEGER|SetBodyGroup|{{↑|m_nBody}}}} | {{DEFINE_INPUT|m_nBody|FIELD_INTEGER|SetBodyGroup|{{↑|m_nBody}}}} | ||
| Line 69: | Line 69: | ||
{{DEFINE_INPUTFUNC|FIELD_STRING|SetLightingOrigin|InputSetLightingOrigin}} | {{DEFINE_INPUTFUNC|FIELD_STRING|SetLightingOrigin|InputSetLightingOrigin}} | ||
== Outputs == | ==Outputs== | ||
{{DEFINE_OUTPUT|m_OnIgnite|OnIgnite|COutputEvent}} | {{DEFINE_OUTPUT|m_OnIgnite|OnIgnite|COutputEvent}} | ||
{{DEFINE_OUTPUT|m_OnFizzled|OnFizzled|COutputEvent|game={{Portal 2|in}}}} | {{DEFINE_OUTPUT|m_OnFizzled|OnFizzled|COutputEvent|game={{Portal 2|in}}}} | ||
== Other fields == | ==Other fields== | ||
=== Keyless fields === | ===Keyless fields=== | ||
{{DEFINE_FIELD|m_flGroundSpeed|FIELD_FLOAT}} | {{DEFINE_FIELD|m_flGroundSpeed|FIELD_FLOAT}} | ||
{{DEFINE_FIELD|m_flLastEventCheck|FIELD_TIME}} | {{DEFINE_FIELD|m_flLastEventCheck|FIELD_TIME}} | ||
| Line 101: | Line 101: | ||
{{DEFINE_FIELD|m_flModelWidthScale|FIELD_FLOAT|game={{l4d|only}}}} | {{DEFINE_FIELD|m_flModelWidthScale|FIELD_FLOAT|game={{l4d|only}}}} | ||
=== Array fields === | ===Array fields=== | ||
{{DEFINE_ARRAY|m_flPoseParameter|FIELD_FLOAT|24}} | {{DEFINE_ARRAY|m_flPoseParameter|FIELD_FLOAT|24}} | ||
{{DEFINE_ARRAY|m_flEncodedController|FIELD_FLOAT|4}} | {{DEFINE_ARRAY|m_flEncodedController|FIELD_FLOAT|4}} | ||
=== Custom fields === | ===Custom fields=== | ||
{{DEFINE_FIELD|m_pIk|FIELD_CUSTOM}} <!-- DEFINE_CUSTOM_FIELD --> | {{DEFINE_FIELD|m_pIk|FIELD_CUSTOM}} <!-- DEFINE_CUSTOM_FIELD --> | ||
== Entity debugging == | ==Entity debugging== | ||
{{Seealso|[[CBaseEntity#Entity debugging]]}} | {{Seealso|[[CBaseEntity#Entity debugging]]}} | ||
=== {{cmd|ent_text}} === | ==={{cmd|ent_text}}=== | ||
Additional information added to ent_text overlay by this class | Additional information added to ent_text overlay by this class | ||
Revision as of 14:33, 29 July 2025
 Class hierarchy
|
|---|
| CBaseAnimating |
| baseanimating.cpp
|
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.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 , modelscaleis in-based branches and ModelScalesince
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)
Note:m_fadeMinDist/m_fadeMaxDist were removed from CBaseAnimating and moved to CBaseEntity class so they are available to all entitiesm_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
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()