Template:KV CAI BaseNPC

From Valve Developer Community
Revision as of 12:49, 4 September 2018 by Pinsplash (talk | contribs) (BaseCombatCharacters can have relationships as well)
Jump to navigation Jump to search

This template is our holder for all keyvalues that are assigned through CAI_BaseNPC.

Add |as=1 for entities that include the new Alien Swarm keyvalues (HullType and BloodColor).

Add |addeq=[text here] to (optionally) write a custom description for the Weapon Held keyvalue.

For full documentation on this family of templates, see FGD Template Prototype. Still confused on something? Ask for help before editing this template.

Note.pngNote:Some CBaseEntity keyvalues are listed here. See the talk page.


Weapon Held (additionalequipment) ([todo internal name (i)]) <classname>
Gives the NPC a weapon. NPCs may attack oddly or not attack if they don't know how to use a particular weapon.
Health (health) ([todo internal name (i)]) <integer>
How close to death the NPC is.
Maximum Health (max_health) ([todo internal name (i)]) <integer>
Health cannot exceed this amount.
Squad Name (squadname) ([todo internal name (i)]) <string>
NPCs that are in the same squad will share information about enemies, and will take turns attacking and covering each other.
Relationship (Relationship) ([todo internal name (i)]) <string> !FGD
<string|targetname or classname> <string|disposition> <int|rank>
Changes whether this NPC likes or dislikes certain other things. Used like the ai_relationship entity, with this NPC as the subject.
Values for disposition are:
  • D_HT: Hate
  • D_FR: Fear
  • D_LI: Like
  • D_NU: Neutral
Target Path Corner (target) ([todo internal name (i)]) <targetname>
If set, the name of a path_corner entity that this NPC will move to, after spawning. Must be within 576 units from the NPC.
Sleep State (sleepstate) ([todo internal name (i)]) <choices>
Holds the NPC in stasis until specified condition. See also Wake Radius and Wake Squad.
  • 0: None
  • 1: Waiting for threat
  • 2: Waiting for PVS
  • 3: Waiting for input, ignore PVS
  • 4: Auto PVS
  • 5: Auto PVS after PVS
Todo: clarify the differences between each
Wake Radius (wakeradius) ([todo internal name (i)]) <float>
Auto-wake if player is within this distance, in Hammer units.
Wake Squad (wakesquad) ([todo internal name (i)]) <boolean>
If yes, wake all of the NPCs squadmates if the NPC is woken.
Ignore unseen enemies (ignoreunseenenemies) ([todo internal name (i)]) <choices>
Prefer visible enemies, regardless of distance or relationship priority.
Hint Group (hintgroup) ([todo internal name (i)]) <string>
Hint groups are used by NPCs to restrict their hint-node searching to a subset of the map's hint nodes. Only hint nodes with matching hint group names will be considered by this NPC.
Hint Limit Nav (hintlimiting) ([todo internal name (i)]) <boolean>
If yes, limits NPC to using specified hint group for navigation requests, but does not limit local navigation.
Enemy Filter (enemyfilter) ([todo internal name (i)]) <targetname>
Filter by which to filter potential enemies.
Physics Impact Damage Scale (physdamagescale) ([todo internal name (i)]) <float>
Multiplier for damage amount when this NPC is hit by a physics object. With a value of 0 the NPC will take no damage from physics.
Local Velocity (velocity) ([todo internal name (i)]) <vector> !FGD
Velocity generated by the entity, can cause strange behavior if changed.
Base Velocity (basevelocity) ([todo internal name (i)]) <vector> !FGD
Velocity to start with on spawn.
Angular Velocity (avelocity) ([todo internal name (i)]) <vector> !FGD
Angular velocity to start with on spawn.
Water Level (waterlevel) ([todo internal name (i)]) <character> !FGD
Current water level of the entity, can cause strange behavior if changed.


Hull Type (HullType) ([todo internal name (i)]) <integer> (in all games since Alien Swarm) !FGD
Physical size of the NPC. Affects navigation capabilities and the bounding box.
  • HUMAN_HULL: Human
  • WIDE_HUMAN_HULL: Wide
  • TINY_HULL: Tiny
  • MEDIUM_HULL: Medium
  • LARGE_HULL: Large
Confirm:Works? This keyvalue is defined as using integers
Blood Color (BloodColor) ([todo internal name (i)]) <integer> (in all games since Alien Swarm) !FGD
Blood color of the NPC when shot.
Confirm:Works? This keyvalue is defined as using integers