npc_sniper

From Valve Developer Community
Jump to: navigation, search
Русский
Sniper

<Half-Life 2> npc_sniper is a point entity available in the Half-Life 2 series. This Combine soldier is wielding a sniping weapon with a blue laser sight, making it capable of extreme accuracy at extreme range.

The npc_sniper does not actually have its own model - rather, it uses a Combine soldier model in-game (if its Hidden flag is not set) playing its idle animation, with the rifle's laser coming from the center of the hull. Only explosions and burning damage can hurt the sniper.

The sniper doesn't turn on his sight until after he sees the player or an NPC within an acceptable range and angle, and will turn it off again after he is done. He will prioritize the player over any other target. If he loses track of the player, he will get frustrated and shoot three rounds at the area where the player was last seen, often targeting smaller prop_physics (like soda cans, melons, melon chunks, cinderblocks, ...) but not large prop_physics (like soda machines). He will then resume to targeting any other visible targets.

Note:Some keyvalues, flags, inputs, or outputs might not affect an NPC based on the functionality and coding of the NPC.
Tip:The sniper will pay attention to info_snipertargets if ordered to (with the SweepTarget, SweepTargetHighestPriority or SweepGroupRandomly inputs).

Keyvalues

BaseNPC:

Relationship <string> !FGD
<string|targetname or classname> <string|disposition> <int|rank>

Changes whether this NPC likes or dislikes certain others. Used like the ai_relationship entity, with this NPC as the subject. This keyvalue is not included in Valve's FGDs.

Values for disposition are:
  • D_HT: Hate
  • D_FR: Fear
  • D_LI: Like
  • D_NU: Neutral
Target Path Corner <targetname>
The path_corner that this NPC will move to after spawning.
Squad Name <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.
Hint Group <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 <boolean>
Limits NPC to using specified hint group for navigation requests, but does not limit local navigation.
Sleep State <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
Wake Radius <float>
Auto-wake if player within this distance
Wake Squad <boolean>
Wake all of the NPCs squadmates if the NPC is woken
Enemy Filter <targetname>
Filter entity to test targets against
Ignore unseen enemies <boolean>
Prefer visible enemies, regardless of distance or relationship priority
Physics Impact Damage Scale <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.

DamageFilter:

Damage Filter <targetname>
Name of the filter_damage_type entity that controls which entities can damage us.

ResponseContext:

Response Contexts <string>
Pre-defined response system contexts for this entity. Format is key:value,key:value,...

Shadow:

Disable shadows <boolean>
Prevent the entity from creating cheap render-to-texture shadows. Does not affect shadow mapping.
Disable ShadowDepth <boolean> (New with Portal 2)
Used to disable rendering into shadow depth (for projected textures) for this entity.
Projected Texture Cache <choices> (New with Portal 2)
Used to hint projected texture system whether it is sufficient to cache shadow volume of this entity or to force render it every frame instead.
  • 0 : Default
  • 1 : No cache - render every frame
  • 2 : Cache it - render only once
Disable flashlight <boolean> (New with Portal 2)
Used to disable projected texture lighting and shadows on this entity.

RenderFields:

Render Mode <choices>
Set a non-standard rendering mode on this entity. See Render Modes for details.
FX Amount (0 - 255) <int>
Intensity of the selected render mode.
FX Color (R G B) <color255>
Color used by the selected render mode (if applicable).
Disable Receiving Shadows <bool>
Prevents the entity from receiving shadows.

RenderFXChoices:

Render FX <choices>
Several GoldSrc-era visibility modes which change the way the entity is rendered, typically by fading it in and out.

Angles:

Pitch Yaw Roll (Y Z X) <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.

Targetname:

Name <string>
The targetname that other entities refer to this entity by.
Entity Scripts <scriptlist> (New with Left 4 Dead 2)
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.
Script think function <string> (New with Left 4 Dead 2)
Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.
Note:Try to avoid expensive operations in this function, as it may cause performance problems.
Patience Radius <integer>
Sniper will hold fire until the target is within this radius. After that, sniper will always attack, even if the target retreats outside of this radius.
Initial Misses <integer>
How many times to miss a target on purpose before beginning to fire accurately.
Beam Brightness (0 to 255) <integer>
How bright the laser sight beam should be. (0 - 255)
Shoot zombies in chest <boolean>
If true, aim for chest instead of headcrab. Useful when at great distance and height.
Bullet shield distance. <float>
!OBSOLETE
Bullet shield radius <float>
!OBSOLETE
Paint interval <integer>
Sniper will keep a target painted for this many seconds before shooting. 'Faster Shooting' sniper flag multiplies this by 0.75.
Paint interval variance <integer>
When shooting at NPCs, a random number between 0 and this is added to PaintInterval for every shot.

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 and cannot be used with point_template.
  • 4096 : Do Alternate collision for this NPC (player avoidance)
    Note:This flag is disabled in episodic for player companions because the start scripting input does this.
  • 8192 : Don't drop weapons
  • 16384 : Ignore player push : Dont give way to player
  • 65536 : Hidden
The sniper will not have a model while alive. Should be checked.
  • 131072 : Laser Viewcone
  • 262144 : No Corpse
The sniper leaves no corpse.
  • 524288 : Start Disabled
  • 1048576 : Faster shooting

Inputs

BaseNPC:

SetRelationship <string|targetname or classname> <string|disposition> <int|rank>
Changes whether this NPC likes or dislikes certain others. 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
SetHealth <int>
Set the NPC's health.
AddHealth <int> (New with Source 2007)
RemoveHealth <int> (New with Source 2007)
Add to or remove from the NPC's health.
SetBodyGroup  <integer>
HACK: Sets this NPC's body group (from 0 - n).
physdamagescale  <float>
Scales the damage taken when this character is hit by a physics object. 0 means this feature is disabled for backwards compatibility.
Ignite
Burst into flames.
IgniteLifetime  <float>
Ignite for the given number of seconds.
IgniteNumHitboxFires  <integer>
Ignite with the given number of hitbox fires.
IgniteHitboxFireScale  <float>
Ignite with the given hitbox fire scale.
Break
Smash into pieces. If this is not possible, disappear.
BecomeRagdoll (New with Source 2007)
Remove itself and instantly become a ragdoll with zero force (just go limp). OnDeath, etc. Outputs will NOT be fired.
StartScripting
StopScripting
Enter/exit scripting state, where 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.
Assault  <targetname>
Start an assault at the given rally point.
SetSquad  <string>
Change the name of this NPC's squad. Leaving the parameter blank will remove the NPC from any existing squad.
Wake
Wakes up the NPC if it is sleeping.
ForgetEntity  <targetname>
Clears out the NPC's knowledge of a named entity.
GagEnable
GagDisable
Gagged NPCs won't speak (or moan, caw, etc.) unless made to be a choreographed scene.
IgnoreDangerSounds  <float>
Ignore danger sounds for the specified number of seconds.
HolsterWeapon
UnholsterWeapon
Force the NPC to holster or unholster their weapon. Ignored if the NPC is scripting or if the NPC doesn't use weapons.
HolsterAndDestroyWeapon
As HolsterWeapon, except the weapon is destroyed once it has been concealed.
ForceInteractionWithNPC <string>  <string>
Force the NPC to use a dynamic interaction with another NPC. Syntax is <targetname> <dynamic interaction>.
UpdateEnemyMemory
Update (or create) this NPC's memory of of the given entity.

RenderFields:

Alpha  <integer>
Set the sprite's alpha (0 - 255).
Color  <color255>
Set the sprite's color (R G B).

DamageFilter:

SetDamageFilter  <string>
Sets the entity to use as damage filter. Pass in an empty string ("") to clear the damage filter.

ResponseContext:

AddContext <string>
Adds to the entity's list of response contexts. Format is <key>:<value>.
RemoveContext <string>
Remove a context from this entity's list. The name should match the key of an existing context.
ClearContext
Removes all contexts from this entity's list.

Shadow:

DisableShadow
Turn shadow off.
EnableShadow
Turn shadow on.
DisableReceivingFlashlight  (New with Portal 2)
This object will not receive light or shadows from projected textures.
EnableReceivingFlashlight  (New with Portal 2)
This object may receive light or shadows from projected textures.

Targetname:

Kill
Removes this entity from the world.
KillHierarchy
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 means infinite>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
Use  !FGD
Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
RunScriptFile  <script> (New with Left 4 Dead 2)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode  <string> (New with Left 4 Dead 2)
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.
Bug:
In <Left 4 Dead 2>, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning:Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction  <string> (New with Left 4 Dead 2) !FGD
Execute a VScript function in the scope of the receiving entity.
Note:This input is missing from some games FGD files.
SetLocalOrigin  <origin> (New with Alien Swarm) !FGD
Set this entity's origin in the map.
Note:This input is missing from some games FGD files.
SetLocalAngles  <angles> (New with Alien Swarm) !FGD
Set this entity's angles in the map.
Note:This input is missing from some games FGD files.
EnableSniper
Enable Shooting.
DisableSniper
Disable Shooting.
SetDecoyRadius  <integer>
Set Decoy Radius.
SweepTarget  <targetname>
Makes the sniper sweep to an info_snipertarget specified in the parameter, with a behavior specified in the properties of the info_snipertarget.
Note:Using this input to set the sniper's target to anything enclosed or touching a Block LOS textured brush may cause the map to crash.
SweepTargetHighestPriority  <targetname>
Same as SweepTarget, but the sniper will prioritize sweeping to this target above targeting anything else, including the player.
SweepGroupRandomly  <string>
The sniper will take alternating shots at info_snipertargets belonging to a specific group (specified in its parameter) until interrupted by an NPC. (Group associations are declared in the Group Name property of these targets.)
StopSweeping
Stop any target sweeping operation started by entity I/O
ProtectTarget  <targetname>
Protect the specified target. The sniper will attempt to shoot the enemy nearest the protect target at all times.

Outputs

BaseNPC:

OnDamaged
Fired when this NPC takes damage (activator is the damage inflictor)
OnDeath
Fired when this NPC is killed (activator is the 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
OnFoundEnemy  <targetname>
Fired when this NPC establishes line of sight to its enemy
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
OnFoundPlayer  <targetname>
Fired when this NPC establishes line of sight to its enemy, and that enemy is a player
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 is the 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 is the attacker or vehicle driver (if friendly fire))
OnDenyCommanderUse
Fired when this NPC has refused to join the player's squad
OnSleep
Fired when this NPC enters a sleep state
OnWake
Fired when this NPC comes out of a sleep state
OnForcedInteractionStarted
Fired when the NPC starts a forced interaction.
OnForcedInteractionAborted
Fired when the NPC aborts a forced interaction for some reason (target NPC died, couldn't be pathed to, etc)
OnForcedInteractionFinished
"NPCs in actbusies can no longer perform dynamic interactions." To do: What does this mean?

Targetname:

OnUser1 to OnUser4
These Outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.
OnKilled  

(New with Left 4 Dead)

This Output fires when the entity is killed and removed from the game.
OnShotFired
Sniper's current enemy.

See also