Returns whether the weapon allows to being switched from when a better ( Weapon:GetWeight ) weapon is being picked up.

Returns whether the weapon allows to being switched to when a better ( Weapon:GetWeight ) weapon is being picked up.

Calls a SWEP function on client. Does nothing on client. This uses the usermessage internally, because of that, the combined length of the arguments of this function may not exceed 254 bytes/characters or the function will cease to function!

Returns how much primary ammo is in the magazine. This is not shared between clients and will instead return the maximum primary clip size.

Returns how much secondary ammo is in the magazine. This is not shared between clients and will instead return the maximum secondary clip size.

Forces the weapon to reload while playing given animation. This will stop the Weapon:Think function from getting called while the weapon is reloading!

Returns the sequence enumeration number that the weapon is playing. This can return inconsistent results between the server and client. Issue Tracker: 2543

Returns the weapon deploy speed, as set by Weapon:SetDeploySpeed. If not previously set, the value will be polled from the sv_defaultdeployspeed ConVar.

Returns the hold type of the weapon.

Returns maximum primary clip size

Returns maximum secondary clip size

Gets the next time the weapon can primary fire. ( Can call WEAPON:PrimaryAttack )

Gets the next time the weapon can secondary fire. ( Can call WEAPON:SecondaryAttack )

Gets the primary ammo type of the given weapon.

Returns the non-internal name of the weapon, that should be for displaying. If that returns an untranslated message (#HL2_XX), use language. GetPhrase to see the "nice" name. If SWEP. PrintName is not set in the Weapon or the Weapon Base then "<MISSING SWEP PRINT NAME>" will be returned.

Gets the ammo type of the given weapons secondary fire.

Returns the slot of the weapon. The slot numbers start from 0.

Returns slot position of the weapon

Returns the view model of the weapon.

Returns the world model of the weapon.

Returns the "weight" of the weapon, which is used when deciding which Weapon is better by the engine.

Returns whether the weapon has ammo left or not. It will return false when there's no ammo left in the magazine and when there's no reserve ammo left. This will return true for weapons like crowbar, gravity gun, etc.

Returns whenever the weapon is carried by the local player.

Checks if the weapon is a SWEP or a built-in weapon.

Returns whether the weapon is visible. The term visibility is not exactly what gets checked here, first it checks if the owner is a player, then checks if the active view model has EF_NODRAW flag NOT set.

Returns the time since this weapon last fired a bullet with Entity:FireBullets in seconds. It is not networked.

Forces weapon to play activity/animation.

Sets the activity the weapon is playing. See also Weapon:GetActivity.

Lets you change the number of bullets in the given weapons primary clip.

Lets you change the number of bullets in the given weapons secondary clip.

Sets the weapon deploy speed. This value needs to match on client and server.

Sets the hold type of the weapon. This function also calls WEAPON:SetWeaponHoldType and properly networks it to all clients. This only works on scripted weapons. Using this function on weapons held by bots will not network holdtype changes to clients if the world model is set to an empty string (SWEP. WorldModel = "").

Sets the time since this weapon last fired in seconds. Used in conjunction with Weapon:LastShootTime

Sets when the weapon can fire again. Time should be based on CurTime. The standard HL2 Pistol (weapon_pistol) bypasses this function due to an internal implementation. This will fire extra bullets if the time is set to less than CurTime. Issue Tracker: 3786

Sets when the weapon can alt-fire again. Time should be based on CurTime.

Called when another entity fires an event to this entity.

Allows you to adjust the mouse sensitivity. This hook only works if you haven't overridden GM:AdjustMouseSensitivity.

Returns how much of primary ammo the player has.

Returns how much of secondary ammo the player has.

Allows you to adjust player view while this weapon in use. This hook is called from the default implementation of GM:CalcView which is here. Therefore, it will not be called if any other hook added to CalcView returns any value, or if the current gamemode overrides the default hook and does not call the SWEP function.

Allows overriding the position and angle of the viewmodel. This hook only works if you haven't overridden GM:CalcViewModelView.

Called when a Citizen NPC is looking around to a (better) weapon to pickup.

Helper function for checking for no ammo.

Helper function for checking for no ammo.

Allows you to use any numbers you want for the ammo display on the HUD. Can be useful for weapons that don't use standard ammo.

Called when player has just switched to this weapon. Due to this hook being predicted, it is not called clientside in singleplayer at all, and in multiplayer it will not be called clientside if the weapon is switched with Player:SelectWeapon or the "use" console command, however it will be called clientside with the default weapon selection menu and when using CUserCmd:SelectWeapon

Called when the crosshair is about to get drawn, and allows you to override it. This function will not be called if SWEP. DrawCrosshair is set to false or if player is affected by Player:CrosshairDisable.

Called so the weapon can override the impact effects it makes. If the bullet was fired in a predicted environment, the hook will not be called on the CLIENT realm. This hook will also be called when WEAPON:GetOwner():FireBullets is called. While in MULTIPLAYER, this hook will be called on the respective state, but in SINGLEPLAYER, this hook will always be called on the CLIENT realm even if FireBullets was called on the SERVER.

This hook allows you to draw on screen while this weapon is in use. If you want to draw a custom crosshair, consider using WEAPON:DoDrawCrosshair instead.

This hook allows you to draw on screen while this weapon is in use. This hook is called before WEAPON:DrawHUD and is equivalent of GM:HUDPaintBackground.

This hook draws the selection icon in the weapon selection menu.

Called when we are about to draw the world model.

Called when we are about to draw the translucent world model.

Called when a player or NPC has picked the weapon up.

The player has picked up the weapon and has taken the ammo from it. The weapon will be removed immediately after this call.

Called before firing animation events, such as muzzle flashes or shell ejections. This will only be called serverside for 3000-range events, and clientside for 5000-range and other events.

This hook allows you to freeze players screen. Player will still be able to move or shoot

This hook is for NPCs, you return what they should try to do with it. Calling NPC:CapabilitiesGet in this hook on the same entity can cause infinite loops since that function adds the result of WEAPON:GetCapabilities on top of the return value.

Called when the weapon is used by NPCs to determine how accurate the bullets fired should be. The inaccuracy is simulated by changing the NPC:GetAimVector based on the value returned from this hook.

Called when the weapon is used by NPCs to tell the NPC how to use this weapon. Controls how long the NPC can or should shoot continuously.

Called when the weapon is used by NPCs to tell the NPC how to use this weapon. Controls amount of time the NPC can rest (not shoot) between bursts.

Allows you to override where the tracer effect comes from. ( Visual bullets )

This hook allows you to adjust view model position and angles.

Called when weapon tries to holster. This will only be called serverside when using Player:SelectWeapon as that function immediately switches the weapon out of prediction. This is called twice for every holster clientside, one in Prediction and one not. Issue Tracker: 2854Before WEAPON:OnRemove is called, this function is only called serverside. Issue Tracker: 3133

This hook determines which parts of the HUD to draw.

Called when the weapon entity is created. Entity:GetOwner will return NULL at this point because the weapon is not equpped by a player or NPC yet. Use WEAPON:Equip or WEAPON:Deploy if you need the owner to be valid. This is not called serverside after a quicksave. Issue Tracker: 3015

Called when the engine sets a value for this scripted weapon. See GM:EntityKeyValue for a hook that works for all entities. See ENTITY:KeyValue for an hook that works for scripted entities.

Called when weapon is dropped by Player:DropWeapon. See also WEAPON:OwnerChanged.

Called whenever the weapons Lua script is reloaded.

Called when the swep is about to be removed.

Called when the weapon entity is reloaded from a Source Engine save (not the Sandbox saves or dupes) or on a changelevel (for example Half-Life 2 campaign level transitions). For the duplicator callbacks, see ENTITY:OnDuplicated. See also saverestore for relevant functions.

Called when weapon is dropped or picked up by a new player. This can be called clientside for all players on the server if the weapon has no owner and is picked up. See also WEAPON:OnDrop.

Called after the view model has been drawn while the weapon in use. This hook is called from the default implementation of GM:PostDrawViewModel, and as such, will not occur if it has been overridden. WEAPON:ViewModelDrawn is an alternative hook which is always called before GM:PostDrawViewModel.

Allows you to modify viewmodel while the weapon in use before it is drawn. This hook only works if you haven't overridden GM:PreDrawViewModel.

Called when primary attack button ( +attack ) is pressed. When in singleplayer, this function is only called in the server realm. When in multiplayer, the hook will be called on both the server and the client in order to allow for Prediction. You can force the hook to always be called on client like this: if ( game. SinglePlayer() ) then self:CallOnClient( "PrimaryAttack" ) end Note that due to prediction, in multiplayer SWEP:PrimaryAttack is called multiple times per one "shot" with the gun. To work around that, use IsFirstTimePredicted.

A convenience function that draws the weapon info box, used in WEAPON:DrawWeaponSelection.

Called when the reload key ( +reload ) is pressed.

Called every frame just before GM:RenderScene. Used by the Tool Gun to render view model screens (TOOL:DrawToolScreen). Materials rendered in this hook require $ignorez parameter to draw properly.

Called when secondary attack button ( +attack2 ) is pressed. For issues with this hook being called rapidly on the client side, see the global function IsFirstTimePredicted.

Called when the SWEP should set up its Data Tables.

Sets the hold type of the weapon. This must be called on both the server and the client to work properly. NOTE: You should avoid calling this function and call Weapon:SetHoldType now.

A convenient function to shoot bullets.

A convenience function to create shoot effects.

Called to determine if the view model should be drawn or not.

Should this weapon be dropped when its owner dies? This only works if the player has Player:ShouldDropWeapon set to true.

A convenience function to remove primary ammo from clip.

A convenience function to remove secondary ammo from clip.

Called when the weapon thinks. This hook won't be called during the deploy animation and when using Weapon:DefaultReload. Despite being a predicted hook, this hook is called clientside in single player (for your convenience), however it will not be recognized as a predicted hook via Player:GetCurrentCommand, and will run more often in this case. This hook will be called before Player movement is processed on the client, and after on the server. This hook only runs while the weapon is in players hands. It does not run while it is carried by an NPC. This will not be run during deploy animations after a serverside-only deploy. This usually happens after picking up and dropping an object with +use. Issue Tracker: 2855

Translate a player's Activity into a weapon's activity, depending on how you want the player to be holding the weapon. For example, ACT_MP_RUN becomes ACT_HL2MP_RUN_PISTOL.

Allows to change players field of view while player holds the weapon. This hook must be defined shared and return same value on both to properly affect Area Portals.

Called straight after the view model has been drawn. This is called before GM:PostDrawViewModel and WEAPON:PostDrawViewModel.