Npc enemyfinder

From Valve Developer Community

The title given to this article is incorrect due to technical limitations. The correct title is npc_enemyfinder.

Table of contents
1 Entity description
2 Keyvalues
3 Flags
4 Inputs
5 Outputs
[edit]

Entity description

This NPC is invisible, immobile, and does not cause collisions. Its sole purpose is to notify the squad mates whenever an enemy comes into the its view.

Note.png Note: Some keyvalues, flags, inputs, or outputs might not affect an NPC based on the functionality and coding of the NPC.
[edit]

Keyvalues

Defines the name that other entities refer to this entity by.
  • hammerid [New with Orange Box]
<integer readonly> This id is used for debugging purposes in Hammer.
Pitch Yaw Roll (Y Z X)
This entity's angular orientation in the world (also used for angular effect entities).
  • renderfx
<choices>
Literal Value Description
0 Normal
1 Slow Pulse
2 Fast Pulse
3 Slow Wide Pulse
4 Fast Wide Pulse
5 Slow Fade Away
6 Fast Fade Away
7 Slow Become Solid
8 Fast Become Solid
9 Slow Strobe
10 Fast Strobe
11 Faster Strobe
12 Slow Flicker
13 Fast Flicker
14 Constant Glow
15 Distort
16 Hologram (Distort + fade)
17 Scale up
22 Spotlight FX
23 Cull By Distance (TEST)
24 Fade Wider Pulse
  • rendermode
<choices> Used to set a non-standard rendering mode on this entity. See also 'FX Amount' and 'FX Color'.
Literal Value Render Mode Description (Click for more info.)
0 Normal Default rendering.
1 Color Obsolete.
2 Texture Plain opacity.
3 Glow No Z buffer checks. Fixed size on screen.
4 Solid / Alphatest Obsolete. (Use alphatest capabilities in materials instead.)
5 Additive Obsolete. Add this entity's color to what's behind it.
7 Additive Fractional Frame Obsolete? Blend between animation frames.
8 Alpha Add (Not in FGD.) Add alpha.
9 World Space Glow No Z buffer checks. Fixed size in world (as opposed to on screen).
10 Dont Render / None Don't render.
  • renderamt
<integer> FX Amount (0 - 255) - How opaque the entity will be rendered. (0 is fully transparent, while 255 is fully opaque). Will not work if the rendermode keyvalue is set to Normal or Dont Render.
  • rendercolor
<color255> FX Color - What color the entity will be rendered in (to the degree of the opacity set with renderamt).
  • disablereceiveshadows
<boolean> Disable Recieving Shadows
Name of the filter_damage_type entity that controls which entities can damage us.
<string> Response system context(s) for this entity. Format should be: 'key:value,key2:value2,etc'. When this entity speaks, the list of keys and values will be passed to the response rules system.
  • disableshadows
<boolean> Used to disable dynamic shadow casting from this entity.
  • target
<target_destination> If set, the name of a path corner entity that this NPC will walk to, after spawning.
<string> NPCs that are in the same squad (i.e. have matching squad names) will share information about enemies, and will take turns attacking and covering each other.
<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.
<boolean> Limits NPC to using specified hint group for navigation requests, but does not limit local navigation.
  • sleepstate
<choices> Holds the NPC in stasis until specified condition. See also 'Wake Radius' and 'Wake Squad'.
Literal valueDescription
0 None
1 Waiting for threat
2 Waiting for PVS
3 Waiting for input, ignore PVS
4 [New with Episode One] Auto PVS [New with Episode One]
5 [New with Episode One] Auto PVS after PVS [New with Episode One]
  • wakeradius
<float> Auto-wake if player within this distance
<boolean> Wake all of the NPCs squadmates if the NPC is woken
  • physdamagescale
<float> Scales damage energy when this character is hit by a physics object. With a value of 0 the NPC will take no damage from physics.
Specifies the targetname of this entity's Parent in a movement hierarchy. Child entities mimic the movements of their Parent.
  • FieldOfView
<string> How far to look (1.0 = straight ahead, 0.0 = +/- 90 degrees, -1.0 = all directions)
  • MinSearchDist
<integer>
  • MaxSearchDist
<integer>
  • freepass_timetotrigger
<float> Amount of time an enemy is hidden after which a 'free pass' on reaquire is granted
  • freepass_duration
<float> After granted 'free pass', the amount of time a target is allowed before reaquire
  • freepass_movetolerance
<float> After granted 'free pass', the distance the target is allowed to move before reaquire
  • freepass_refillrate
<float> After free pass begins expiring, how much the time the target gets back for every second they hide again
  • freepass_peektime
<float> How long targets in cover are allowed to peek without penalty
  • StartOn
<boolean>
[edit]

Flags

  • 1 : Wait Till Seen
  • 2 : Gag
No IDLE sounds until angry
  • 4 : Fall to ground
Unchecked means *teleport* to ground
  • 8 : Drop Healthkit
  • 16 : Efficient - Don't acquire enemies or avoid obstacles
  • 128 : Wait For Script
  • 256 : Long Visibility/Shoot
  • 512 : Fade Corpse
  • 1024 : Think outside PVS
  • 2048 : Template NPC
This entity is a template for the npc_template_maker. It will not spawn automatically upon map spawn - only spawned on cue through that entity. (It can not be spawned through a point_template.)
  • 4096 : Do Alternate collision for this NPC (player avoidance)
  • 8192 : Don't drop weapons
  • 16384 : Ignore player push [New with Episode One]
Dont give way to player
[edit]

Inputs

  • Kill
Removes this entity from the world.
Removes this entity and all its children from the world.
  • AddOutput <string>
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>
Causes this entity's OnUser1-4 outputs to be fired. See User Inputs and Outputs.
Set the rendercolor.
Set the renderamt.
  • SetDamageFilter <target_destination>
Sets the entity to use as damage filter. Pass in an empty string to clear the damage filter.
Adds a context to this entity's list of response contexts. The format should be 'key:value'.
Remove a context from this entity's list of response contexts. The name should match the 'key' of a previously added context.
Removes all contexts in this entity's list of response contexts.
  • DisableShadow
Turn shadow off.
  • EnableShadow
Turn shadow on.
  • SetRelationship <string>
Changes this entity's relationship toward another entity or class. (Used like the ai_relationship entity, with this NPC as the subject.)
Format: <target> <disposition> <rank>
<disposition> values:
Literal Value Description
D_HT Hate
D_FR Fear
D_LI Like
D_NU Neutral
  • SetHealth <integer>
Set this NPC's health.
  • AddHealth <integer> [New with Orange Box]
Add to NPC's health.
  • RemoveHealth <integer> [New with Orange Box]
Remove fromNPC's health.
  • SetBodyGroup <integer>
HACK: Sets this NPC's body group (from 0 - n). You'd better know what you are doing!
  • physdamagescale <float>
Sets the value that scales damage energy when this character is hit by a physics object.
Note.png Note: 0 means this feature is disabled for backwards compatibility.
  • Ignite
Ignite, burst into flames
  • IgniteLifetime [New with Orange Box]
  • IgniteNumHitboxFires [New with Orange Box]
  • IgniteHitboxFireScale [New with Orange Box]
  • Break
Break, smash into pieces
  • StartScripting
Enter scripting state. In this state, NPCs ignore a variety of stimulus that would make them break out of their scripts: They ignore danger sounds, ignore +USE, don't idle speak or respond to other NPC's idle speech, and so on.
  • StopScripting
Exit scripting state.
Start an assault. Parameter passed in should be the name of the rally point.
Set the name of this NPC's squad. It will be removed from any existing squad automatically. Leaving the parameter blank will remove the NPC from any existing squad.
  • Wake
Wakes up the NPC if it is sleeping.
  • ForgetEntity <target_destination>
Clears out the NPC's knowledge of a named entity.
  • GagEnable
Turn on the NPC Gag flag. NPC won't speak outside of choreographed scenes.
  • GagDisable
Turn off the NPC Gag flag.
  • IgnoreDangerSounds <float>
Ignore danger sounds for the specified number of seconds.
  • HolsterWeapon [New with Episode One]
Force the NPC to holster their weapon. Ignored if the NPC is scripting, if the NPC's weapon is already holstered, or if the NPC doesn't use weapons.
  • HolsterAndDestroyWeapon [New with Episode One]
Identical to HolsterWeapon, except the weapon is destroyed once it has been holstered and concealed.
  • UnholsterWeapon [New with Episode One]
Force the NPC to draw their weapon. Ignored if the NPC is scripting, if the NPC's weapon is already drawn, or if the NPC doesn't use weapons.
  • ForceInteractionWithNPC <string> [New with Episode One]
Force the NPC to use a dynamic interaction with another NPC.
Parameter format: <target NPC name> <dynamic interaction name>
  • UpdateEnemyMemory <target_destination> [New with Episode One]
Update (or Create) this NPC's memory of an enemy and its location
  • BecomeRagdoll [New with Orange Box]
Changes the entity's parent in the movement hierarchy.
Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the Parent's Origin and Angles at the time it is attached.
Removes this entity from its current movement hierarchy.
  • TurnOn
Turn on: Look for enemies
  • TurnOff
Turn off: Stop looking for enemies
[edit]

Outputs

  • OnDamaged
Fired when this NPC takes damage.
!activator = damage inflictor
  • OnDeath
Fired when this NPC is killed.
!activator = killer
  • OnHalfHealth
Fired when this NPC reaches half of its maximum health.
  • OnHearWorld
Fired when this NPC hears a sound (other than combat or the player).
  • OnHearPlayer
Fired when this NPC hears the player.
  • OnHearCombat
Fired when this NPC hears combat sounds.
Fired when this NPC establishes line of sight to its enemy (outputs entity).
  • OnLostEnemyLOS
Fired when this NPC loses line of sight to its enemy.
  • OnLostEnemy
Fired when this NPC loses its enemy. Usually due to the enemy being killed/removed, or because this NPC has selected a newer, more dangerous enemy.
Fired when this NPC establishes line of sight to its enemy, and that enemy is a player (outputs player entity).
  • OnLostPlayerLOS
Fired when this NPC loses line of sight to its enemy, and that enemy is a player.
  • OnLostPlayer
Fired when this NPC loses its enemy, and that enemy was a player. Usually due to the enemy being killed/removed, or because this NPC has selected a newer, more dangerous enemy.
  • OnDamagedByPlayer
Fired when this NPC is hurt by a player.
!activator = attacker or vehicle driver (if friendly fire)
  • OnDamagedByPlayerSquad
Fired when this NPC is hurt by a player OR by one of the player's squadmates.
!activator = attacker or vehicle driver (if friendly fire)
  • OnDenyCommanderUse
Fired when this NPC has refused to join the player's squad.
  • OnWake
Fired when this NPC comes out of a sleep state.
  • OnLostEnemies [New with Episode One]
Fires when the enemy finder has no enemies.
  • OnAcquireEnemies [New with Episode One]
Fires when the enemy finder acquires enemies.
Retrieved from "http://developer.valvesoftware.com/wiki/Npc_enemyfinder"