cw_stunstick weapon

Weapon defined in entities/weapons/cw_stunstick

Defines the cw_stunstick weapon, the Civil Protection stun baton.

Primary fire strikes a player or prop within 96 units for club damage that scales with the owner's strength attribute and runs the PlayerStunEntity hook. Secondary fire knocks on a door (PlayerCanKnockOnDoor, PlayerKnockOnDoor) or pushes whatever is aimed at. The client draws a pulsing glow on the baton while it is raised.

Summary

Methods

Deploy()shared
Plays the draw animation.
DoAnimations(idle)shared
Plays the owner's attack animation unless idle is set.
DoHitEffects()shared
Plays the swing animation with a spark, flesh hit or impact sound and the stunstick impact effect.
DrawWorldModel()shared
Draws the stunstick with a pulsing glow at its tip while raised.
Holster(switchingTo)shared
Plays the holster animation.
Initialize()shared
Sets the melee hold type.
OnLowered()shared
Plays a spark sound and, for Civil Protection models, the baton deactivation animation.
OnRaised()shared
Plays a spark sound and, for Civil Protection models, the baton activation animation.
PlayKnockSound()shared
Plays the door knock sound, mirrored to the owner's client when called on the server.
PlayPushSound()shared
Plays the push sound, mirrored to the owner's client when called on the server.
PrimaryAttack()shared
Strikes whatever the owner aims at within 96 units.
SecondaryAttack()shared
Knocks on a door within 64 units or pushes the player, NPC or prop being aimed at within 96 units.
ViewModelDrawn()shared
Draws the pulsing glow and spark sprites on the view model while raised.

Methods

SWEP:Deploy()

shared gamemodes/cwhl2rp/schema/entities/weapons/cw_stunstick/shared.lua:77

Plays the draw animation.

Returns

  • Boolean Always true to allow the deploy

SWEP:DoAnimations(idle)

shared gamemodes/cwhl2rp/schema/entities/weapons/cw_stunstick/shared.lua:245

Plays the owner's attack animation unless idle is set.

Parameters

  • idle Boolean optional, defaults to nil Whether to skip the attack animation

SWEP:DoHitEffects()

shared gamemodes/cwhl2rp/schema/entities/weapons/cw_stunstick/shared.lua:118

Plays the swing animation with a spark, flesh hit or impact sound and the stunstick impact effect.

The effect and hit sounds only play when the owner's eye trace hits something within 96 units; otherwise a swing sound plays.

SWEP:DrawWorldModel()

shared gamemodes/cwhl2rp/schema/entities/weapons/cw_stunstick/shared.lua:179

Draws the stunstick with a pulsing glow at its tip while raised.

SWEP:Holster(switchingTo)

shared gamemodes/cwhl2rp/schema/entities/weapons/cw_stunstick/shared.lua:85

Plays the holster animation.

Parameters

  • switchingTo

Returns

  • Boolean Always true to allow the holster

SWEP:Initialize()

shared gamemodes/cwhl2rp/schema/entities/weapons/cw_stunstick/shared.lua:92

Sets the melee hold type.

SWEP:OnLowered()

shared gamemodes/cwhl2rp/schema/entities/weapons/cw_stunstick/shared.lua:153

Plays a spark sound and, for Civil Protection models, the baton deactivation animation.

SWEP:OnRaised()

shared gamemodes/cwhl2rp/schema/entities/weapons/cw_stunstick/shared.lua:166

Plays a spark sound and, for Civil Protection models, the baton activation animation.

SWEP:PlayKnockSound()

shared gamemodes/cwhl2rp/schema/entities/weapons/cw_stunstick/shared.lua:97

Plays the door knock sound, mirrored to the owner's client when called on the server.

SWEP:PlayPushSound()

shared gamemodes/cwhl2rp/schema/entities/weapons/cw_stunstick/shared.lua:106

Plays the push sound, mirrored to the owner's client when called on the server.

SWEP:PrimaryAttack()

shared gamemodes/cwhl2rp/schema/entities/weapons/cw_stunstick/shared.lua:256

Strikes whatever the owner aims at within 96 units.

Players are pushed back and, while above 10 health, take club damage that scales with the owner's strength. Physics props are pushed and take more damage; ragdolled players take the player damage. Fires the PlayerStunEntity hook for every hit.

SWEP:SecondaryAttack()

shared gamemodes/cwhl2rp/schema/entities/weapons/cw_stunstick/shared.lua:317

Knocks on a door within 64 units or pushes the player, NPC or prop being aimed at within 96 units.

Knocking needs the PlayerCanKnockOnDoor hook to allow it and fires PlayerKnockOnDoor. Pushing plays the Civil Protection push animation for those models.

SWEP:ViewModelDrawn()

shared gamemodes/cwhl2rp/schema/entities/weapons/cw_stunstick/shared.lua:200

Draws the pulsing glow and spark sprites on the view model while raised.

Defined in