CBaseEntity: Difference between revisions

Revision as of 05:38, 27 September 2024

This article or section needs to be cleaned up to conform to a higher standard of quality because:
stuff, terminology?, sections
For help, see the VDC Editing Help and Wikipedia cleanup process. Also, remember to check for any notes left by the tagger at this article's talk page.

Class hierarchy
CBaseEntity ↳IServerEntity ↳IServerUnknown ↳IHandleEntity
`baseentity.cpp`

The base class for all entities.

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

Descriptions of in-game accessible Keyvalues / Inputs / Outputs

Classname (classname) <string> !FGD: Determines the characteristics of the entity before it spawns.

Global Entity Name (globalname) <string>: When the player transitions to a new map, entities in the new map with matching globalnames will have their previous map's states copied over to it.

Parent (parentname) <targetname>: Maintain the same initial offset to this entity. An attachment point can also be used if separated by a comma at the end. (parentname [targetname],[attachment]).

Hammer ID (hammerid) <integer> !FGD: The entity's unique Hammer ID that's auto-generated on map compiles. Mainly used by plugins or debugging commands (like the ent_keyvalue command). Entities spawned in run-time don't have a Hammer ID.

Speed (speed) <float>

Render FX (renderfx) <byte choices>: Various somewhat legacy alpha effects. See render effects.

Render Mode (rendermode) <byte choices>: Set a non-standard rendering mode on this entity.

Render Modes
0: Normal 1: Color 2: Texture 3: Glow 4: Solid/Alphatest 5: Additive 6: Removed, does nothing 7: Additive Fractional Frame 8: Alpha Add 9: World Space Glow 10: Don't Render

Next Think (nextthink) <float> !FGD: Amount of time before the entity thinks again.

Effects (effects) <flags> !FGD: Combination of effect flags to use.

Render Color (R G B) (rendercolor or rendercolor32) <color255>: Color tint.

Model Index (modelindex) <short> !FGD: 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.

Response Contexts (ResponseContext) <string>: Pre-defined response system contexts; Format is [key]:[value],[key]:[value],...and so on.
Tip:Can also be filtered for or against!

Max Health (max_health) <integer>: Health cannot exceed this value. This keyvalue applies to only specific entities.

Health (health) <integer>: Current health of an entity. This keyvalue applies to only specific entities.

Target (target) <string>

Damage filter (damagefilter) <string>: Name of a filter that controls which entities can damage this entity.

Shadow Cast Distance (shadowcastdist) <integer>: Sets how far the entity casts dynamic shadows. 0 means default distance from the shadow_control entity.

TeamNum (TeamNum) <integer>

Model (model) <string>: In-game representation of the entity to display. For brush entities, this is a reference to a non-zero bmodel index in the current BSP. For point entities, this is the path to an MDL model or VMT sprite, relative to the game's root directory. Not all entities will actually render the model, and only specific entities will precache the model defined here (non-precached models cannot be displayed).

Base velocity (basevelocity) <vector> !FGD

Angular velocity (avelocity) <vector> !FGD

Water level (waterlevel) <character> !FGD

Gravity (gravity) <float> !FGD

Friction (friction) <float> !FGD: Warning:Non-functional.

Local Time (ltime) <float> !FGD: The local time of the entity, independent of the global clock. Used mainly for physics calculations.

Velocity (velocity) <vector> !FGD

Texture Frame (texframeindex) <integer> !FGD: The initial frame number for all animated textures on this entity.

Spawnflags (spawnflags) <flags> !FGD: Toggles exclusive features of an entity, its specific number is determined by the combination of flags added.

View offset (view_ofs) <vector> !FGD

Since Team Fortress 2 and Alien Swarm

Collision Group (CollisionGroup) <choices> !FGD: Sets a collision group for this entity, which changes its collision behavior.

Groups
0: None 1: Debris, collides only with the world and static props 2: Debris, with trigger interaction 3: Interactive Debris, doesn't collide with other debris 4: Interactive, collides with everything except debris 5: Player 6: Breakable Glass 7: Vehicle 8: Player Movement 9: In-Vehicle 10: Weapon 11: Vehicle Clip 12: Projectile 13: Door blocker, not permitted to go near doors 14: Passable Door 15: Dissolving 16: Pushaway 17: NPC Actor, NPCs ignore the player 18: NPC Scripted, NPCs do not collide with each other

Move Type (MoveType) <choices> !FGD: Sets a movetype for this entity, which changes its movement behavior.

Move Types
0: None, don't move 1: Isometric 2: Walk, player only, moving on ground 3: NPC, movement 4: Fly, no gravity 5: Fly, with gravity 6: Physics 7: Push 8: Noclip 9: Ladder, for players on ladders 10: Spectator 11: Custom

Team number (teamnumber) <integer>

Only in Left 4 Dead 2

Disable for Xbox 360 (disableX360) <boolean> !FGD: If this entity should automatically be given the 'Disable' input on the Xbox 360 version of Source.

Glow Backface Multiple (glowbackfacemult) <float> !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.

Only in Left 4 Dead 2, Alien Swarm, Portal 2

Addon (addon)

Lag Compensation (LagCompensate) <boolean> !FGD: Set to Yes to lag compensate this entity. Should be used very sparingly!

Since Left 4 Dead 2, also in Team Fortress 2

Entity Scripts (vscripts) <scriptlist>: Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions. Scripts executed on the worldspawn entity will be placed in root scope.

Think function (thinkfunction) <string>: Name of the function within this entity's script that'll be called automatically every 100 milliseconds, or a user-defined interval if the function returns a number. Avoid expensive operations in this function, as it may cause performance problems.

Since Left 4 Dead

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.

Minimum / Maximum Effect Details Level (mincpulevel / maxcpulevel) <choices> !FGD: Don't render for players with Effect Details levels that exceed the minimum or maximum.

Choices
0: Default ("Low" for`mincpulevel`, "High" for`maxcpulevel`) 1: Low 2: Medium 3: High

Minimum / Maximum Shader Details Level (mingpulevel / maxgpulevel) <choices> !FGD: Don't render for players with Shader Details levels that exceed the minimum or maximum.

Choices
0: Default ("Low" for`mingpulevel`, "Very High" for`maxgpulevel`) 1: Low 2: Medium 3: High 4: VeryHigh

See also: cpu_level / gpu_level convars

Additional keyvalue code from baseentity_shared.cpp

FX Amount/Transparency (0–255) (renderamt) <integer>: Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.

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.

mins (mins) <vector> !FGD

maxs (maxs) <vector> !FGD

No damage forces (nodamageforces) <boolean>

Pitch Yaw Roll (Y Z X) (angles) <angle>: This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.
Note:This works on brush entities, although Hammer doesn't show the new angles.

Angle (angle) !FGD

Origin (X Y Z) (origin) <coordinates>: The position of this entity's center in the world. Rotating entities typically rotate around their origin.
Bug:Hammer does not move point entities accordingly in the editor. [todo tested in ?]

Name (targetname) <string>: The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.

Inputs
`AddContext` `<stringRedirectInput/string>` Adds to the entity's list of response contexts. See Context. `AddOutput` `<stringRedirectInput/string>` Assigns a new keyvalue/output on this entity. For keyvalues, some rely on extra necessary code to be ran and won't work if its simply just changed through this input. There is a strict format that must be followed: {\| class="mw-collapsible mw-collapsed" style="background:rgba(0,0,0,0.05) ;float:no;margin-bottom:1em;margin-left:0;padding-right:0.5em;border:1px solid rgba(255,255,255,0.1); border-left:solid 1px #8bb9e0; padding-left:1em;"
// Format of changing KeyValues: "AddOutput [key] [value]" //// Raw text: "OnUser1" "!self,AddOutput,targetname new_name" // Format of adding an Output: "AddOutput {targetname}:{inputname}:{parameter}:{delay}:{max times to fire, -1 means infinite}" //// Raw text: "OnUser1" "!self,AddOutput,OnUser1:SetParent:!activator:0.0:-1" // Arguments can be left blank, but the empty blank should still be contained. //// Raw text: "OnUser1" "!self,AddOutput,OnUser1:ClearParent::0.0:-1"

ClearContext: Removes all contexts from this entity's list.

ClearParent: Removes this entity from the movement hierarchy, leaving it free to move independently.

FireUser1 to FireUser4: Fires the respectiveOnUseroutputs; see User Inputs and Outputs.

Kill: Removes this entity and any entities parented to it from the world.

KillHierarchy: Functions the same as Kill, although this entity and any entities parented to it are killed on the same frame, being marginally faster thanKillinput.

RemoveContext <stringRedirectInput/string>: Remove a context from this entity's list. The name should match the key of an existing context.

SetParent <stringRedirectInput/string>: Move with this entity. See Entity Hierarchy (parenting).

SetParentAttachment <stringRedirectInput/string>: Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.

SetParentAttachmentMaintainOffset <stringRedirectInput/string>: As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.

Use !FGD: Same as a player invoking +use; no effect in most cases.

SetTeam <integerRedirectInput/integer> !FGD: Changes this entity's team.

TeamNum <integerRedirectInput/integer> !FGD: This input changes value for TeamNum property.

DispatchResponse <stringRedirectInput/string> !FGD: Dispatches a response to the entity. See Response and Concept.

DispatchEffect <stringRedirectInput/string> (removed since ) !FGD: Dispatches a special effect from the entity's origin; See also List of Client Effects. Replaced by the particle system since .

RunScriptFile <scriptRedirectInput/string> (in all games since ) (also in ): Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.

RunScriptCode <stringRedirectInput/string> (in all games since ) (also in ): Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.

CallScriptFunction <stringRedirectInput/string> (in all games since ) (also in ) !FGD: Calls a VScript function defined in the scope of the receiving entity.

TerminateScriptScope (only in ) !FGD: Destroys the script scope of the receiving entity.

SetLocalOrigin <coordinates> (in all games since ) !FGD: Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.

SetLocalAngles <anglesRedirectInput/Vector> (in all games since ) !FGD: Set this entity's angles.

Alpha <integerRedirectInput/integer>: Sets the entity's transparency to a number from 0 (invisible) to 255 (fully visible). Requires the entity to have its Render Mode (rendermode) set to a number other than 0.

AlternativeSorting <booleanRedirectInput/boolean>: Swaps the rendering order of the entity. Used to attempt to fix sorting problems when rendering, for example an object rendering in front of translucent materials.

Color <color255RedirectInput/color32>: Sets an RGB color for the entity.

SetDamageFilter <targetnameRedirectInput/string>: Sets a filter for this entity for when it receives damage.

EnableDamageForces: Allows the entity to be pushed by damage done to it (usually force amount correlates with the damage done).

DisableDamageForces: Prevents the entity from being pushed by damage done to it.

DisableShadow: Turn dynamic shadows off for this entity. Identical to applying EF_NOSHADOW.

EnableShadow: Turn dynamic shadows on for this entity.

Only in Portal 2

DisableDrawInFastReflection: Turns off rendering of this entity in reflections when using $reflectonlymarkedentities in water material.

EnableDrawInFastReflection: Turn on rendering of this entity in reflections when using $reflectonlymarkedentities in water material.

SetLocalOrigin <stringRedirectInput/string>: Set this entity's origin in the map.

SetLocalAngles <stringRedirectInput/string>: Set this entity's angles in the map.

EnableDraw: Removes EF_NODRAW from the entity.

DisableDraw: Applies EF_NODRAW to the entity. Note that this is different than Render Mode 10.

RemovePaint

|}

Outputs

OnUser1 to OnUser4: Fired as response to FireUser1 / FireUser4.

OnKilled: Fired when entity is killed.

Fields

m_iName <FIELD_STRING>

Name other entities use to refer to this entity (vscript GetName() returns this)

m_vecOrigin <FIELD_VECTOR>

Relative to parent^[confirm]

m_vecAbsOrigin <FIELD_POSITION_VECTOR>

m_vecAbsVelocity <FIELD_VECTOR>

m_angRotation <FIELD_VECTOR>

m_angAbsRotation <FIELD_VECTOR>

m_fFlags <FIELD_INTEGER>

m_iEFlags <FIELD_INTEGER>

m_debugOverlays <FIELD_INTEGER>

Set by commands like ent_text, ent_bbox

m_flPrevAnimTime <FIELD_TIME>

m_flAnimTime <FIELD_TIME>

m_lifeState <FIELD_CHARACTER>

LIFE_ALIVE = 0
LIFE_DYING = 1 // playing death animation or still falling off of a ledge waiting to hit ground
LIFE_DEAD = 2 // dead. lying still.
LIFE_RESPAWNABLE = 3
LIFE_DISCARDBODY = 4

m_takedamage <FIELD_CHARACTER>

DAMAGE_NO = 0
DAMAGE_EVENTS_ONLY = 1 // Call damage functions, but don't modify health
DAMAGE_YES = 2
DAMAGE_AIM = 3

m_MoveCollide <FIELD_CHARACTER>

m_flElasticity <FIELD_FLOAT>

touchStamp <FIELD_INTEGER>

m_flDesiredShadowCastDistance <FIELD_FLOAT>

m_flGroundChangeTime <FIELD_TIME>

m_nWaterType <FIELD_CHARACTER>

m_pBlocker <FIELD_EHANDLE>

m_flVPhysicsUpdateLocalTime <FIELD_FLOAT>

m_flMoveDoneTime <FIELD_FLOAT>

m_bAlternateSorting <FIELD_BOOLEAN>

m_flSimulationTime <FIELD_TIME>

m_nLastThinkTick <FIELD_TICK>

m_nSimulationTick <FIELD_TICK>

m_bSimulatedEveryTick <FIELD_BOOLEAN>

m_bAnimatedEveryTick <FIELD_BOOLEAN>

m_nTransmitStateOwnedCounter <FIELD_CHARACTER>

m_flNavIgnoreUntilTime <FIELD_TIME>

m_pParent <FIELD_EHANDLE>

m_iParentAttachment <FIELD_CHARACTER>

m_hMoveParent <FIELD_EHANDLE>

m_hMoveChild <FIELD_EHANDLE>

m_hMovePeer <FIELD_EHANDLE>

m_hDamageFilter <FIELD_EHANDLE>

m_hOwnerEntity <FIELD_EHANDLE>

m_hEffectEntity <FIELD_EHANDLE>

m_hGroundEntity <FIELD_EHANDLE>

m_bForcePurgeFixedupStrings (in ) <FIELD_BOOLEAN>

m_flCreateTime (in ) <FIELD_TIME>

m_bClientSideRagdoll (in all games since ) <FIELD_BOOLEAN>

m_iszScriptId (in all games since )(also in ) <FIELD_STRING>

Only Left 4 Dead 2

m_hScriptUseTarget <FIELD_EHANDLE>

m_PreStasisMoveType <FIELD_INTEGER>

m_bIsInStasis <FIELD_BOOLEAN>

Only Portal 2

m_iSignifierName <FIELD? 4bytes>

m_iObjectCapsCache <FIELD? 4bytes>

Array fields

m_rgflCoordinateFrame[12] <FIELD_FLOAT>

(only in ) m_nModelIndexOverrides[4] <FIELD_INTEGER>

Keyfield since Alien Swarm and also in Team Fortress 2

Note:These were give a key since

and also in

m_iTeamNum <FIELD_INTEGER> (teamnumber)

m_CollisionGroup <FIELD_INTEGER> (CollisionGroup)

Sets a collision group for this entity, which changes its collision behavior.

Groups
0: None 1: Debris, collides only with the world and static props 2: Debris, with trigger interaction 3: Interactive Debris, doesn't collide with other debris 4: Interactive, collides with everything except debris 5: Player 6: Breakable Glass 7: Vehicle 8: Player Movement 9: In-Vehicle 10: Weapon 11: Vehicle Clip 12: Projectile 13: Door blocker, not permitted to go near doors 14: Passable Door 15: Dissolving 16: Pushaway 17: NPC Actor, NPCs ignore the player 18: NPC Scripted, NPCs do not collide with each other

m_MoveType <FIELD_CHARACTER> (MoveType)

Sets a movetype for this entity, which changes its movement behavior.

Move Types
0: None, don't move 1: Isometric 2: Walk, player only, moving on ground 3: NPC, movement 4: Fly, no gravity 5: Fly, with gravity 6: Physics 7: Push 8: Noclip 9: Ladder, for players on ladders 10: Spectator 11: Custom

Keyfields

Todo: most explained at Generic Keyvalues, Inputs and Outputs, should add only more advanced information that wouldn't fit there?

m_iClassname <FIELD_STRING> (classname)

m_iGlobalname <FIELD_STRING> (globalname)

m_iParent <FIELD_STRING> (parentname)

m_iHammerID <FIELD_INTEGER> (hammerid)

The entity's unique Hammer ID that's auto-generated on map compiles. Mainly used by plugins or debugging commands (like the ent_keyvalue command). Entities spawned in run-time don't have a Hammer ID.

m_flSpeed <FIELD_FLOAT> (speed)

m_nRenderFX <FIELD_CHARACTER> (renderfx)

m_nRenderMode <FIELD_CHARACTER> (rendermode)

m_nNextThinkTick <FIELD_TICK> (nextthink)

Amount of time before the entity thinks again.

m_fEffects <FIELD_INTEGER> (effects)

m_clrRender <FIELD_COLOR32> (rendercolor)

m_nModelIndex <FIELD_SHORT> (modelindex)

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.

m_iszResponseContext <FIELD_STRING> (ResponseContext)

Pre-defined response system contexts; Format is [key]:[value],[key]:[value],...and so on.

Tip:Can also be filtered for or against!

m_iMaxHealth <FIELD_INTEGER> (max_health)

m_iHealth <FIELD_INTEGER> (health)

m_target <FIELD_STRING> (target)

m_iszDamageFilterName <FIELD_STRING> (damagefilter)

m_flShadowCastDistance <FIELD_FLOAT> (shadowcastdist)

m_ModelName <FIELD_MODELNAME> (model)

In-game representation of the entity to display

m_vecBaseVelocity <FIELD_VECTOR> (basevelocity)

m_vecAngVelocity <FIELD_VECTOR> (avelocity)

m_nWaterLevel <FIELD_CHARACTER> (waterlevel)

m_flGravity <FIELD_FLOAT> (gravity)

m_flFriction <FIELD_FLOAT> (friction)

m_flLocalTime <FIELD_FLOAT> (ltime)

The local time of the entity, independent of the global clock. Used mainly for physics calculations.

m_vecVelocity <FIELD_VECTOR> (velocity)

m_iTextureFrameIndex <FIELD_CHARACTER> (texframeindex)

The initial frame number for all animated textures on this entity.

m_spawnflags <FIELD_INTEGER> (spawnflags)

Toggles exclusive features of an entity, its specific number is determined by the combination of flags added.

m_vecViewOffset <FIELD_VECTOR> (view_ofs)