npc_combinedropship

From Valve Developer Community
Jump to: navigation, search
Русский
Combine Dropship - click to enlarge.

<Half-Life 2> npc_combinedropship is a point entity available in the Half-Life 2 series.

The dropship is capable of carrying a container which can deploy NPCs, as well as many other objects. It has special commands specifically for Striders and APCs.

Tip:A dropship's landing point doesn't have to be close to its last path_track. The dropship will b-line to the landing point, adjusting for landing along the way.
Bug: In any engine after the Orange Box, the dropship's container gun no longer rotates. There are ways to hack the original functionality with a func_tank, but this does not perfectly emulate the original behavior. This should be accounted for in level design to prevent spawn camping.
Note:Some keyvalues, flags, inputs, or outputs might not affect an NPC, based on the functionality and coding of the NPC.

Dedicated Console Variables

g_debug_dropship <choices>
Draws boxes for debugging certain events.
  • 0: Disabled
  • 1: Takeoff?
  • 2: Landing?
sk_dropship_container_health <int>
Health of the dropship's container. It explodes when it drops to 0
sk_npc_dmg_dropship <int>
Dropship container cannon damage.

Keyvalues

BaseHelicopter:

Initial Speed <string>
The speed that the entity should try to reach as soon as it spawns.
Target path_track <targetname>
The name of a path_track that this NPC will fly to after spawning.

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 (rendermode) <choices>
Set a non-standard rendering mode on this entity.
Render FX / Transparency (0 - 255) (renderamt) <integer>
Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.
Render Color (R G B) (rendercolor) <color255>
Color tint.
Disable Receiving Shadows (disablereceiveshadows) <boolean>
Prevent the entity from receiving shadows on itself.

RenderFXChoices:

Render FX (renderfx) <choices>
Preset pattern of appearance effects.
To do: 18-21, 25

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.
LandTarget <targetname>
Land target name.
GunRange <float>
If the dropship's carrying a crate with a gun on it, it'll only shoot targets within this range.
NPCTemplate <targetname>
Name of Template NPC 1.
NPCTemplate (2-6) <targetname>
Name of Template NPC (2-6).
Dustoff(1-6) <targetname>
Name of dustoff point for NPC (1-6).
APCVehicleName <targetname>
Name of the APC to drop.
Invulnerable <boolean>
Sets if the entity can be destroyed.
CrateType <choices>
Sets the vehicle/crate type and its contains.
Literal Value Description
-3 Jeep (No crate)
-2 APC (No crate)
-1 Strider (No crate)
0 Roller Hopper
1 Soldier Crate
2 None
Rollermine Template <targetname>
If this dropship drops any rollermines due to the 'DropMines' input being fired, it will use this template for the rollermines it creates. If left blank, ordinary rollermines will be dropped.

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
  • 32 : No Rotorwash
  • 64 : Await Input
  • 128 : Wait For Script
  • 256 : Long Visibility/Shoot
  • 512 : Fade Corpse
  • 1024 : Think outside PVS
  • 2048 : Template NPC (used by npc_maker, will not spawn)
  • 4096 : Do Alternate collision for this NPC (player avoidance)
  • 8192 : Don't drop weapons
  • 32768 : Wait for input before dropoff

Inputs

BaseHelicopter:

; MoveTopSpeed
The helicopter will immediately move at top speed toward its current goal, or in its current orientation if it's on top of its goal.
ChangePathCorner <targetname>
Tell the helicopter to move to a path corner on a new path.
SelfDestruct
Self Destruct.
Activate
Activate. Use to wake up a helicopter that spawned with the 'Await Input' spawnflag on.
SetTrack <targetname>
Set a track for the helicopter to adhere to. The helicopter will do nothing if he's on the same path, and will move to the closest point on the specified track if he's on a different path.
FlyToSpecificTrackViaPath <targetname>
The helicopter will first fly to the closest point on the path if he's on a different path. Then he'll fly along the path to the specified track point.
FlyToPathTrack <targetname>
The helicopter will fly to the given path_track.
StartPatrol
Start patrolling back and forth along the current track.
StopPatrol
Stop patrolling back and forth along the track. This will cause the helicopter to come to rest at the track which he's currently flying toward.
ChooseFarthestPathPoint
When tracking an enemy, choose the point on the path furthest from the enemy, but still in firing range.
ChooseNearestPathPoint
When tracking an enemy, choose the point on the path nearest from the enemy.
StartBreakableMovement
The helicopter is now allowed to disobey direct commands to go to particular points if he senses an enemy. He will move to the closest point (or farthest point, if ChooseFarthestPathPoint is used), on the path if he senses an enemy.
StopBreakableMovement
The helicopter can not disobey direct commands. He will continue to fly along his patrol path or to his specified target even if he senses an enemy.

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 (New with Source 2006)
UnholsterWeapon (New with Source 2006)
Force the NPC to holster or unholster their weapon. Ignored if the NPC is scripting or if the NPC doesn't use weapons.
HolsterAndDestroyWeapon (New with Source 2006)
As HolsterWeapon, except the weapon is destroyed once it has been concealed.
ForceInteractionWithNPC <string(New with Source 2006)  <string>
Force the NPC to use a dynamic interaction with another NPC. Syntax is <targetname> <dynamic interaction>.
UpdateEnemyMemory (New with Source 2006)
Update (or create) this NPC's memory of of the given entity.

RenderFields:

Alpha  <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.
Color  <color255>
Sets an RGB color for the entity.

DamageFilter:

SetDamageFilter  <string>
Sets the entity to use as damage filter. Pass in an empty string (no parameter) 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 and any entities parented to it from the world.
KillHierarchy
Functions the same as Kill, although entities with a large number of children are killed marginally faster.
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.
LandLeaveCrate  <integer>
Land, drop soldiers, and leave the crate behind. Specify the number of troops to drop off in the parameter.
LandTakeCrate  <integer>
Land, drop soldiers, but don't leave the crate behind. Specify the number of troops to drop off in the parameter.
DropMines  <integer>
Drop Rollermines. Specify the number of mines to drop in the parameter.
DropStrider
Drop the Strider you're carrying. Now.
DropAPC
Drop the APC you're carrying. Now.
Pickup  <targetname>
Pickup an entity.
Tip:this works best on prop_physics
SetLandTarget  <targetname>
Set my land target name.
SetGunRange  <float>
Set my crate gun's range.
EnableRotorSound
Turns on rotor sounds.
DisableRotorSound
Turns off rotor sounds.
StopWaitingForDropoff
Stop waiting for the dropoff. Dropoff as soon as possible.

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.
OnFinishedDropoff
Fires when the dropship has finished a dropoff.
OnFinishedPickup
Fires when the dropship has finished a pickup.
OnCrateShotDownBeforeDropoff  <float>
Fires when the container was shot down before it dropped off soldiers. The parameter contains the number of soldiers that weren't successfully dropped off.
OnCrateShotDownAfterDropoff  <float>
Fires when the container was shot down after it dropped off soldiers.