func_tankmortar
...
Not to be confused with npc_combine_cannon (An unused Episode Two entity).
func_tankmortar
is a brush entity available in the following Source games or engine branches:
Half-Life 2, Portal, Portal 2, Counter-Strike: Global Offensive and Black Mesa. This is the Suppression Device on top of the Nexus Building from d3_c17_10a
in the chapter "Follow Freeman!" of HL2. The shot will be fired at the exact spot the operator is looking. Note that the operator can potentially be hit by their own shots.
Bug:Mortar damage is hardcoded within Source, and as such cannot be changed via entity parameters.
Note: In Half-Life: Source this entity is very different from other games. On shoot it creates trace line at the end of which forming explosion. Using for some tanks and for guns in c2a5f and c2a5e.
Note: ar2explosion use mortar when it shoot, this entity is not in Black Mesa, that means some effects may missed, also console warn about this.
Contents
Flags
BaseTank:
- 1: Active
- 16: Only Direct: The tank will only fire if it's target is in direct line of sight.
- 32: Controllable (by player)
- 64: Damage Kick
- 1024: NPC Controllable
- 2048: NPC Set Controller
- 4096: Allow friendlies to hit player
- 32768: Non-solid.
- 131072: Perfect accuracy every 3rd shot at player
Keyvalues
- Explosion Magnitude (iMagnitude) <integer>
- Confirm:Does not function?
- Shell travel time (firedelay) <string>
- How long after the turret fires before the shell impacts.
- Firing start sound (firestartsound) <sound>
- Sound when mortar begins firing.
Firing end sound (fireendsound) <sound>- Deprecated. Disabled in code.
- Incoming Shell Sound (incomingsound) <sound>
- Sound of the shell falling on the target.
- Incoming warning time (warningtime) <float>
- How long before the shell impacts to play the warning sound.
- Fire time variance (firevariance) <float>
- Shots will fire between this much sooner and this much later. Must be greater than 0.09 for unknown reasons.
BaseTank:
- 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
orgame_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. Bug:Transparency may not work.
- 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.
- 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 steer a gun on the parent using the pose parameters.
- 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 steer a gun on the parent using the pose parameters.
- 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
Internal keyvalues used by VRAD:
- Minimum Light Level
(_minlight)
<float> - Multiplier of minimum amount of light to hit this brush.
- Shadows
(vrad_brush_cast_shadows)
<choices> - Determines if this entity will cast lightmap shadows.
- 0: No shadows
- 1: Cast shadows
VisibleBrush:
- Render Mode
(rendermode)
<choices> - Set a non-standard rendering mode on this entity.
- Render FX
(renderfx)
<choices> - Various somewhat legacy alpha effects.
Bug:Alpha effects from 0 to 10 are unavailable due to the bug in code in Counter-Strike: Global Offensive
|
- Render FX / Transparency (0–255)
(renderamt)
<integer 0–255> - 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.
- Texture Frame
(texframeindex)
<integer> !FGD - The frame number for any animated textures on this entity.
Shadow:
- Disable Shadows
(disableshadows)
<boolean> - Prevents the entity from creating cheap render-to-texture shadows, or lightmap shadows if the entity is a
prop_static
. Does not affect shadow mapping.
- Disable Receiving Shadows
(disablereceiveshadows)
<boolean> - Prevent the entity from receiving dynamic shadows on itself.
- Shadow Cast Distance
(shadowcastdist)
<integer> !FGD - Sets how far the entity casts dynamic shadows. 0 means default distance from the
shadow_control
entity. - Disable ShadowDepth
(disableshadowdepth)
<boolean> (in all games since ) - Used to disable rendering into shadow depth (for projected textures) for this entity.
- Disable flashlight
(disableflashlight)
<boolean> (in all games since ) - Used to disable projected texture lighting and shadows on this entity.
- Projected Texture Cache
(shadowdepthnocache)
<choices> (in all games since ) - 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.
|
SystemLevelChoice:
- Minimum / Maximum Effect Details Level
(mincpulevel / maxcpulevel)
<choices> (in all games since ) - Don't render for players with Effect Details levels that exceed the minimum or maximum.[Key names are related to
cpu_level
cvar used by Effect Details.]
|
- Minimum / Maximum Shader Details Level
(mingpulevel / maxgpulevel)
<choices> (in all games since ) - Don't render for players with Shader Details levels that exceed the minimum or maximum.[Key names are related to
gpu_level
cvar used by Shader Details.]
|
DXLevelChoice:
- Minimum / Maximum DX Level
(mindxlevel / maxdxlevel)
<choices> (removed since ) - The entity will not exist if the engine is running outside the given range of DirectX Versions.
Warning:If these are used, the object may break when the user switches their DirectX settings.
|
Base:
- Collisions
(solid)
<choices> - Method of collision for this entity.
Values:
- 0: None
- 1: BSP (QPhysics) !FGD Bug:In , if an entity using QPhysics collisions is hit by Gel, the game will crash!
- 2: Bounding Box
- 3: Oriented Bounding Box (Use for runtime spawned brush entities meant to be rotated) !FGD
- 4: Oriented Bounding Box but constrained to Yaw only !FGD
- 5: Custom/Test (Usually no collision with anything) !FGD
- 6: VPhysics
- Parent
(parentname)
<targetname> - Maintain the same initial offset to this entity. An attachment point can also be used if separated by a comma at the end. (
parentname [targetname],[attachment]
)Tip:Entities transition to the next map with their parentsTip:phys_constraint
can be used as a workaround if parenting fails.
- Origin (X Y Z)
(origin)
<coordinates> - The position of this entity's center in the world. Rotating entities typically rotate around their origin.Note:Hammer does not move the entities accordingly only in the editor.
- Pitch Yaw Roll (X Y Z)
(angles)
<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.Note:This works on brush entities, although Hammer doesn't show the new angles.
- Classname
(classname)
<string> !FGD - Determines the characteristics of the entity before it spawns. Tip:Changing this on runtime still has use, like making matching an entry in S_PreserveEnts will persist the entity on new rounds!
- Flags
(spawnflags)
<integer> !FGD - Toggles exclusive features of an entity, its specific number is determined by the combination of flags added.
- Effects
(effects)
<integer> !FGD - Combination of effect flags to use.
- Entity Scripts
(vscripts)
<scriptlist> (in all games since ) (also in ) - 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. Scripts executed on the worldspawn entity will be placed in root scope.
- Think function
(thinkfunction)
<string> (in all games since ) (also in ) - Name of the function within this entity's script that'll be called automatically every 100 milliseconds, or a user-defined interval if the function returns a number. Avoid expensive operations in this function, as it may cause performance problems.
- Lag Compensation
(LagCompensate)
<boolean> (in all games since ) !FGD - Set to Yes to lag compensate this entity. Should be used very sparingly!
- Is Automatic-Aim Target
(is_autoaim_target)
<boolean> (in all games since ) !FGD - If set to 1, this entity will slow down aiming movement for consoles and joystick controllers when the entity is under the crosshairs.
Inputs
ShootGun
!FGD- Shoot the gun.
FireAtWill
- Allow tank to fire the next shot as soon as it's ready.
BaseTank:
Activate
- Turn the tank on.
Deactivate
- Turn the tank off (go dormant).
SetFireRate
<float>- How fast to fire (0 = don't fire).
SetDamage
<integer>- Set the Damage Per Bullet keyvalue.
SetTargetPosition
<vector>- World position (coordinates) that to aim at
SetTargetDir
<vector>- Direction (pitch yaw roll) to aim at.
SetTargetEntityName
<targetname>- "Set the entity I should follow/attack to the closest entity matching this name."[Clarify]
SetTargetEntity
<entity>- "Set the entity I should follow/attack to the passed in entity. This requires an output which passes an entity through the output."[Clarify]
ClearTargetEntity
- Clear the entity memory of any targets it was told to attack.
FindNPCToManTank
<string>- Find a nearby capable NPC to man this tank.
StartFindingNPCs
- Start searching for capable NPCs to man this tank.
StopFindingNPCs
- Stop searching for capable NPCs to man this tank.
ForceNPCOff
- Force the NPC manning this tank (if any) to leave.
SetMaxRange
<float>- Set the max range of the tank. Confirm:Maximum distance a shot can go?
Visible Brush:
Alpha
<integer 0–255>- 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
.
AlternativeSorting
<boolean>- Swaps the rendering order of the entity. Used to attempt to fix sorting problems when rendering, for example an object rendering in front of translucent materials.
Color
<color255>- Sets an RGB color for the entity.
SetDamageFilter
<targetname>- Sets a filter for this entity for when it receives damage.
EnableDamageForces
- Allows the entity to be pushed by damage done to it (usually force amount correlates with the damage done).
DisableDamageForces
- Prevents the entity from being pushed by damage done to it.
EnableDraw
(in all games since )- Removes
EF_NODRAW
from the entity.
DisableDraw
(in all games since )- Applies
EF_NODRAW
to the entity. Note that this is different fromrendermode 10
.
EnableReceivingFlashlight
(in all games since )- Makes it so that the entity is lit by
env_projectedtexture
s.
DisableReceivingFlashlight
(in all games since )- Prevents the entity from being lit by
env_projectedtexture
s. The shadow made by the texture will still cast.
Reflection:
DisableDrawInFastReflection
(in all games since )- Turns off rendering of this entity in reflections when using
$reflectonlymarkedentities
in water material.
EnableDrawInFastReflection
(in all games since )- Turn on rendering of this entity in reflections when using
$reflectonlymarkedentities
in water material.
Shadow:
DisableShadow
- Turn dynamic shadows off for this entity. Identical to applying
EF_NOSHADOW
.
EnableShadow
- Turn dynamic shadows on for this entity.
DisableReceivingFlashlight
(in all games since )- This object will not receive light or shadows from projected textures.
Base:
AddContext
<string>- Adds to the entity's list of response contexts. See Context.
AddOutput
<string>- Assigns a new keyvalue/output on this entity. For keyvalues, some rely on extra necessary code to be ran and won't work if its simply just changed through this input. There is a strict format that must be followed:
// Format of changing KeyValues: "AddOutput [key] [value]"
//// Raw text:
"OnUser1" "!self,AddOutput,targetname new_name"
// Format of adding an Output: "AddOutput {targetname}:{inputname}:{parameter}:{delay}:{max times to fire, -1 means infinite}"
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:SetParent:!activator:0.0:-1"
// Arguments can be left blank, but the empty blank should still be contained.
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:ClearParent::0.0:-1"
|
ClearContext
- Removes all contexts from this entity's list.
ClearParent
- Removes this entity from the the movement hierarchy, leaving it free to move independently.
FireUser1
toFireUser4
- Fires the respective
OnUser
outputs; see User Inputs and Outputs.
Kill
- Removes this entity and any entities parented to it from the world.
KillHierarchy
- Functions the same as
Kill
, although this entity and any entities parented to it are killed on the same frame, being marginally faster thanKill
input.
RemoveContext
<string>- Remove a context from this entity's list. The name should match the key of an existing context.
SetParent
<string>- Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment
<string>- Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset
<string>- As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
DispatchResponse
<string> !FGD- Dispatches a response to the entity. See Response and Concept.
DispatchEffect
<string> (removed since ) !FGD- Dispatches a special effect from the entity's origin; See also List of Client Effects. Replaced by the particle system since .
RunScriptFile
<script> (in all games since ) (also in )- Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode
<string> (in all games since ) (also in )- 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 Hammer, using string arguments will corrupt the VMF file's structure, making the file unviewable for the next Hammer session.Fix:Remove the string argument manually with a text editor.
CallScriptFunction
<string> (in all games since ) (also in ) !FGD- Calls a VScript function defined in the scope of the receiving entity.
TerminateScriptScope
(only in ) !FGD- Destroys the script scope of the receving entity.
SetLocalOrigin
<coordinates> (in all games since ) !FGD- Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
Outputs
BaseTank:
OnFire
- Fires when the tank fires its bullets.
OnAquireTarget
- Fires when target is newly in range and can be shot.
OnLoseTarget
- Fires when when target goes out of range.
OnAmmoDepleted
- DO NOT USE. Exists in code, but never coded to fire at any point.
OnGotController
- Fires when an NPC starts to control this tank. Players do NOT fire this input.
OnGotPlayerController
- Fires when a Player starts to control this tank. NPCs do NOT fire this input.
OnLostController
- Fires when the NPC controller of the tank stops controlling it. Players do NOT fire this input.
OnLostPlayerController
- Fires when the Player controller of the tank stops controlling it. NPCs do NOT fire this input.
OnReadyToFire
- Fires once when the tank spawns, or is done waiting to fire between rounds. Useful for playing a reloading/charging/searching sound possibly.
Base:
OnUser1
toOnUser4
- These outputs each fire in response to the firing of the like-numbered
FireUser1
toFireUser4
Input; see User Inputs and Outputs.