weapon_stunstick

Class hierarchy
CWeaponStunStick ↳CBaseHLBludgeonWeapon ↳CBaseHLCombatWeapon ↳CBaseCombatWeapon ↳CBaseAnimating ↳CBaseEntity
weapon_stunstick.cpp

weapon_stunstick is a model entity available in  Half-Life 2 series.

Entity description

A Combine beating stick with a zappy end. When picked up in singleplayer (and if its classname is not changed beforehand), it supplies power to the HEV suit (much like a battery). Combine players spawn with a stunstick in Half-Life 2 Deathmatch whereas Resistance players spawn with a crowbar, but both teams can use the other weapon if picked up. It can be used in the Entropy : Zero series as a melee weapon, and has a right-click charge attack.

Before it is picked up, the stunstick also follows all physics rules as if it were a prop_physics.

Note: The amount of suit power granted in HL2 is equal to sk_battery <int> / 2

Setting the stunstick_pickupable ConVar to 1 will replace this entity with an equippable version when touched by the player.

Flags

Start Constrained : [1]

Prevents the model from moving.

Deny player pickup (reserve for NPC) : [2]

Not puntable by Gravity Gun : [4]

Inputs

HideWeapon  !FGD

If this weapon is being held, hide the worldmodel and/or viewmodel via EF_NODRAW. Weapon will still be useable. The weapon will become visible again if the holder is to switch between weapons in their inventory.

Outputs

OnNPCPickup

!activator = NPC
!caller = this entity

Fires when an NPC picks up this weapon.

OnPlayerUse

!activator = player
!caller = this entity

Fires when the player +uses this weapon.

OnPlayerPickup

!activator = player
!caller = this entity

Fires when a player picks up this weapon.

OnCacheInteraction

Fires when the player 'proves' they've found this weapon. Fires on: Player Touch, +USE pickup, Physcannon pickup, Physcannon punt.

See also

• weapon_stunstick_player