Template:KV BaseTank: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Added descriptions for all these. Not difficult to do.)
(reworded the description for both "Param" lines, mentioning how if not set, it would rotate the brush around the brush entity origin instead. Also added note to "Rotate Loop Sound" about endlessly playing sounds)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{ScrollBox|title=BaseTank|
{{ {{PAGENAME}} |startcollapsed=0}}
{{KV|Control Volume|target_destination|Name of a trigger the player must be inside to control the tank.}}
 
{{KV|(Team) Master|string|(Team) Master}}
<includeonly>
{{KV|Yaw rate|string|How fast tank can look left or right.}}
 
{{KV|Yaw range|string|How far tank can turn left or right.}}
<onlyinclude>{{Expand|title=BaseTank keyvalues|startcollapsed={{{startcollapsed|1}}}|
{{KV|Yaw tolerance|string|Additional left-right range. If the gun tries to turn beyond '''Yaw range + Yaw tolerance''', the gun will snap back to the maximum '''Yaw range'''.}}
{{KV|Bullets|intn=bullet|choices|Ammo type. Be aware that some games will use '''Ammo type''' instead.}}
{{KV|Pitch rate|string|How fast tank can look up or down}}
:{{{!}} class{{=}}standard-table
{{KV|Pitch range|string|How far tank can turn up or down}}
! Literal value {{!!}} Description
{{KV|Pitch tolerance|string|Additional up-down range. If the gun tries to turn beyond '''Pitch range + Pitch tolerance''', the gun will snap back to the maximum '''Pitch range'''.}}
{{!}}-
{{KV|Barrel Length|string|Solid length of the tank barrel. Any part of the barrel beyond this length may clip through objects.}}
{{!}} 0 {{!!}} None
{{KV|Barrel Horizontal|string|How wide the barrel is, horizontally.}}}
{{!}}-
{{KV|Barrel Vertical|string|How wide the barrel is, vertically.}}
{{!}} 1 {{!!}} Pistol
{{KV|Smoke Sprite|sprite|Smoke sprite to emit when gun fires. {{bug|Transparency may not work.}}}}
{{!}}-
{{KV|Flash Sprite|sprite|Flash sprite to emit when gun fires.}}
{{!}} 2 {{!!}} SMG1
{{KV|Sprite scale|string|Sprite scale for both sprites above.}}
{{!}}-
{{KV|Rotate Start Sound|sound|Sound to play when tank starts to turn.}}
{{!}} 3 {{!!}} AR2 (shows pistol/smg1 bullets?)
{{KV|Rotate Loop Sound|sound|Sound to play when tank is turning.}}
{{!}}-
{{KV|Rotate Stop Sound|sound|Sound to play when tank stops turning.}}
{{!}} 4 {{!!}} Laser (does nothing)
{{KV|Rate of Fire|string|Number of bullets to fire in a second.}}
{{!}}}
{{KV|Damage Per Bullet|string|How much a single bullet hurts everything except the player. If <code>0</code>, takes amount from the type of bullet/damage.}}
{{KV|Ammo type|intn=ammotype|choices|Ammo type. Be aware that some games will use '''Bullets''' instead.}}
{{KV|Damage Per Bullet Vs Player|string|How much a single bullet hurts the player only. If <code>0</code>, takes amount from the type of bullet/damage.}}
:{{{!}} class{{=}}standard-table
{{KV|Firing persistence|string|How many seconds to keep firing at target's last known position after losing [[LOS]] (for NPCs).}}
! Value {{!!}} Description
{{KV|Firing persistence2|string|After '''Firing persistence''' is over, how many seconds to periodically fire at target's last known position (for NPCs).}}
{{!}}-
{{KV|Bullet accuracy|choices|How accurately the gun can fire.}}
{{!}} <code></code> {{!!}} None
:* 0 : Perfect Shot
{{!}}-
:* 1 : Small cone
{{!}} <code>Pistol</code> {{!!}} Pistol
:* 2 : Medium cone
{{!}}-
:* 3 : Large cone
{{!}} <code>SMG1</code> {{!!}} SMG1
:* 4 : Extra-large cone
{{!}}-
{{KV|Minimum target range|string|Minimum range to target something (for NPCs). If a target is closer than this amount, the NPC will probably switch to any weapon they have on them.}}
{{!}} <code>AR2</code> {{!!}} AR2
{{KV|Maximum target range|string|Maximum range to target something (for NPCs). {{confirm|This may actually be the distance for aim assistance instead?}}}}
{{!}}-
{{KV|Minimum light level|string|Minimum amount of light this entity should receive.}}
{{!}} <code>CombineHeavyCannon</code> {{!!}} Combine Heavy Cannon (Episode 2 autogun)
{{KV|Gun Base Attachment|string|If '''Parent''' is specified, this is the attachment point on the parent to aim from.}}
{{!}}}
{{KV|Gun Barrel Attachment|string|If '''Parent''' is specified, this is the attachment point on the parent to fire from. If you specify this, you'll want to specify the '''Gun Base Attachment''' too.}}
{{KV|Control Volume|intn=control_volume|target_destination|Name of a trigger the player must be inside to control the tank.}}
{{KV|Gun Yaw Pose Param|string|If '''Parent''' and '''Gun Pitch Pose Param''' are specified, then the gun itself will be invisible and the tank will steer a gun on the parent using the pose parameters.}}
{{KV|(Team) Master|intn=master|string|Not used for Source. Provided for backwards compatibility with {{ent|multisource}} or {{ent|game_team_master}}.}}
{{KV|Gun Yaw Pose Center|float|The center yaw pose parameter of the gun on the parent.}}
{{KV|Yaw rate|intn=yawrate|string|How fast tank can look left or right.}}
{{KV|Gun Pitch Pose Param|string|If '''Parent''' and '''Gun Yaw Pose Param''' are specified, then the gun itself will be invisible and the tank will steer a gun on the parent using the pose parameters.}}
{{KV|Yaw range|intn=yawrange|string|How far tank can turn left or right.}}
{{KV|Gun Pitch Pose Center|float|The center pitch pose parameter of the gun on the parent.}}
{{KV|Yaw tolerance|intn=yawtolerance|string|Additional left-right range. If the gun tries to turn beyond '''Yaw range + Yaw tolerance''', the gun will snap back to the maximum '''Yaw range'''.}}
{{KV|Ammunition Count|integer|Amount of ammo when ''player'' is using. -1 {{=}} unlimited ammo.}}
{{KV|Pitch rate|intn=pitchrate|string|How fast tank can look up or down}}
{{KV|Lead Target|boolean|Aim ahead to hit moving targets (for NPCs).}}
{{KV|Pitch range|intn=pitchrange|string|How far tank can turn up or down}}
{{KV|NPC Man Point|target_destination|Point where NPC must stand to use.}}
{{KV|Pitch tolerance|intn=pitchtolerance|string|Additional up-down range. If the gun tries to turn beyond '''Pitch range + Pitch tolerance''', the gun will snap back to the maximum '''Pitch range'''.}}
{{KV|Post-NPC Attack Grace Period|float|If specified, NPC's manning this func tank won't fire at the player, after firing at a non-player, for this amount of time.}}
{{KV|Barrel Length|intn=barrel|string|Solid length of the tank barrel. Any part of the barrel beyond this length may clip through objects.}}
{{KV|Ignore Grace Upto|float|The player grace period is ignored if the player is under this distance from the tank.}}
{{KV|Barrel Horizontal|intn=barrely|string|How wide the barrel is, horizontally.}}}
{{KV|Player Lock Time|float|The tank must be aiming right on the player for this amount of time before it's allowed to fire.}}
{{KV|Barrel Vertical|intn=barrelz|string|How wide the barrel is, vertically.}}
{{KV|Effect Handling|choices|Produce these sound and particle effects when firing.}}
{{KV|Smoke Sprite|intn=spritesmoke|sprite|Smoke sprite to emit when gun fires. {{bug|Transparency may not work.}}}}
:* 0 : Use Individual Settings.
{{KV|Flash Sprite|intn=spriteflash|sprite|Flash sprite to emit when gun fires.}}
:* 1 : AR2
{{KV|Sprite scale|intn=spritescale|string|Sprite scale for both sprites above.}}
:* 2 : Combine Cannon
{{KV|Rotate Start Sound|intn=rotatestartsound|sound|Sound to play when tank starts to turn.}}
{{KV Targetname}}
{{KV|Rotate Loop Sound|intn=rotatesound|sound|Sound to play when tank is turning.{{bug|hidetested=true|If the tank stops being controlled while turning, the sound will continue to loop until the tank is being turned again.}}}}
{{KV Parentname}}
{{KV|Rotate Stop Sound|intn=rotatestopsound|sound|Sound to play when tank stops turning.}}
{{KV Origin}}
{{KV|Rate of Fire|intn=firerate|string|Number of bullets to fire in a second.}}
{{KV Angles}}
{{KV|Damage Per Bullet|intn=bullet_damage|string|How much a single bullet hurts everything except the player. If <code>0</code>, takes amount from the type of bullet/damage.}}
{{KV RenderFields}}
{{KV|Damage Per Bullet Vs Player|intn=bullet_damage_vs_player|string|How much a single bullet hurts the player only. If <code>0</code>, takes amount from the type of bullet/damage.}}
{{KV Global}}
{{KV|Firing persistence|intn=persistence|string|How many seconds to keep firing at target's last known position after losing [[LOS]] (for NPCs).}}
{{KV Shadow}}
{{KV|Firing persistence2|intn=persistence2|string|After '''Firing persistence''' is over, how many seconds to periodically fire at target's last known position (for NPCs).}}
}}<noinclude>
{{KV|Bullet accuracy|intn=firespread|choices|How accurately the gun can fire.
:*0: Perfect Shot
:*1: Small cone
:*2: Medium cone
:*3: Large cone
:*4: Extra-large cone}}
{{KV|Minimum target range|intn=minRange|string|Minimum range to target something (for NPCs). If a target is closer than this amount, the NPC will probably switch to any weapon they have on them.}}
{{KV|Maximum target range|intn=maxRange|string|Maximum range to target something (for NPCs). {{confirm|This may actually be the distance for aim assistance instead?}}}}
{{KV|Gun Base Attachment|intn=gun_base_attach|string|If '''Parent''' is specified, this is the attachment point on the parent to aim from.}}
{{KV|Gun Barrel Attachment|intn=gun_barrel_attach|string|If '''Parent''' is specified, this is the attachment point on the parent to fire from. If you specify this, you'll want to specify the '''Gun Base Attachment''' too.}}
{{KV|Gun Yaw Pose Param|intn=gun_yaw_pose_param|string|If '''Parent''' and '''Gun Pitch Pose Param''' are specified, then the gun itself will be invisible and the tank will use the pose parameters on the parent model. If not set, the gun brush rotates around the entity origin.}}
{{KV|Gun Yaw Pose Center|intn=gun_yaw_pose_center|float|The center yaw pose parameter of the gun on the parent.}}
{{KV|Gun Pitch Pose Param|intn=gun_pitch_pose_param|string|If '''Parent''' and '''Gun Yaw Pose Param''' are specified, then the gun itself will be invisible and the tank will use the pose parameters on the parent model. If not set, the gun brush rotates around the entity origin.}}
{{KV|Gun Pitch Pose Center|intn=gun_pitch_pose_center|float|The center pitch pose parameter of the gun on the parent.}}
{{KV|Ammunition Count|intn=ammo_count|integer|Amount of ammo when ''player'' is using. -1 {{=}} unlimited ammo.}}
{{KV|Lead Target|intn=LeadTarget|boolean|Aim ahead to hit moving targets (for NPCs).}}
{{KV|NPC Man Point|intn=npc_man_point|target_destination|Point where NPC must stand to use.}}
{{KV|Post-NPC Attack Grace Period|intn=playergraceperiod|float|If specified, NPC's manning this func tank won't fire at the player, after firing at a non-player, for this amount of time.}}
{{KV|Ignore Grace Upto|intn=ignoregraceupto|float|The player grace period is ignored if the player is under this distance from the tank.}}
{{KV|Player Lock Time|intn=playerlocktimebeforefire|float|The tank must be aiming right on the player for this amount of time before it's allowed to fire.}}
{{KV|Effect Handling|intn=effecthandling|choices|Produce these sound and particle effects when firing.
:*0: Use Individual Settings.
:*1: AR2
:*2: Combine Cannon}}
}}</onlyinclude>
 
</includeonly>
 
[[Category:Keyvalue Templates|BaseTank]]
[[Category:Keyvalue Templates|BaseTank]]
</noinclude>

Latest revision as of 07:34, 8 February 2025

BaseTank keyvalues
Bullets (bullet) <choices>
Ammo type. Be aware that some games will use Ammo type instead.
Literal value Description
0 None
1 Pistol
2 SMG1
3 AR2 (shows pistol/smg1 bullets?)
4 Laser (does nothing)
Ammo type (ammotype) <choices>
Ammo type. Be aware that some games will use Bullets instead.
Value Description
None
Pistol Pistol
SMG1 SMG1
AR2 AR2
CombineHeavyCannon Combine Heavy Cannon (Episode 2 autogun)
Control Volume (control_volume) <targetname>
Name of a trigger the player must be inside to control the tank.
(Team) Master (master) <string>
Not used for Source. Provided for backwards compatibility with multisource or game_team_master.
Yaw rate (yawrate) <string>
How fast tank can look left or right.
Yaw range (yawrange) <string>
How far tank can turn left or right.
Yaw tolerance (yawtolerance) <string>
Additional left-right range. If the gun tries to turn beyond Yaw range + Yaw tolerance, the gun will snap back to the maximum Yaw range.
Pitch rate (pitchrate) <string>
How fast tank can look up or down
Pitch range (pitchrange) <string>
How far tank can turn up or down
Pitch tolerance (pitchtolerance) <string>
Additional up-down range. If the gun tries to turn beyond Pitch range + Pitch tolerance, the gun will snap back to the maximum Pitch range.
Barrel Length (barrel) <string>
Solid length of the tank barrel. Any part of the barrel beyond this length may clip through objects.
Barrel Horizontal (barrely) <string>
How wide the barrel is, horizontally.}
Barrel Vertical (barrelz) <string>
How wide the barrel is, vertically.
Smoke Sprite (spritesmoke) <sprite>
Smoke sprite to emit when gun fires.
Icon-Bug.pngBug:Transparency may not work.  [todo tested in ?]
Flash Sprite (spriteflash) <sprite>
Flash sprite to emit when gun fires.
Sprite scale (spritescale) <string>
Sprite scale for both sprites above.
Rotate Start Sound (rotatestartsound) <sound>
Sound to play when tank starts to turn.
Rotate Loop Sound (rotatesound) <sound>
Sound to play when tank is turning.
Icon-Bug.pngBug:If the tank stops being controlled while turning, the sound will continue to loop until the tank is being turned again.
Rotate Stop Sound (rotatestopsound) <sound>
Sound to play when tank stops turning.
Rate of Fire (firerate) <string>
Number of bullets to fire in a second.
Damage Per Bullet (bullet_damage) <string>
How much a single bullet hurts everything except the player. If 0, takes amount from the type of bullet/damage.
Damage Per Bullet Vs Player (bullet_damage_vs_player) <string>
How much a single bullet hurts the player only. If 0, takes amount from the type of bullet/damage.
Firing persistence (persistence) <string>
How many seconds to keep firing at target's last known position after losing LOS (for NPCs).
Firing persistence2 (persistence2) <string>
After Firing persistence is over, how many seconds to periodically fire at target's last known position (for NPCs).
Bullet accuracy (firespread) <choices>
How accurately the gun can fire.
  • 0: Perfect Shot
  • 1: Small cone
  • 2: Medium cone
  • 3: Large cone
  • 4: Extra-large cone
Minimum target range (minRange) <string>
Minimum range to target something (for NPCs). If a target is closer than this amount, the NPC will probably switch to any weapon they have on them.
Maximum target range (maxRange) <string>
Maximum range to target something (for NPCs).
Confirm:This may actually be the distance for aim assistance instead?
Gun Base Attachment (gun_base_attach) <string>
If Parent is specified, this is the attachment point on the parent to aim from.
Gun Barrel Attachment (gun_barrel_attach) <string>
If Parent is specified, this is the attachment point on the parent to fire from. If you specify this, you'll want to specify the Gun Base Attachment too.
Gun Yaw Pose Param (gun_yaw_pose_param) <string>
If Parent and Gun Pitch Pose Param are specified, then the gun itself will be invisible and the tank will use the pose parameters on the parent model. If not set, the gun brush rotates around the entity origin.
Gun Yaw Pose Center (gun_yaw_pose_center) <float>
The center yaw pose parameter of the gun on the parent.
Gun Pitch Pose Param (gun_pitch_pose_param) <string>
If Parent and Gun Yaw Pose Param are specified, then the gun itself will be invisible and the tank will use the pose parameters on the parent model. If not set, the gun brush rotates around the entity origin.
Gun Pitch Pose Center (gun_pitch_pose_center) <float>
The center pitch pose parameter of the gun on the parent.
Ammunition Count (ammo_count) <integer>
Amount of ammo when player is using. -1 = unlimited ammo.
Lead Target (LeadTarget) <boolean>
Aim ahead to hit moving targets (for NPCs).
NPC Man Point (npc_man_point) <targetname>
Point where NPC must stand to use.
Post-NPC Attack Grace Period (playergraceperiod) <float>
If specified, NPC's manning this func tank won't fire at the player, after firing at a non-player, for this amount of time.
Ignore Grace Upto (ignoregraceupto) <float>
The player grace period is ignored if the player is under this distance from the tank.
Player Lock Time (playerlocktimebeforefire) <float>
The tank must be aiming right on the player for this amount of time before it's allowed to fire.
Effect Handling (effecthandling) <choices>
Produce these sound and particle effects when firing.
  • 0: Use Individual Settings.
  • 1: AR2
  • 2: Combine Cannon