weapon_breachcharge

From Valve Developer Community
Revision as of 19:42, 1 January 2021 by Popcorn (talk | contribs) (Added BasicCSGOweapon template. Revised description.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
C4.jpg

<Counter-Strike: Global Offensive> weapon_breachcharge is a point entity available in Counter-Strike: Global Offensive.

Entity Description

It's one of many new entities added with the Danger Zone update.

The primary attack (+attack) throws a breachcharge_projectile. It sticks to solid brushes, func_physboxes, props and players and plays a unique sound when doing so.
The secondary attack (+attack2) lets all projectiles that have landed emit a beeping sound and detonates them after a fuse time. The bigger the distance between a breachcharge projectile and the triggering player, the longer the delay between triggering and explosion. Projectiles in mid-air will behave as if they will be triggered immediately after landing.

Every projectile can be picked up again with +use by the player with the corresponding breachcharge item, even if already triggered or still in mid-air. If a player has a breachcharge equipped, he can identify the corresponding projectiles in a certain range by a yellow-black skull shown at their positions (also through walls).

Related Console Commands

Command Desecription
ammo_grenade_limit_breachcharge Default value is 3.
Confirm:No effect. Such ConVars usually affect the reserve ammo, but breachcharge doesn't use that (max reserve ammo seems to be 0).
mp_death_drop_breachcharge Whether or not players drop their breachcharge on death. Default value is 1.
sv_breachcharge_arm_delay Default value is 0. To do: Doesn't affect anything?
sv_breachcharge_delay_max Default value is 0.8. To do: Doesn't affect anything?
sv_breachcharge_delay_min Default value is 0. To do: Doesn't affect anything?
sv_breachcharge_distance_max Default value is 1200. To do: Doesn't affect anything?
sv_breachcharge_distance_min Default value is 600. To do: Doesn't affect anything?
sv_breachcharge_fuse_max Default value is 1.0. To do: Doesn't affect anything?
sv_breachcharge_fuse_min Default value is 0.7. To do: Doesn't affect anything?

Keyvalues

Is this weapon allowed to be picked up? (CanBePickedUp) <boolean>
Determines if players are able to pick up the weapon.

Targetname:

Name (targetname) <string>
The targetname that other entities refer to this entity by.
Entity Scripts (vscripts) <scriptlist> (in all games since <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 (thinkfunction) <string> (in all games since <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.png Note: Try to avoid expensive operations in this function, as it may cause performance problems.

Angles:

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

Flags

  • 1 : Start Constrained
Prevents the model from moving.

Inputs

SetAmmoAmount <integer>
Sets the (primary) ammo which is usually the number of bullets in the active magazine. Every value behaves like its congruent value in the range 0-255 in modulus 256 (e.g. -255 and 257 behave like 1 etc.). When set to 0, a player holding this weapon will reload automatically, if possible. Other values congruent to 0 (-256, 256, 512, ...) might cause undefined behavior. Values congruent to -1 (mod 256) make the ammo numbers disappear. If set to a value outside the weapon's clip size, reloading might deliver unexpected results.
SetReserveAmmoAmount <integer>
Sets the reserve (secondary) ammo which is usually the number of bullets in reserve for reloading. Values that are greater than the weapon's reserve ammo limit are clamped to it (e.g. 90 for the weapon_ak47). Negative values make the ammo display disappear and reloading is impossible.
ToggleCanBePickedUp <boolean>
Toggles if the weapon can be picked up by players. Visually, nothing changes and there is no event if picking up fails. Hover texts like "[E] Swap for AK-47" remain in both cases.

Targetname:

Kill
Removes this entity from the world.
KillHierarchy
Removes this entity and its children from the world.
Note.png Note: Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than Kill.
AddOutput <string>
Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format: <key> <value>
I/O 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 depending on the entity. Can also be invoked by firing an output that does not specify an input.
RunScriptFile <script> (in all games since <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> (in all games since <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.png 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.png 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> (in all games since <Left 4 Dead 2>) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (in all games since <Alien Swarm>) !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.
SetLocalAngles <angles> (in all games since <Alien Swarm>) !FGD
Set this entity's angles.

Outputs

Weapon:

OnPlayerUse
Fires when a player +uses this weapon but does not pick it up, e.g. during the pickup cooldown immediately after dropping it or if CanBePickedUp is false (activator is the player).
OnPlayerPickup
Fires when a player picks this weapon up (activator is the player).
OnCacheInteraction  !FGD
Fires when a player picks this weapon up (activator is the player). Also fires rapidly when a player touches the weapon but automatic pickup fails, e.g. if he already has a weapon in that slot. Does not fire if CanBePickedUp is false.
OnNPCPickup  !FGD
Fires when an NPC picks up this weapon (activator is the NPC). However, bots in <Counter-Strike: Global Offensive> are considered players, so this output has no functionality.

Base:

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.