@tlua/gmod 1.0.1

package/weapon.d.tlua

@@ -0,0 +1,913 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * This is a list of all methods only available for weapons. It is also possible to call [Entity](https://wiki.facepunch.com/gmod/Entity) functions on weapons.
+ *
+ * **NOTE**: A list of available methods has been expanded in your navigation bar.
+ *
+ * @source https://wiki.facepunch.com/gmod/Weapon
+ */
+interface Weapon extends Entity {}
+interface WEAPON extends Weapon {}
+
+interface Weapon {
+    /**
+     * Allows you to adjust the weapon's mouse sensitivity. This hook only works if you haven't overridden [GM:AdjustMouseSensitivity](https://wiki.facepunch.com/gmod/GM:AdjustMouseSensitivity).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:AdjustMouseSensitivity
+     */
+    AdjustMouseSensitivity(self: Weapon, defaultSensitivity: number, localFOV: number, defaultFOV: number): number;
+}
+
+interface Weapon {
+    /**
+     * Returns how much of primary ammo the player has.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:Ammo1
+     */
+    Ammo1(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Returns how much of secondary ammo the player has.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:Ammo2
+     */
+    Ammo2(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Allows you to adjust player view while this weapon in use.
+     *
+     * This hook is called from the default implementation of [GM:CalcView](https://wiki.facepunch.com/gmod/GM:CalcView) which is [here](https://github.com/Facepunch/garrysmod/blob/master/garrysmod/gamemodes/base/gamemode/cl_init.lua#L387-L395). 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.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:CalcView
+     */
+    CalcView(self: Weapon, ply: Player, pos: Vector, ang: Angle, fov: number): (Vector, Angle, number);
+}
+
+interface Weapon {
+    /**
+     * Allows overriding the position and angle of the viewmodel. This hook only works if you haven't overridden [GM:CalcViewModelView](https://wiki.facepunch.com/gmod/GM:CalcViewModelView).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:CalcViewModelView
+     */
+    CalcViewModelView(self: Weapon, ViewModel: Entity, OldEyePos: Vector, OldEyeAng: Angle, EyePos: Vector, EyeAng: Angle): (Vector, Angle);
+}
+
+interface Weapon {
+    /**
+     * Called when a Citizen NPC is looking around to a (better) weapon to pickup.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/WEAPON:CanBePickedUpByNPCs
+     */
+    CanBePickedUpByNPCs(self: Weapon): boolean;
+}
+
+interface Weapon {
+    /**
+     * Helper function for checking for no ammo.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:CanPrimaryAttack
+     */
+    CanPrimaryAttack(self: Weapon): boolean;
+}
+
+interface Weapon {
+    /**
+     * Helper function for checking for no ammo.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:CanSecondaryAttack
+     */
+    CanSecondaryAttack(self: Weapon): boolean;
+}
+
+interface Weapon {
+    /**
+     * 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.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:CustomAmmoDisplay
+     */
+    CustomAmmoDisplay(self: Weapon): table;
+}
+
+interface Weapon {
+    /**
+     * Called when player has just switched to this weapon.
+     *
+     * **NOTE**: 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](https://wiki.facepunch.com/gmod/Player:SelectWeapon) or the "use" console command, however it will be called clientside with the default weapon selection menu and when using [CUserCmd:SelectWeapon](https://wiki.facepunch.com/gmod/CUserCmd:SelectWeapon)
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:Deploy
+     */
+    Deploy(self: Weapon): boolean;
+}
+
+interface Weapon {
+    /**
+     * 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](https://wiki.facepunch.com/gmod/Player:CrosshairDisable).
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:DoDrawCrosshair
+     */
+    DoDrawCrosshair(self: Weapon, x: number, y: number): boolean;
+}
+
+interface Weapon {
+    /**
+     * 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](https://wiki.facepunch.com/gmod/WEAPON:DoDrawCrosshair) instead.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:DrawHUD
+     */
+    DrawHUD(self: Weapon): void;
+}
+
+interface Weapon {
+    /**
+     * This hook allows you to draw on screen while this weapon is in use. This hook is called **before** [WEAPON:DrawHUD](https://wiki.facepunch.com/gmod/WEAPON:DrawHUD) and is equivalent of [GM:HUDPaintBackground](https://wiki.facepunch.com/gmod/GM:HUDPaintBackground).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:DrawHUDBackground
+     */
+    DrawHUDBackground(self: Weapon): void;
+}
+
+interface Weapon {
+    /**
+     * This hook draws the selection icon in the weapon selection menu.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:DrawWeaponSelection
+     */
+    DrawWeaponSelection(self: Weapon, x: number, y: number, width: number, height: number, alpha: number): void;
+}
+
+interface Weapon {
+    /**
+     * Called when we are about to draw the opaque parts of the weapon's world model.
+     *
+     * See [WEAPON:DrawWorldModelTranslucent](https://wiki.facepunch.com/gmod/WEAPON:DrawWorldModelTranslucent) for translucent pass callback.
+     * See [WEAPON:ViewModelDrawn](https://wiki.facepunch.com/gmod/WEAPON:ViewModelDrawn) for view model rendering.
+     *
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:DrawWorldModel
+     */
+    DrawWorldModel(self: Weapon, flags: number): void;
+}
+
+interface Weapon {
+    /**
+     * Called when we are about to draw the translucent parts of the weapon's world model.
+     *
+     * See [WEAPON:DrawWorldModel](https://wiki.facepunch.com/gmod/WEAPON:DrawWorldModel) for opaque pass callback.
+     * See [WEAPON:ViewModelDrawn](https://wiki.facepunch.com/gmod/WEAPON:ViewModelDrawn) for view model rendering.
+     *
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:DrawWorldModelTranslucent
+     */
+    DrawWorldModelTranslucent(self: Weapon, flags: number): void;
+}
+
+interface Weapon {
+    /**
+     * Called when a player or NPC has picked the weapon up.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/WEAPON:Equip
+     */
+    Equip(self: Weapon, NewOwner: Entity): void;
+}
+
+interface Weapon {
+    /**
+     * The player has picked up the weapon and has taken the ammo from it.
+     * The weapon will be removed immediately after this call.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/WEAPON:EquipAmmo
+     */
+    EquipAmmo(self: Weapon, ply: Player): void;
+}
+
+interface Weapon {
+    /**
+     * This hook allows you to freeze players screen.
+     * **NOTE**: Player will still be able to move or shoot
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:FreezeMovement
+     */
+    FreezeMovement(self: Weapon): boolean;
+}
+
+interface Weapon {
+    /**
+     * This hook is for NPCs, you return what they should try to do with it.
+     * 	**WARNING**: Calling [NPC:CapabilitiesGet](https://wiki.facepunch.com/gmod/NPC:CapabilitiesGet) in this hook on the same entity can cause infinite loops since that function adds the result of [WEAPON:GetCapabilities](https://wiki.facepunch.com/gmod/WEAPON:GetCapabilities) on top of the return value.
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/WEAPON:GetCapabilities
+     */
+    GetCapabilities(self: Weapon): CAP;
+}
+
+interface Weapon {
+    /**
+     * 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](https://wiki.facepunch.com/gmod/NPC:GetAimVector) based on the value returned from this hook.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/WEAPON:GetNPCBulletSpread
+     */
+    GetNPCBulletSpread(self: Weapon, proficiency: number): number;
+}
+
+interface Weapon {
+    /**
+     * 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.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/WEAPON:GetNPCBurstSettings
+     */
+    GetNPCBurstSettings(self: Weapon): (number, number, number);
+}
+
+interface Weapon {
+    /**
+     * 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.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/WEAPON:GetNPCRestTimes
+     */
+    GetNPCRestTimes(self: Weapon): (number, number);
+}
+
+interface Weapon {
+    /**
+     * Allows you to override where the tracer effect comes from. ( Visual bullets )
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:GetTracerOrigin
+     */
+    GetTracerOrigin(self: Weapon): Vector;
+}
+
+interface Weapon {
+    /**
+     * This hook allows you to adjust view model position and angles.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:GetViewModelPosition
+     */
+    GetViewModelPosition(self: Weapon, EyePos: Vector, EyeAng: Angle): (Vector, Angle);
+}
+
+interface Weapon {
+    /**
+     * This hook determines which parts of the HUD to draw.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:HUDShouldDraw
+     */
+    HUDShouldDraw(self: Weapon, element: string): boolean;
+}
+
+interface Weapon {
+    /**
+     * Called when the weapon tries to holster. Return true to allow the weapon to
+     * holster. This has no effect if the weapon was switched away from using
+     * Player:SetActiveWeapon.
+     * @hook Holster
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:Holster
+     */
+    Holster(self: Weapon, weapon?: Weapon): boolean;
+}
+
+
+interface Weapon {
+    /**
+     * Called internally during `TASK_RANGE_ATTACK1 --> OnRangeAttack1`. This allows you to separate your SWEPs primary firing function from players and NPCs.
+     *
+     * To get the delay the NPC will fire again, you can call `self:GetOwner():GetInternalVariable("m_flNextAttack")`
+     *
+     * **NOTE**: This hook is called internally only for NPCs that has `CAP_USE_SHOT_REGULATOR` set.
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/WEAPON:NPCShoot_Primary
+     */
+    NPCShoot_Primary(self: Weapon, shootPos?: Vector, shootDir?: Vector): void;
+}
+
+interface Weapon {
+    /**
+     * A utility function to seperate your SWEPs secondary firing from players.
+     *
+     * Unlike [WEAPON:NPCShoot_Primary](https://wiki.facepunch.com/gmod/WEAPON:NPCShoot_Primary), this won't be called by the engine for `TASK_RANGE_ATTACK2`.
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/WEAPON:NPCShoot_Secondary
+     */
+    NPCShoot_Secondary(self: Weapon, shootPos?: Vector, shootDir?: Vector): void;
+}
+
+interface Weapon {
+    /**
+     * Called when weapon is dropped by [Player:DropWeapon](https://wiki.facepunch.com/gmod/Player:DropWeapon).
+     *
+     * See also [WEAPON:OwnerChanged](https://wiki.facepunch.com/gmod/WEAPON:OwnerChanged).
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/WEAPON:OnDrop
+     */
+    OnDrop(self: Weapon, owner: Entity): void;
+}
+
+interface Weapon {
+    /**
+     * 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](https://wiki.facepunch.com/gmod/WEAPON:OnDrop).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:OwnerChanged
+     */
+    OwnerChanged(self: Weapon): void;
+}
+
+interface Weapon {
+    /**
+     * Called after the view model has been drawn while the weapon in use.
+     *
+     * This hook relies on default implementation of [GM:PostDrawViewModel](https://wiki.facepunch.com/gmod/GM:PostDrawViewModel). If it appears to not work, it may have been overwritten/broken by the currently active gamemode or other addons.
+     *
+     * [WEAPON:ViewModelDrawn](https://wiki.facepunch.com/gmod/WEAPON:ViewModelDrawn) is an alternative hook which is always called before [GM:PostDrawViewModel](https://wiki.facepunch.com/gmod/GM:PostDrawViewModel).
+     *
+     * See also [WEAPON:PreDrawViewModel](https://wiki.facepunch.com/gmod/WEAPON:PreDrawViewModel).
+     *
+     *
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:PostDrawViewModel
+     */
+    PostDrawViewModel(self: Weapon, vm: Entity, weapon: Weapon, ply: Player, flags: number): void;
+}
+
+interface Weapon {
+    /**
+     * Allows you to modify viewmodel while the weapon in use before it is drawn.
+     *
+     * This hook relies on default implementation of [GM:PreDrawViewModel](https://wiki.facepunch.com/gmod/GM:PreDrawViewModel). If it appears to not work, it may have been overwritten/broken by the currently active gamemode or other addons.
+     *
+     * See also [WEAPON:ViewModelDrawn](https://wiki.facepunch.com/gmod/WEAPON:ViewModelDrawn) and [WEAPON:PostDrawViewModel](https://wiki.facepunch.com/gmod/WEAPON:PostDrawViewModel).
+     *
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:PreDrawViewModel
+     */
+    PreDrawViewModel(self: Weapon, vm: Entity, weapon: Weapon, ply: Player, flags: number): boolean;
+}
+
+interface Weapon {
+    /**
+     * 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](https://wiki.facepunch.com/gmod/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 [Global.IsFirstTimePredicted](https://wiki.facepunch.com/gmod/Global.IsFirstTimePredicted).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:PrimaryAttack
+     */
+    PrimaryAttack(self: Weapon): void;
+}
+
+interface Weapon {
+    /**
+     * A convenience function that draws the weapon info box, used in [WEAPON:DrawWeaponSelection](https://wiki.facepunch.com/gmod/WEAPON:DrawWeaponSelection).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:PrintWeaponInfo
+     */
+    PrintWeaponInfo(self: Weapon, x: number, y: number, alpha: number): void;
+}
+
+interface Weapon {
+    /**
+     * Called when the reload key ( +reload ) is pressed.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:Reload
+     */
+    Reload(self: Weapon): void;
+}
+
+interface Weapon {
+    /**
+     * Called every frame just before [GM:RenderScene](https://wiki.facepunch.com/gmod/GM:RenderScene).
+     *
+     * Used by the Tool Gun to render view model screens ([TOOL:DrawToolScreen](https://wiki.facepunch.com/gmod/TOOL:DrawToolScreen)).
+     *
+     *
+     * **NOTE**: Materials rendered in this hook require $ignorez parameter to draw properly.
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:RenderScreen
+     */
+    RenderScreen(self: Weapon): void;
+}
+
+interface Weapon {
+    /**
+     * Called when secondary attack button ( +attack2 ) is pressed.
+     *
+     * For issues with this hook being called rapidly on the client side, see the global function [Global.IsFirstTimePredicted](https://wiki.facepunch.com/gmod/Global.IsFirstTimePredicted).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:SecondaryAttack
+     */
+    SecondaryAttack(self: Weapon): void;
+}
+
+interface Weapon {
+    /**
+     * Sets the weapon deploy speed. This value needs to match on client and server.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:SetDeploySpeed
+     */
+    SetDeploySpeed(self: Weapon, speed: number): void;
+}
+
+interface Weapon {
+    /**
+     * 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](https://wiki.facepunch.com/gmod/Weapon:SetHoldType) now.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:SetWeaponHoldType
+     */
+    SetWeaponHoldType(self: Weapon, name: string): void;
+}
+
+interface Weapon {
+    /**
+     * A convenient function to shoot bullets.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:ShootBullet
+     */
+    ShootBullet(self: Weapon, damage: number, num_bullets: number, aimcone: number, ammo_type?: string, force?: number, tracer?: number): void;
+}
+
+interface Weapon {
+    /**
+     * A convenience function to create shoot effects.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:ShootEffects
+     */
+    ShootEffects(self: Weapon): void;
+}
+
+interface Weapon {
+    /**
+     * Called to determine if the view model should be drawn or not.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:ShouldDrawViewModel
+     */
+    ShouldDrawViewModel(self: Weapon): boolean;
+}
+
+interface Weapon {
+    /**
+     * Should this weapon be dropped when its owner dies?
+     *
+     * This only works if the player has [Player:ShouldDropWeapon](https://wiki.facepunch.com/gmod/Player:ShouldDropWeapon) set to true.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/WEAPON:ShouldDropOnDie
+     */
+    ShouldDropOnDie(self: Weapon): boolean;
+}
+
+interface Weapon {
+    /**
+     * A convenience function to remove primary ammo from clip.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:TakePrimaryAmmo
+     */
+    TakePrimaryAmmo(self: Weapon, amount: number): void;
+}
+
+interface Weapon {
+    /**
+     * A convenience function to remove secondary ammo from clip.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:TakeSecondaryAmmo
+     */
+    TakeSecondaryAmmo(self: Weapon, amount: number): void;
+}
+
+interface Weapon {
+    /**
+     * Alias of [Weapon:Think](https://wiki.facepunch.com/gmod/Weapon:Think).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:Tick
+     * @deprecated Use Weapon:Think instead.
+     */
+    Tick(self: Weapon): void;
+}
+
+interface Weapon {
+    /**
+     * Allows to change players field of view while player holds the weapon.
+     *
+     * **NOTE**: This hook must be defined shared and return same value on both to properly affect Area Portals.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/WEAPON:TranslateFOV
+     */
+    TranslateFOV(self: Weapon, fov: number): number;
+}
+
+interface Weapon {
+    /**
+     * Called straight after the view model has been drawn. This is called before [GM:PostDrawViewModel](https://wiki.facepunch.com/gmod/GM:PostDrawViewModel) and [WEAPON:PostDrawViewModel](https://wiki.facepunch.com/gmod/WEAPON:PostDrawViewModel).
+     *
+     * See [WEAPON:DrawWorldModel](https://wiki.facepunch.com/gmod/WEAPON:DrawWorldModel) for world model rendering.
+     *
+     * See also [WEAPON:PreDrawViewModel](https://wiki.facepunch.com/gmod/WEAPON:PreDrawViewModel) and [WEAPON:PostDrawViewModel](https://wiki.facepunch.com/gmod/WEAPON:PostDrawViewModel).
+     *
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/WEAPON:ViewModelDrawn
+     */
+    ViewModelDrawn(self: Weapon, ViewModel: Entity, flags: number): void;
+}
+
+interface Weapon {
+    /**
+     * Returns whether the weapon allows to being switched from when a better ( [Weapon:GetWeight](https://wiki.facepunch.com/gmod/Weapon:GetWeight) ) weapon is being picked up.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:AllowsAutoSwitchFrom
+     */
+    AllowsAutoSwitchFrom(self: Weapon): boolean;
+}
+
+interface Weapon {
+    /**
+     * Returns whether the weapon allows to being switched to when a better ([Weapon:GetWeight](https://wiki.facepunch.com/gmod/Weapon:GetWeight)) weapon is being picked up.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:AllowsAutoSwitchTo
+     */
+    AllowsAutoSwitchTo(self: Weapon): boolean;
+}
+
+interface Weapon {
+    /**
+     * Calls a SWEP function on client. Does nothing on client.
+     *
+     * **WARNING**: This uses the [usermessage](https://wiki.facepunch.com/gmod/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!
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:CallOnClient
+     */
+    CallOnClient(self: Weapon, functionName: string, data?: string): void;
+}
+
+interface Weapon {
+    /**
+     * Returns how much primary ammo is in the magazine.
+     * 	**NOTE**: This is not shared between clients and will instead return the maximum primary clip size.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:Clip1
+     */
+    Clip1(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Returns how much secondary ammo is in the magazine.
+     * 	**NOTE**: This is not shared between clients and will instead return the maximum secondary clip size.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:Clip2
+     */
+    Clip2(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Forces the weapon to reload while playing given animation.
+     * 	**NOTE**: This will stop the [Weapon:Think](https://wiki.facepunch.com/gmod/Weapon:Think) function from getting called while the weapon is reloading!
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:DefaultReload
+     */
+    DefaultReload(self: Weapon, act: number): boolean;
+}
+
+interface Weapon {
+    /**
+     * Returns the sequence enumeration number that the weapon is playing.
+     *
+     * This can return inconsistent results between the server and client.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetActivity
+     */
+    GetActivity(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Returns the weapon deploy speed, as set by [Weapon:SetDeploySpeed](https://wiki.facepunch.com/gmod/Weapon:SetDeploySpeed). If not previously set, the value will be polled from the `sv_defaultdeployspeed` [ConVar](https://wiki.facepunch.com/gmod/ConVar).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetDeploySpeed
+     */
+    GetDeploySpeed(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Returns the hold type of the weapon.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetHoldType
+     */
+    GetHoldType(self: Weapon): string;
+}
+
+interface Weapon {
+    /**
+     * Returns maximum primary clip size
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetMaxClip1
+     */
+    GetMaxClip1(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Returns maximum secondary clip size
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetMaxClip2
+     */
+    GetMaxClip2(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Gets the next time the weapon can primary fire. ( Can call [WEAPON:PrimaryAttack](https://wiki.facepunch.com/gmod/WEAPON:PrimaryAttack) )
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetNextPrimaryFire
+     */
+    GetNextPrimaryFire(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Gets the next time the weapon can secondary fire. ( Can call [WEAPON:SecondaryAttack](https://wiki.facepunch.com/gmod/WEAPON:SecondaryAttack) )
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetNextSecondaryFire
+     */
+    GetNextSecondaryFire(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Gets the primary ammo type of the given weapon.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetPrimaryAmmoType
+     */
+    GetPrimaryAmmoType(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Returns the non-internal name of the weapon, that should be for displaying.
+     *
+     * **NOTE**: If that returns an untranslated message (#HL2_XX), use [language.GetPhrase](https://wiki.facepunch.com/gmod/language.GetPhrase) to see the "nice" name.
+     *
+     * **NOTE**: If SWEP.PrintName is not set in the Weapon or the Weapon Base then "" will be returned.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetPrintName
+     */
+    GetPrintName(self: Weapon): string;
+}
+
+interface Weapon {
+    /**
+     * Gets the ammo type of the given weapons secondary fire.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetSecondaryAmmoType
+     */
+    GetSecondaryAmmoType(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Returns the slot of the weapon.
+     * 	**NOTE**: The slot numbers start from 0.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetSlot
+     */
+    GetSlot(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Returns slot position of the weapon
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetSlotPos
+     */
+    GetSlotPos(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Returns the view model of the weapon.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetWeaponViewModel
+     */
+    GetWeaponViewModel(self: Weapon): string;
+}
+
+interface Weapon {
+    /**
+     * Returns the world model of the weapon.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetWeaponWorldModel
+     */
+    GetWeaponWorldModel(self: Weapon): string;
+}
+
+interface Weapon {
+    /**
+     * Returns the "weight" of the weapon, which is used when deciding which [Weapon](https://wiki.facepunch.com/gmod/Weapon) is better by the engine.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:GetWeight
+     */
+    GetWeight(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * 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.
+     *
+     * **NOTE**: This will return true for weapons like crowbar, gravity gun, etc.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:HasAmmo
+     */
+    HasAmmo(self: Weapon): boolean;
+}
+
+interface Weapon {
+    /**
+     * Returns whenever the weapon is carried by the local player.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/Weapon:IsCarriedByLocalPlayer
+     */
+    IsCarriedByLocalPlayer(self: Weapon): boolean;
+}
+
+interface 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.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:IsWeaponVisible
+     */
+    IsWeaponVisible(self: Weapon): boolean;
+}
+
+interface Weapon {
+    /**
+     * Returns the time since this weapon last fired a bullet with [Entity:FireBullets](https://wiki.facepunch.com/gmod/Entity:FireBullets) in seconds. It is not networked.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:LastShootTime
+     */
+    LastShootTime(self: Weapon): number;
+}
+
+interface Weapon {
+    /**
+     * Forces weapon to play activity/animation.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:SendWeaponAnim
+     */
+    SendWeaponAnim(self: Weapon, act: number): void;
+}
+
+interface Weapon {
+    /**
+     * Sets the activity the weapon is playing.
+     *
+     * See also [Weapon:GetActivity](https://wiki.facepunch.com/gmod/Weapon:GetActivity).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:SetActivity
+     */
+    SetActivity(self: Weapon, act: number): void;
+}
+
+interface Weapon {
+    /**
+     * Lets you change the number of bullets in the given weapons primary clip.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:SetClip1
+     */
+    SetClip1(self: Weapon, ammo: number): void;
+}
+
+interface Weapon {
+    /**
+     * Lets you change the number of bullets in the given weapons secondary clip.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:SetClip2
+     */
+    SetClip2(self: Weapon, ammo: number): void;
+}
+
+interface Weapon {
+    /**
+     * Sets the hold type of the weapon. This function also calls [WEAPON:SetWeaponHoldType](https://wiki.facepunch.com/gmod/WEAPON:SetWeaponHoldType) and properly networks it to all clients.
+     *
+     * **NOTE**: 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 = "").
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:SetHoldType
+     */
+    SetHoldType(self: Weapon, name: string): void;
+}
+
+interface Weapon {
+    /**
+     * Sets the time since this weapon last fired in seconds. Used in conjunction with [Weapon:LastShootTime](https://wiki.facepunch.com/gmod/Weapon:LastShootTime).
+     *
+     * This value is **not** networked to the client if set from server.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:SetLastShootTime
+     */
+    SetLastShootTime(self: Weapon, time?: number): void;
+}
+
+interface Weapon {
+    /**
+     * Sets when the weapon can fire again. Time should be based on [Global.CurTime](https://wiki.facepunch.com/gmod/Global.CurTime).
+     *
+     * **NOTE**: The standard HL2 Pistol (`weapon_pistol`) bypasses this function due to an [internal implementation](https://github.com/ValveSoftware/source-sdk-2013/blob/master/src/game/server/hl2/weapon_pistol.cpp#L313-L317).
+     *
+     * This will fire extra bullets if the time is set to less than [Global.CurTime](https://wiki.facepunch.com/gmod/Global.CurTime).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:SetNextPrimaryFire
+     */
+    SetNextPrimaryFire(self: Weapon, time: number): void;
+}
+
+interface Weapon {
+    /**
+     * Sets when the weapon can alt-fire again. Time should be based on [Global.CurTime](https://wiki.facepunch.com/gmod/Global.CurTime).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Weapon:SetNextSecondaryFire
+     */
+    SetNextSecondaryFire(self: Weapon, time: number): void;
+}
+