@tlua/gmod 1.0.5 → 1.0.6

package/types/gm.d.tlua

@@ -17,6 +17,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:AcceptInput
      */
     AcceptInput(self: GM, ent: Entity, input: string, activator: Entity, caller: Entity, value: any): boolean;
+
     /**
      * Adds a death notice entry.
      *
@@ -24,12 +25,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:AddDeathNotice
      */
     AddDeathNotice(self: GM, attacker: string, attackerTeam: number, inflictor: string, victim: string, victimTeam: number): any;
+
     /**
      * Allows you to adjust the mouse sensitivity.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:AdjustMouseSensitivity
      */
     AdjustMouseSensitivity(self: GM, defaultSensitivity: number, localFOV: number, defaultFOV: number): number;
+
     /**
      * Called when a player tries to pick up something using the "use" key, return to override.
      *
@@ -42,6 +45,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:AllowPlayerPickup
      */
     AllowPlayerPickup(self: GM, ply: Player, ent: Entity): boolean;
+
     /**
      * This hook is used to calculate animations for a player.
      *
@@ -52,6 +56,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:CalcMainActivity
      */
     CalcMainActivity(self: GM, ply: Player, vel: Vector): (number, number);
+
     /**
      * Called from [GM:CalcView](https://wiki.facepunch.com/gmod/GM:CalcView) when player is in driving a vehicle.
      *
@@ -61,24 +66,28 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:CalcVehicleView
      */
     CalcVehicleView(self: GM, veh: Vehicle, ply: Player, view: CamData): table;
+
     /**
      * Allows override of the default view.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:CalcView
      */
     CalcView(self: GM, ply: Player, origin: Vector, angles: Angle, fov: number, znear: number, zfar: number): CamData;
+
     /**
      * Allows overriding the position and angle of the viewmodel.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:CalcViewModelView
      */
     CalcViewModelView(self: GM, wep: Weapon, vm: Entity, oldPos: Vector, oldAng: Angle, pos: Vector, ang: Angle): (Vector, Angle);
+
     /**
      * Called whenever a players tries to create an undo.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:CanCreateUndo
      */
     CanCreateUndo(self: GM, ply: Player, undo: Undo): boolean;
+
     /**
      * Called when a variable is about to be edited on an Entity (called by `Edit Properties...` menu), to determine if the edit should be permitted.
      *
@@ -90,6 +99,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:CanEditVariable
      */
     CanEditVariable(self: GM, ent: Entity, ply: Player, key: string, value: string, editor: table): boolean;
+
     /**
      * Determines if the player can exit the vehicle on their own. [Player:ExitVehicle](https://wiki.facepunch.com/gmod/Player:ExitVehicle) will bypass this hook.
      *
@@ -100,6 +110,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:CanExitVehicle
      */
     CanExitVehicle(self: GM, veh: Vehicle, ply: Player): boolean;
+
     /**
      * Determines whether or not a given player player can enter the given vehicle. [Player:EnterVehicle](https://wiki.facepunch.com/gmod/Player:EnterVehicle) will still call this hook.
      *
@@ -109,30 +120,35 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:CanPlayerEnterVehicle
      */
     CanPlayerEnterVehicle(self: GM, player: Player, vehicle: Vehicle, role: number): boolean;
+
     /**
      * Determines if the player can kill themselves using the `kill` or `explode` console commands.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:CanPlayerSuicide
      */
     CanPlayerSuicide(self: GM, player: Player): boolean;
+
     /**
      * Determines if the player can unfreeze the entity.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:CanPlayerUnfreeze
      */
     CanPlayerUnfreeze(self: GM, player: Player, entity: Entity, phys: PhysObj): boolean;
+
     /**
      * Controls if a [property](https://wiki.facepunch.com/gmod/properties) can be used or not.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:CanProperty
      */
     CanProperty(self: GM, ply: Player, property: string, ent: Entity): boolean;
+
     /**
      * Called whenever a players tries to undo.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:CanUndo
      */
     CanUndo(self: GM, ply: Player, undo: Undo): boolean;
+
     /**
      * Called each frame to record demos to video using [IVideoWriter](https://wiki.facepunch.com/gmod/IVideoWriter).
      *
@@ -143,6 +159,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:CaptureVideo
      */
     CaptureVideo(self: GM): void;
+
     /**
      * Called when a message is printed to the chat box. Note, that this isn't working with player messages even though there are arguments for it.
      *
@@ -152,12 +169,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:ChatText
      */
     ChatText(self: GM, index: number, name: string, text: string, type: string): boolean;
+
     /**
      * Called whenever the content of the user's chat input box is changed.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:ChatTextChanged
      */
     ChatTextChanged(self: GM, text: string): void;
+
     /**
      * Called when a **non local player** connects to allow the Lua system to check the password.
      *
@@ -167,6 +186,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:CheckPassword
      */
     CheckPassword(self: GM, steamID64: string, ipAddress: string, svPassword: string, clPassword: string, name: string): (boolean, string);
+
     /**
      * Called when a player's sign on state changes.
      * You cannot get a valid player object from the userID at any point during this hook.
@@ -175,12 +195,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:ClientSignOnStateChanged
      */
     ClientSignOnStateChanged(self: GM, userID: number, oldState: number, newState: number): void;
+
     /**
      * Called when derma menus are closed with [Global.CloseDermaMenus](https://wiki.facepunch.com/gmod/Global.CloseDermaMenus).
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/GM:CloseDermaMenus
      */
     CloseDermaMenus(self: GM): void;
+
     /**
      * Called whenever an entity becomes a clientside ragdoll.
      *
@@ -190,6 +212,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:CreateClientsideRagdoll
      */
     CreateClientsideRagdoll(self: GM, entity: Entity, ragdoll: Entity): void;
+
     /**
      * Called when a serverside ragdoll of an entity has been created.
      *
@@ -199,6 +222,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:CreateEntityRagdoll
      */
     CreateEntityRagdoll(self: GM, owner: Entity, ragdoll: Entity): void;
+
     /**
      * Allows you to change the players movements before they're sent to the server.
      *
@@ -211,6 +235,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:CreateMove
      */
     CreateMove(self: GM, cmd: CUserCmd): boolean;
+
     /**
      * Teams are created within this hook using [team.SetUp](https://wiki.facepunch.com/gmod/team.SetUp).
      *
@@ -220,12 +245,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:CreateTeams
      */
     CreateTeams(self: GM): void;
+
     /**
      * Called upon an animation event, this is the ideal place to call player animation functions such as [Player:AddVCDSequenceToGestureSlot](https://wiki.facepunch.com/gmod/Player:AddVCDSequenceToGestureSlot), [Player:AnimRestartGesture](https://wiki.facepunch.com/gmod/Player:AnimRestartGesture) and so on.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:DoAnimationEvent
      */
     DoAnimationEvent(self: GM, ply: Player, event: number, data?: number): number;
+
     /**
      * Handles the player's death.
      *
@@ -242,18 +269,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:DoPlayerDeath
      */
     DoPlayerDeath(self: GM, ply: Player, attacker: Entity, dmg: CTakeDamageInfo): void;
+
     /**
      * This hook is called every frame to draw all of the current death notices.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:DrawDeathNotice
      */
     DrawDeathNotice(self: GM, x: number, y: number): void;
+
     /**
      * Called every frame before drawing the in-game monitors ( Breencast, in-game TVs, etc ), but doesn't seem to be doing anything, trying to render 2D or 3D elements fail.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:DrawMonitors
      */
     DrawMonitors(self: GM): void;
+
     /**
      * Called after all other 2D draw hooks are called. Draws over all VGUI Panels and HUDs.
      *
@@ -267,6 +297,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:DrawOverlay
      */
     DrawOverlay(self: GM): void;
+
     /**
      * Allows you to override physgun effects rendering.
      *
@@ -277,12 +308,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:DrawPhysgunBeam
      */
     DrawPhysgunBeam(self: GM, ply: Player, physgun: Weapon, enabled: boolean, target: Entity, physBone: number, hitPos: Vector): boolean;
+
     /**
      * Called right before an entity stops driving. Overriding this hook will cause it to not call [drive.End](https://wiki.facepunch.com/gmod/drive.End) and the player will not stop driving.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:EndEntityDriving
      */
     EndEntityDriving(self: GM, ent: Entity, ply: Player): void;
+
     /**
      * Called whenever a sound has been played. This will not be called clientside if the server played the sound without the client also calling [Entity:EmitSound](https://wiki.facepunch.com/gmod/Entity:EmitSound).
      *
@@ -290,6 +323,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:EntityEmitSound
      */
     EntityEmitSound(self: GM, data: EmitSoundInfo): boolean;
+
     /**
      * Called every time a bullet is about to be fired from an entity, which allows to completely modify the bullet structure before the bullet is actually fired.
      *
@@ -302,6 +336,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:EntityFireBullets
      */
     EntityFireBullets(self: GM, entity: Entity, data: Bullet): boolean;
+
     /**
      * Called when a key-value pair is set on an entity on map spawn. Is **not** called by [Entity:SetKeyValue](https://wiki.facepunch.com/gmod/Entity:SetKeyValue).
      *
@@ -311,6 +346,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:EntityKeyValue
      */
     EntityKeyValue(self: GM, ent: Entity, key: string, value: string): string;
+
     /**
      * Called when an NW2Var is changed.
      * If a NW2Var is set on an entity that is based on a Lua Entity could result in the NW2Var being mixed up with other ones and being updated multiple times.
@@ -324,6 +360,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:EntityNetworkedVarChanged
      */
     EntityNetworkedVarChanged(self: GM, ent: Entity, name: string, oldval: any, newval: any): void;
+
     /**
      * 		Called right before removal of an entity.
      * 		**WARNING**: This hook is called clientside during full updates due to how networking works in the Source Engine.
@@ -335,6 +372,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:EntityRemoved
      */
     EntityRemoved(self: GM, ent: Entity, fullUpdate: boolean): void;
+
     /**
      * Called when an entity is about to take damage. You can modify all parts of the damage info in this hook or completely block the damage event.
      *
@@ -347,6 +385,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:EntityTakeDamage
      */
     EntityTakeDamage(self: GM, target: Entity, dmg: CTakeDamageInfo): boolean;
+
     /**
      * This hook polls the entity the player use action should be applied to.
      *
@@ -357,12 +396,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:FindUseEntity
      */
     FindUseEntity(self: GM, ply: Player, defaultEnt: Entity): Entity;
+
     /**
      * Runs when user cancels/finishes typing.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:FinishChat
      */
     FinishChat(self: GM): void;
+
     /**
      * Called after [GM:Move](https://wiki.facepunch.com/gmod/GM:Move), applies all the changes from the [CMoveData](https://wiki.facepunch.com/gmod/CMoveData) to the player.
      *
@@ -372,6 +413,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:FinishMove
      */
     FinishMove(self: GM, ply: Player, mv: CMoveData): boolean;
+
     /**
      * Called to allow override of the default Derma skin for all panels.
      *
@@ -384,6 +426,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:ForceDermaSkin
      */
     ForceDermaSkin(self: GM): string;
+
     /**
      * Called when the mouse has been double clicked on any panel derived from CGModBase, such as the panel used by [gui.EnableScreenClicker](https://wiki.facepunch.com/gmod/gui.EnableScreenClicker) and the panel used by [Panel:ParentToHUD](https://wiki.facepunch.com/gmod/Panel:ParentToHUD).
      *
@@ -393,6 +436,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:GUIMouseDoublePressed
      */
     GUIMouseDoublePressed(self: GM, mouseCode: number, aimVector: Vector): void;
+
     /**
      * Called whenever a players presses a mouse key on the context menu in Sandbox or on any panel derived from CGModBase, such as the panel used by [gui.EnableScreenClicker](https://wiki.facepunch.com/gmod/gui.EnableScreenClicker) and the panel used by [Panel:ParentToHUD](https://wiki.facepunch.com/gmod/Panel:ParentToHUD).
      *
@@ -402,18 +446,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:GUIMousePressed
      */
     GUIMousePressed(self: GM, mouseCode: number, aimVector: Vector): void;
+
     /**
      * Called whenever a players releases a mouse key on the context menu in Sandbox or on any panel derived from CGModBase, such as the panel used by [gui.EnableScreenClicker](https://wiki.facepunch.com/gmod/gui.EnableScreenClicker) and the panel used by [Panel:ParentToHUD](https://wiki.facepunch.com/gmod/Panel:ParentToHUD).
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:GUIMouseReleased
      */
     GUIMouseReleased(self: GM, mouseCode: number, aimVector: Vector): void;
+
     /**
      * Called when game content has been changed, for example an addon or a mountable game was (un)mounted.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/GM:GameContentChanged
      */
     GameContentChanged(self: GM): void;
+
     /**
      * An internal function used to get an untranslated string to show in the kill feed as the entity's name. See [GM:SendDeathNotice](https://wiki.facepunch.com/gmod/GM:SendDeathNotice)
      *
@@ -421,12 +468,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:GetDeathNoticeEntityName
      */
     GetDeathNoticeEntityName(self: GM, name: string | Entity): string;
+
     /**
      * Called when a player takes damage from falling, allows to override the damage.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:GetFallDamage
      */
     GetFallDamage(self: GM, ply: Player, speed: number): number;
+
     /**
      * Called when the game(server) needs to update the text shown in the server browser as the gamemode. Runs at a ~2s interval, runs even when the server is hibernating.
      *
@@ -439,12 +488,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:GetGameDescription
      */
     GetGameDescription(self: GM): string;
+
     /**
      * Allows you to modify the Source Engine's motion blur shaders.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:GetMotionBlurValues
      */
     GetMotionBlurValues(self: GM, horizontal: number, vertical: number, forward: number, rotational: number): (number, number, number, number);
+
     /**
      * Called to determine preferred carry angles for the entity. It works for both, +use pickup and gravity gun pickup.
      *
@@ -458,24 +509,28 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:GetPreferredCarryAngles
      */
     GetPreferredCarryAngles(self: GM, ent: Entity, ply: Player): Angle;
+
     /**
      * Returns the color for the given entity's team. This is used in chat and deathnotice text.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:GetTeamColor
      */
     GetTeamColor(self: GM, ent: Entity): Color;
+
     /**
      * Returns the team color for the given team index.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:GetTeamNumColor
      */
     GetTeamNumColor(self: GM, team: number): Color;
+
     /**
      * Override this hook to disable/change ear-grabbing in your gamemode. By default, it is not called anywhere on the server.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:GrabEarAnimation
      */
     GrabEarAnimation(self: GM, ply: Player): void;
+
     /**
      * Called when an entity is released by a gravity gun.
      *
@@ -485,6 +540,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:GravGunOnDropped
      */
     GravGunOnDropped(self: GM, ply: Player, ent: Entity): void;
+
     /**
      * Called when an entity is picked up by a gravity gun.
      *
@@ -495,6 +551,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:GravGunOnPickedUp
      */
     GravGunOnPickedUp(self: GM, ply: Player, ent: Entity): void;
+
     /**
      * Called every tick to poll whether a player is allowed to pick up an entity with the gravity gun or not.
      *
@@ -507,6 +564,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:GravGunPickupAllowed
      */
     GravGunPickupAllowed(self: GM, ply: Player, ent: Entity): boolean;
+
     /**
      * Called when an entity is about to be punted with the gravity gun (primary fire).
      *
@@ -516,18 +574,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:GravGunPunt
      */
     GravGunPunt(self: GM, ply: Player, ent: Entity): boolean;
+
     /**
      * Called when the client has picked up ammo. Override to disable default HUD notification.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:HUDAmmoPickedUp
      */
     HUDAmmoPickedUp(self: GM, itemName: string, amount: number): void;
+
     /**
      * Renders the HUD pick-up history. Override to hide default or draw your own HUD.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:HUDDrawPickupHistory
      */
     HUDDrawPickupHistory(self: GM): void;
+
     /**
      * Called every frame to render the scoreboard.
      *
@@ -540,18 +601,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:HUDDrawScoreBoard
      */
     HUDDrawScoreBoard(self: GM): void;
+
     /**
      * Called from [GM:HUDPaint](https://wiki.facepunch.com/gmod/GM:HUDPaint) to draw player info when you hover over a player with your crosshair or mouse.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:HUDDrawTargetID
      */
     HUDDrawTargetID(self: GM): boolean;
+
     /**
      * Called when an item has been picked up. Override to disable the default HUD notification.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:HUDItemPickedUp
      */
     HUDItemPickedUp(self: GM, itemName: string): void;
+
     /**
      * 		Called whenever the HUD should be drawn.
      *
@@ -568,6 +632,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:HUDPaint
      */
     HUDPaint(self: GM): void;
+
     /**
      * Called before [GM:HUDPaint](https://wiki.facepunch.com/gmod/GM:HUDPaint) when the HUD background is being drawn.
      *
@@ -581,6 +646,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:HUDPaintBackground
      */
     HUDPaintBackground(self: GM): void;
+
     /**
      * Called when the Gamemode is about to draw a given element on the client's HUD (heads-up display).
      *
@@ -591,12 +657,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:HUDShouldDraw
      */
     HUDShouldDraw(self: GM, name: string): boolean;
+
     /**
      * Called when a weapon has been picked up. Override to disable the default HUD notification.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:HUDWeaponPickedUp
      */
     HUDWeaponPickedUp(self: GM, weapon: Weapon): void;
+
     /**
      * Called to handle player armor reduction, when player receives damage.
      *
@@ -606,54 +674,63 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:HandlePlayerArmorReduction
      */
     HandlePlayerArmorReduction(self: GM, ply: Player, dmginfo: CTakeDamageInfo): void;
+
     /**
      * Allows to override player driving animations.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:HandlePlayerDriving
      */
     HandlePlayerDriving(self: GM, ply: Player): boolean;
+
     /**
      * Allows to override player crouch animations.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:HandlePlayerDucking
      */
     HandlePlayerDucking(self: GM, ply: Player, velocity: Vector): boolean;
+
     /**
      * Called every frame by the player model animation system. Allows to override player jumping animations.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:HandlePlayerJumping
      */
     HandlePlayerJumping(self: GM, ply: Player, velocity: Vector): boolean;
+
     /**
      * Called every frame by the player model animation system. Allows to override player landing animations.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:HandlePlayerLanding
      */
     HandlePlayerLanding(self: GM, ply: Player, velocity: Vector, onGround: boolean): boolean;
+
     /**
      * Allows to override player noclip animations.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:HandlePlayerNoClipping
      */
     HandlePlayerNoClipping(self: GM, ply: Player, velocity: Vector): boolean;
+
     /**
      * Allows to override player swimming animations.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:HandlePlayerSwimming
      */
     HandlePlayerSwimming(self: GM, ply: Player, velocity: Vector): boolean;
+
     /**
      * Allows to override player flying ( in mid-air, not noclipping ) animations.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:HandlePlayerVaulting
      */
     HandlePlayerVaulting(self: GM, ply: Player, velocity: Vector): boolean;
+
     /**
      * Hides the team selection panel.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:HideTeam
      */
     HideTeam(self: GM): void;
+
     /**
      * Called after all the entities are initialized. Starting from this hook [Global.LocalPlayer](https://wiki.facepunch.com/gmod/Global.LocalPlayer) will return valid object.
      *
@@ -664,6 +741,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:InitPostEntity
      */
     InitPostEntity(self: GM): void;
+
     /**
      * Called after the gamemode loads and starts.
      *
@@ -672,18 +750,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:Initialize
      */
     Initialize(self: GM): void;
+
     /**
      * Allows you to modify the supplied User Command with mouse input. This could be used to make moving the mouse do funky things to view angles.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:InputMouseApply
      */
     InputMouseApply(self: GM, cmd: CUserCmd, x: number, y: number, ang: Angle): boolean;
+
     /**
      * Check if a player can spawn at a certain spawnpoint.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:IsSpawnpointSuitable
      */
     IsSpawnpointSuitable(self: GM, ply: Player, spawnpoint: Entity, makeSuitable: boolean): boolean;
+
     /**
      * Called whenever a player pressed a key included within the IN keys.
      *
@@ -699,6 +780,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:KeyPress
      */
     KeyPress(self: GM, ply: Player, key: number): void;
+
     /**
      * Runs when a IN key was released by a player.
      *
@@ -711,6 +793,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:KeyRelease
      */
     KeyRelease(self: GM, ply: Player, key: number): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      * Called from `gm_load` when the game should load a map.
@@ -718,24 +801,28 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:LoadGModSave
      */
     LoadGModSave(self: GM, data: string, map: string, timestamp: number): void;
+
     /**
      * Called while an addon from the Steam workshop is downloading. Used by default to update details on the fancy workshop download panel.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/GM:LoadGModSaveFailed
      */
     LoadGModSaveFailed(self: GM, reason: string, workshopid: string): void;
+
     /**
      * Called when `menu.lua` has finished loading.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/GM:MenuStart
      */
     MenuStart(self: GM): void;
+
     /**
      * Override this gamemode function to disable mouth movement when talking on voice chat. By default, it is not called anywhere on the server.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:MouthMoveAnimation
      */
     MouthMoveAnimation(self: GM, ply: Player): void;
+
     /**
      * The Move hook is called for you to manipulate the player's MoveData.
      *
@@ -751,18 +838,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:Move
      */
     Move(self: GM, ply: Player, mv: CMoveData): boolean;
+
     /**
      * Returning true in this hook will cause it to render depth buffers defined with [render.GetResolvedFullFrameDepth](https://wiki.facepunch.com/gmod/render.GetResolvedFullFrameDepth).
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:NeedsDepthPass
      */
     NeedsDepthPass(self: GM): boolean;
+
     /**
      * Called when an entity has been created over the network.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:NetworkEntityCreated
      */
     NetworkEntityCreated(self: GM, ent: Entity): void;
+
     /**
      * Called when a player's SteamID has been validated by Steam.
      *
@@ -775,6 +865,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:NetworkIDValidated
      */
     NetworkIDValidated(self: GM, name: string, steamID: string, ownerID: string): void;
+
     /**
      * Called whenever this entity changes its transmission state for this [Global.LocalPlayer](https://wiki.facepunch.com/gmod/Global.LocalPlayer), such as exiting or re entering the [PVS (Potential Visibility Set)](https://developer.valvesoftware.com/wiki/PVS "PVS - Valve Developer Community").
      *
@@ -787,12 +878,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:NotifyShouldTransmit
      */
     NotifyShouldTransmit(self: GM, entity: Entity, shouldtransmit: boolean): void;
+
     /**
      * Called when a player has achieved an achievement. You can get the name and other information from an achievement ID with the [achievements](https://wiki.facepunch.com/gmod/achievements) library.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:OnAchievementAchieved
      */
     OnAchievementAchieved(self: GM, ply: Player, achievement: number): void;
+
     /**
      * 	Called when the local player presses TAB while having their chatbox opened.
      *
@@ -803,12 +896,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnChatTab
      */
     OnChatTab(self: GM, text: string): string;
+
     /**
      * Called when the player cleans up something.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:OnCleanup
      */
     OnCleanup(self: GM, name: string): boolean;
+
     /**
      *         Called on the server when a Lua error occurs on a client and is sent to the server.
      *
@@ -826,12 +921,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnClientLuaError
      */
     OnClientLuaError(self: GM, error: string, ply: Player, stack: table, name: string): void;
+
     /**
      * Called when a caption/subtitle has been emitted to the closed caption box.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:OnCloseCaptionEmit
      */
     OnCloseCaptionEmit(self: GM, soundScript: string, duration: number, fromPlayer: boolean, fullText: string): boolean;
+
     /**
      * Called when the context menu keybind (+menu_context) is released, which by default is C.
      *
@@ -843,6 +940,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnContextMenuClose
      */
     OnContextMenuClose(self: GM): void;
+
     /**
      * Called when the context menu keybind (`+menu_context`) is pressed, which by default is C.
      *
@@ -852,18 +950,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnContextMenuOpen
      */
     OnContextMenuOpen(self: GM): void;
+
     /**
      * Called when the crazy physics detection detects an entity with crazy physics, i.e. position being far outside of the map, velocities being near or at infinity, etc. The primary reason for this system is to prevent program crashes in physics engine.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:OnCrazyPhysics
      */
     OnCrazyPhysics(self: GM, ent: Entity, physobj: PhysObj): void;
+
     /**
      * Called when a player has been hurt by an explosion. Override to disable default sound effect.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:OnDamagedByExplosion
      */
     OnDamagedByExplosion(self: GM, ply: Player, dmginfo: CTakeDamageInfo): void;
+
     /**
      * Called as soon as the entity is created. Very little of the entity's properties will be initialized at this stage. (keyvalues, classname, flags, anything), especially on the serverside.
      *
@@ -874,6 +975,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnEntityCreated
      */
     OnEntityCreated(self: GM, entity: Entity): void;
+
     /**
      * Called when the [Entity:WaterLevel](https://wiki.facepunch.com/gmod/Entity:WaterLevel) of an entity is changed.
      *
@@ -892,6 +994,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnEntityWaterLevelChanged
      */
     OnEntityWaterLevelChanged(self: GM, entity: Entity, old: number, _new: number): void;
+
     /**
      * Called when the gamemode is loaded. [gmod.GetGamemode](https://wiki.facepunch.com/gmod/gmod.GetGamemode) will be functional at this point.
      *
@@ -901,6 +1004,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnGamemodeLoaded
      */
     OnGamemodeLoaded(self: GM): void;
+
     /**
      * Called when a Lua error occurs.
      * If you want to retrieve client errors on the server side, you can use this hook: [GM:OnClientLuaError](https://wiki.facepunch.com/gmod/GM:OnClientLuaError)
@@ -911,6 +1015,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnLuaError
      */
     OnLuaError(self: GM, error: string, realm: string, stack: table, name: string, id: string): void;
+
     /**
      * Called whenever an NPC drops an item upon its death, such as health kits, armor batteries, etc.
      *
@@ -923,12 +1028,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnNPCDropItem
      */
     OnNPCDropItem(self: GM, npc: NPC, item: Entity): void;
+
     /**
      * Called whenever an NPC is killed.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:OnNPCKilled
      */
     OnNPCKilled(self: GM, npc: NPC, attacker: Entity, inflictor: Entity): void;
+
     /**
      * 		Called when a Addon Conflict occurs, only works in the Menu realm.
      *
@@ -936,6 +1043,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnNotifyAddonConflict
      */
     OnNotifyAddonConflict(self: GM, addon1: string, addon2: string, fileName: string): void;
+
     /**
      * 	Called when the main menu has been blocked by [GM:OnPauseMenuShow](https://wiki.facepunch.com/gmod/GM:OnPauseMenuShow) four times in a small interval. This is used internally to explain to the user that they can hold SHIFT to force open the main menu.
      *
@@ -943,6 +1051,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnPauseMenuBlockedTooManyTimes
      */
     OnPauseMenuBlockedTooManyTimes(self: GM): void;
+
     /**
      * 	Called when the pause menu is attempting to be opened. Allows you to prevent the main menu from being opened that time.
      *
@@ -952,6 +1061,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnPauseMenuShow
      */
     OnPauseMenuShow(self: GM): boolean;
+
     /**
      * 		Called when a permission gets Granted or Revoked.
      *
@@ -959,6 +1069,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnPermissionsChanged
      */
     OnPermissionsChanged(self: GM): void;
+
     /**
      * Called when a player freezes an entity with the physgun.
      *
@@ -966,6 +1077,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnPhysgunFreeze
      */
     OnPhysgunFreeze(self: GM, weapon: Entity, physobj: PhysObj, ent: Entity, ply: Player): boolean;
+
     /**
      * Called to when a player has successfully picked up an entity with their Physics Gun.
      *
@@ -980,12 +1092,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnPhysgunPickup
      */
     OnPhysgunPickup(self: GM, ply: Player, ent: Entity): void;
+
     /**
      * Called when a player reloads with the physgun. Override this to disable default unfreezing behavior.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:OnPhysgunReload
      */
     OnPhysgunReload(self: GM, physgun: Weapon, ply: Player): boolean;
+
     /**
      * Called when a player has changed team using [GM:PlayerJoinTeam](https://wiki.facepunch.com/gmod/GM:PlayerJoinTeam).
      *
@@ -997,6 +1111,7 @@ interface GM {
      * @deprecated Use GM:PlayerChangedTeam instead, which works for every Player:SetTeam call.
      */
     OnPlayerChangedTeam(self: GM, ply: Player, oldTeam: number, newTeam: number): void;
+
     /**
      * Called whenever a player sends a chat message. For the serverside equivalent, see [GM:PlayerSay](https://wiki.facepunch.com/gmod/GM:PlayerSay).
      * **NOTE**: The input (or suppression) of this hook is based on the output from [GM:PlayerSay](https://wiki.facepunch.com/gmod/GM:PlayerSay). Chat events suppressed serverside do not call this hook.
@@ -1006,24 +1121,28 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnPlayerChat
      */
     OnPlayerChat(self: GM, ply: Player, text: string, teamChat: boolean, isDead: boolean): boolean;
+
     /**
      * Called when a player makes contact with the ground after a jump or a fall.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:OnPlayerHitGround
      */
     OnPlayerHitGround(self: GM, player: Entity, inWater: boolean, onFloater: boolean, speed: number): boolean;
+
     /**
      * Called when a player jumps.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:OnPlayerJump
      */
     OnPlayerJump(self: GM, player: Entity, speed: number): void;
+
     /**
      * Called when a player +use drops an entity.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:OnPlayerPhysicsDrop
      */
     OnPlayerPhysicsDrop(self: GM, ply: Player, ent: Entity, thrown: boolean): void;
+
     /**
      * Called when a player +use pickups up an entity. This will be called after the entity passes though [GM:AllowPlayerPickup](https://wiki.facepunch.com/gmod/GM:AllowPlayerPickup).
      *
@@ -1034,6 +1153,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnPlayerPhysicsPickup
      */
     OnPlayerPhysicsPickup(self: GM, ply: Player, ent: Entity): void;
+
     /**
      * Called when gamemode has been reloaded by auto refresh.
      *
@@ -1044,6 +1164,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnReloaded
      */
     OnReloaded(self: GM): void;
+
     /**
      * Called when the player's screen resolution of the game changes. This also called when changing MSAA settings.
      *
@@ -1053,18 +1174,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnScreenSizeChanged
      */
     OnScreenSizeChanged(self: GM, oldWidth: number, oldHeight: number, newWidth: number, newHeight: number): void;
+
     /**
      * Called when a player releases the `+menu` bind on their keyboard, which is bound to Q by default.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:OnSpawnMenuClose
      */
     OnSpawnMenuClose(self: GM): void;
+
     /**
      * Called when a player presses the `+menu` bind on their keyboard, which is bound to Q by default.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:OnSpawnMenuOpen
      */
     OnSpawnMenuOpen(self: GM): void;
+
     /**
      * Called when a [DTextEntry](https://wiki.facepunch.com/gmod/DTextEntry) gets focus.
      *
@@ -1074,18 +1198,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnTextEntryGetFocus
      */
     OnTextEntryGetFocus(self: GM, panel: Panel): void;
+
     /**
      * Called when a [DTextEntry](https://wiki.facepunch.com/gmod/DTextEntry) loses focus.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:OnTextEntryLoseFocus
      */
     OnTextEntryLoseFocus(self: GM, panel: Panel): void;
+
     /**
      * Called when the player undoes something.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:OnUndo
      */
     OnUndo(self: GM, name: string, customText: string): boolean;
+
     /**
      * Called when the player changes their weapon to another one - and their viewmodel model changes.
      *
@@ -1095,6 +1222,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:OnViewModelChanged
      */
     OnViewModelChanged(self: GM, viewmodel: Entity, oldModel: string, newModel: string): void;
+
     /**
      * Called when a player drops an entity with the Physgun.
      *
@@ -1104,6 +1232,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PhysgunDrop
      */
     PhysgunDrop(self: GM, player: Player, entity: Entity): void;
+
     /**
      * Called to determine if a player should be able to pick up an entity with the Physics Gun.
      *
@@ -1116,6 +1245,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PhysgunPickup
      */
     PhysgunPickup(self: GM, player: Player, entity: Entity): boolean;
+
     /**
      * Called after player's reserve ammo count changes.
      *
@@ -1123,6 +1253,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerAmmoChanged
      */
     PlayerAmmoChanged(self: GM, ply: Player, ammoID: number, oldCount: number, newCount: number): void;
+
     /**
      * Called after the player gets their [Player:UniqueID](https://wiki.facepunch.com/gmod/Player:UniqueID) set for the first time. This hook will also be called in singleplayer.
      *
@@ -1132,6 +1263,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerAuthed
      */
     PlayerAuthed(self: GM, ply: Player, steamid: string, uniqueid: string): void;
+
     /**
      * Runs when a bind has been pressed. Allows to block commands.
      *
@@ -1148,6 +1280,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerBindPress
      */
     PlayerBindPress(self: GM, ply: Player, bind: string, pressed: boolean, code: number): boolean;
+
     /**
      * Called when a player presses a button.
      *
@@ -1160,6 +1293,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerButtonDown
      */
     PlayerButtonDown(self: GM, ply: Player, button: BUTTON_CODE): void;
+
     /**
      * Called when a player releases a button.
      *
@@ -1172,6 +1306,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerButtonUp
      */
     PlayerButtonUp(self: GM, ply: Player, button: BUTTON_CODE): void;
+
     /**
      * Decides whether a player can hear another player using voice chat.
      *
@@ -1183,6 +1318,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerCanHearPlayersVoice
      */
     PlayerCanHearPlayersVoice(self: GM, listener: Player, talker: Player): (boolean, boolean);
+
     /**
      * 		Returns whether or not a player is allowed to join a team
      * 		**WARNING**: This hook will not work with [hook.Add](https://wiki.facepunch.com/gmod/hook.Add) and it is only called manually from [GM:PlayerJoinTeam](https://wiki.facepunch.com/gmod/GM:PlayerJoinTeam) by the base gamemode
@@ -1192,6 +1328,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerCanJoinTeam
      */
     PlayerCanJoinTeam(self: GM, ply: Player, team: number): boolean;
+
     /**
      * Returns whether or not a player is allowed to pick an item up. (ammo, health, armor)
      *
@@ -1203,6 +1340,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerCanPickupItem
      */
     PlayerCanPickupItem(self: GM, ply: Player, item: Entity): boolean;
+
     /**
      * 	Returns whether or not a player is allowed to pick up a weapon.
      *
@@ -1216,6 +1354,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerCanPickupWeapon
      */
     PlayerCanPickupWeapon(self: GM, ply: Player, weapon: Weapon): boolean;
+
     /**
      * Returns whether or not the player can see the other player's chat.
      * **NOTE**: The **speaker** parameter does not have to be a valid [Player](https://wiki.facepunch.com/gmod/Player) object which happens when console messages are displayed for example.
@@ -1224,6 +1363,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerCanSeePlayersChat
      */
     PlayerCanSeePlayersChat(self: GM, text: string, teamOnly: boolean, listener: Player, speaker: Player): boolean;
+
     /**
      * Called when a player has changed team using [Player:SetTeam](https://wiki.facepunch.com/gmod/Player:SetTeam).
      * 	**WARNING**: Avoid calling [Player:SetTeam](https://wiki.facepunch.com/gmod/Player:SetTeam) in this hook as it may cause an infinite loop!
@@ -1235,6 +1375,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerChangedTeam
      */
     PlayerChangedTeam(self: GM, ply: Player, oldTeam: number, newTeam: number): void;
+
     /**
      * Called whenever a player is about to spawn something to see if they hit a limit for whatever they are spawning.
      * 	**NOTE**: This hook will not be called in singleplayer, as singleplayer does not have limits.
@@ -1243,6 +1384,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerCheckLimit
      */
     PlayerCheckLimit(self: GM, ply: Player, limitName: string, current: number, defaultMax: number): boolean;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -1253,6 +1395,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerClassChanged
      */
     PlayerClassChanged(self: GM, ply: Player, newID: number): void;
+
     /**
      * Executes when a player connects to the server. Called before the player has been assigned a [UserID](https://wiki.facepunch.com/gmod/Player:UserID) and entity. See the [player_connect](https://wiki.facepunch.com/gmod/gameevent/player_connect) gameevent for a version of this hook called after the player entity has been created.
      *
@@ -1265,6 +1408,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerConnect
      */
     PlayerConnect(self: GM, name: string, ip: string): void;
+
     /**
      * Called when a player is killed by [Player:Kill](https://wiki.facepunch.com/gmod/Player:Kill) or any other normal means.
      *
@@ -1283,12 +1427,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerDeath
      */
     PlayerDeath(self: GM, victim: Player, inflictor: Entity, attacker: Entity): void;
+
     /**
      * Returns whether or not the default death sound should be muted.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:PlayerDeathSound
      */
     PlayerDeathSound(self: GM, ply: Player): boolean;
+
     /**
      * Called every think while the player is dead. The return value will determine if the player respawns.
      *
@@ -1300,6 +1446,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerDeathThink
      */
     PlayerDeathThink(self: GM, ply: Player): boolean;
+
     /**
      * Called when a player leaves the server. See the [player_disconnect gameevent](https://wiki.facepunch.com/gmod/gameevent/player_disconnect) for a shared version of this hook.
      *
@@ -1309,12 +1456,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerDisconnected
      */
     PlayerDisconnected(self: GM, ply: Player): void;
+
     /**
      * Called to update the player's animation during a drive.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:PlayerDriveAnimate
      */
     PlayerDriveAnimate(self: GM, ply: Player): void;
+
     /**
      * Called when a weapon is dropped by a player via [Player:DropWeapon](https://wiki.facepunch.com/gmod/Player:DropWeapon). Despite its name, this hook is also called for NPC weapon drops.
      *
@@ -1330,12 +1479,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerDroppedWeapon
      */
     PlayerDroppedWeapon(self: GM, owner: Player | NPC, wep: Weapon): void;
+
     /**
      * Called when player stops using voice chat.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:PlayerEndVoice
      */
     PlayerEndVoice(self: GM, ply: Player): void;
+
     /**
      * Called when a player enters a vehicle.
      *
@@ -1347,6 +1498,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerEnteredVehicle
      */
     PlayerEnteredVehicle(self: GM, ply: Player, veh: Vehicle, role: number): void;
+
     /**
      * Called before firing clientside animation events on a player model.
      *
@@ -1356,6 +1508,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerFireAnimationEvent
      */
     PlayerFireAnimationEvent(self: GM, ply: Player, pos: Vector, ang: Angle, event: number, name: string): boolean;
+
     /**
      * Called whenever a player steps. Return true to mute the normal sound.
      *
@@ -1367,12 +1520,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerFootstep
      */
     PlayerFootstep(self: GM, ply: Player, pos: Vector, foot: number, sound: string, volume: number, filter: CRecipientFilter): boolean;
+
     /**
      * Called when a player freezes an object.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:PlayerFrozeObject
      */
     PlayerFrozeObject(self: GM, ply: Player, ent: Entity, physobj: PhysObj): void;
+
     /**
      * Called before firing serverside animation events on the player models.
      *
@@ -1382,12 +1537,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerHandleAnimEvent
      */
     PlayerHandleAnimEvent(self: GM, ply: Player, event: number, eventTime: number, cycle: number, type: number, options: string): void;
+
     /**
      * Called when a player gets hurt.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:PlayerHurt
      */
     PlayerHurt(self: GM, victim: Player, attacker: Entity, healthRemaining: number, damageTaken: number): void;
+
     /**
      * Called when the player spawns for the first time.
      *
@@ -1438,12 +1595,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerInitialSpawn
      */
     PlayerInitialSpawn(self: GM, player: Player, transition: boolean): void;
+
     /**
      * Makes the player join a specified team. This is a convenience function that calls [Player:SetTeam](https://wiki.facepunch.com/gmod/Player:SetTeam) and runs the [GM:OnPlayerChangedTeam](https://wiki.facepunch.com/gmod/GM:OnPlayerChangedTeam) hook.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:PlayerJoinTeam
      */
     PlayerJoinTeam(self: GM, ply: Player, team: number): void;
+
     /**
      * Called when a player leaves a vehicle for any reason, including [Player:ExitVehicle](https://wiki.facepunch.com/gmod/Player:ExitVehicle).
      *
@@ -1456,6 +1615,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerLeaveVehicle
      */
     PlayerLeaveVehicle(self: GM, ply: Player, veh: Vehicle): void;
+
     /**
      * Called to give players the default set of weapons.
      *
@@ -1467,6 +1627,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerLoadout
      */
     PlayerLoadout(self: GM, ply: Player): void;
+
     /**
      * Called when a player tries to switch noclip mode.
      *
@@ -1476,6 +1637,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerNoClip
      */
     PlayerNoClip(self: GM, ply: Player, desiredState: boolean): boolean;
+
     /**
      * Called after the player's think, just after [GM:FinishMove](https://wiki.facepunch.com/gmod/GM:FinishMove).
      *
@@ -1487,6 +1649,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerPostThink
      */
     PlayerPostThink(self: GM, ply: Player): void;
+
     /**
      * Request a player to join the team. This function will check if the team is available to join or not.
      *
@@ -1498,6 +1661,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerRequestTeam
      */
     PlayerRequestTeam(self: GM, ply: Player, team: number): void;
+
     /**
      * 		Called when a player dispatched a chat message. For the clientside equivalent, see [GM:OnPlayerChat](https://wiki.facepunch.com/gmod/GM:OnPlayerChat).
      *
@@ -1508,6 +1672,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerSay
      */
     PlayerSay(self: GM, sender: Player, text: string, teamChat: boolean): string;
+
     /**
      * 		Called to determine a spawn point for a player to spawn at.
      * 		**NOTE**: The spawn point entity will also impact the player's eye angle. For example, if the entity is upside down, the player's view will be as well.
@@ -1517,18 +1682,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerSelectSpawn
      */
     PlayerSelectSpawn(self: GM, ply: Player, transition: boolean): Entity;
+
     /**
      * Find a team spawn point entity for this player.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:PlayerSelectTeamSpawn
      */
     PlayerSelectTeamSpawn(self: GM, team: number, ply: Player): Entity;
+
     /**
      * Called whenever view model hands needs setting a model. By default this calls [PLAYER:GetHandsModel](https://wiki.facepunch.com/gmod/PLAYER:GetHandsModel) and if that fails, sets the hands model according to his player model.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:PlayerSetHandsModel
      */
     PlayerSetHandsModel(self: GM, ply: Player, ent: Entity): void;
+
     /**
      * Called whenever a player spawns and must choose a model. A good place to assign a model to a player.
      * **NOTE**: This function may not work in your custom gamemode if you have overridden your [GM:PlayerSpawn](https://wiki.facepunch.com/gmod/GM:PlayerSpawn) and you do not use [self.BaseClass.PlayerSpawn](https://wiki.facepunch.com/gmod/Global.DEFINE_BASECLASS) in it, or [hook.Call](https://wiki.facepunch.com/gmod/hook.Call) this hook from [GM:PlayerSpawn](https://wiki.facepunch.com/gmod/GM:PlayerSpawn).
@@ -1538,6 +1706,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerSetModel
      */
     PlayerSetModel(self: GM, ply: Player): void;
+
     /**
      * Returns true if the player should take damage from the given attacker.
      *
@@ -1548,12 +1717,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerShouldTakeDamage
      */
     PlayerShouldTakeDamage(self: GM, ply: Player, attacker: Entity): boolean;
+
     /**
      * Allows to suppress player taunts.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:PlayerShouldTaunt
      */
     PlayerShouldTaunt(self: GM, ply: Player, act: number): boolean;
+
     /**
      * Called when the player is killed by [Player:KillSilent](https://wiki.facepunch.com/gmod/Player:KillSilent).
      *
@@ -1569,6 +1740,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerSilentDeath
      */
     PlayerSilentDeath(self: GM, ply: Player): void;
+
     /**
      * Called whenever a player spawns, including respawns.
      *
@@ -1583,24 +1755,28 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerSpawn
      */
     PlayerSpawn(self: GM, player: Player, transition: boolean): void;
+
     /**
      * Called to spawn the player as a spectator.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:PlayerSpawnAsSpectator
      */
     PlayerSpawnAsSpectator(self: GM, ply: Player): void;
+
     /**
      * Determines if the player can spray using the `impulse 201` console command.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:PlayerSpray
      */
     PlayerSpray(self: GM, sprayer: Player): boolean;
+
     /**
      * Called when player starts taunting.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:PlayerStartTaunt
      */
     PlayerStartTaunt(self: GM, ply: Player, act: number, length: number): void;
+
     /**
      * Called when a player starts using voice chat.
      * **NOTE**: Set mp_show_voice_icons to 0, if you want disable icons above player.
@@ -1610,6 +1786,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerStartVoice
      */
     PlayerStartVoice(self: GM, ply: Player, plyIndex?: number): boolean;
+
     /**
      * Allows you to override the time between footsteps.
      *
@@ -1621,6 +1798,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerStepSoundTime
      */
     PlayerStepSoundTime(self: GM, ply: Player, type: number, walking: boolean): number;
+
     /**
      * Called whenever a player attempts to either turn on or off their flashlight, returning false will deny the change.
      * **NOTE**: Also gets called when using [Player:Flashlight](https://wiki.facepunch.com/gmod/Player:Flashlight).
@@ -1631,6 +1809,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerSwitchFlashlight
      */
     PlayerSwitchFlashlight(self: GM, ply: Player, enabled: boolean): boolean;
+
     /**
      * Called when a player attempts to switch their weapon.
      *
@@ -1640,6 +1819,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerSwitchWeapon
      */
     PlayerSwitchWeapon(self: GM, player: Player, oldWeapon: Weapon, newWeapon: Weapon): boolean;
+
     /**
      * The Move hook is called for you to manipulate the player's [CMoveData](https://wiki.facepunch.com/gmod/CMoveData). This hook is called moments before [GM:Move](https://wiki.facepunch.com/gmod/GM:Move) and [GM:PlayerNoClip](https://wiki.facepunch.com/gmod/GM:PlayerNoClip).
      *
@@ -1650,18 +1830,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerTick
      */
     PlayerTick(self: GM, player: Player, mv: CMoveData): void;
+
     /**
      * Called when a player has been hit by a trace and damaged (such as from a bullet). Returning true overrides the damage handling and prevents [GM:ScalePlayerDamage](https://wiki.facepunch.com/gmod/GM:ScalePlayerDamage) from being called.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:PlayerTraceAttack
      */
     PlayerTraceAttack(self: GM, ply: Player, dmginfo: CTakeDamageInfo, dir: Vector, trace: TraceResult): boolean;
+
     /**
      * Called when a player unfreezes an object.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:PlayerUnfrozeObject
      */
     PlayerUnfrozeObject(self: GM, ply: Player, ent: Entity, physobj: PhysObj): void;
+
     /**
      * Triggered when the player presses use on an object. Continuously runs until USE is released but will not activate other Entities until the USE key is released; dependent on activation type of the Entity.
      *
@@ -1669,12 +1852,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PlayerUse
      */
     PlayerUse(self: GM, ply: Player, ent: Entity): boolean;
+
     /**
      * Called when it's time to populate the context menu menu bar at the top.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:PopulateMenuBar
      */
     PopulateMenuBar(self: GM, menubar: Panel): void;
+
     /**
      * Called right after the map has cleaned up (usually because [game.CleanUpMap](https://wiki.facepunch.com/gmod/game.CleanUpMap) was called)
      *
@@ -1684,6 +1869,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PostCleanupMap
      */
     PostCleanupMap(self: GM): void;
+
     /**
      * Called right after the 2D skybox has been drawn - allowing you to draw over it.
      *
@@ -1693,6 +1879,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PostDraw2DSkyBox
      */
     PostDraw2DSkyBox(self: GM): void;
+
     /**
      * Called after rendering effects. This is where halos are drawn. Called just before [GM:PreDrawHUD](https://wiki.facepunch.com/gmod/GM:PreDrawHUD) (The two hooks are basically identical).
      *
@@ -1704,6 +1891,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PostDrawEffects
      */
     PostDrawEffects(self: GM): void;
+
     /**
      * Called after [GM:PreDrawHUD](https://wiki.facepunch.com/gmod/GM:PreDrawHUD),  [GM:HUDPaintBackground](https://wiki.facepunch.com/gmod/GM:HUDPaintBackground) and [GM:HUDPaint](https://wiki.facepunch.com/gmod/GM:HUDPaint) but before  [GM:DrawOverlay](https://wiki.facepunch.com/gmod/GM:DrawOverlay).
      *
@@ -1715,6 +1903,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PostDrawHUD
      */
     PostDrawHUD(self: GM): void;
+
     /**
      * Called after drawing opaque entities.
      *
@@ -1726,6 +1915,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PostDrawOpaqueRenderables
      */
     PostDrawOpaqueRenderables(self: GM, bDrawingDepth: boolean, bDrawingSkybox: boolean, isDraw3DSkybox: boolean): void;
+
     /**
      * Called after the player hands are drawn.
      *
@@ -1737,6 +1927,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PostDrawPlayerHands
      */
     PostDrawPlayerHands(self: GM, hands: Entity, vm: Entity, ply: Player, weapon: Weapon, flags: number): void;
+
     /**
      * Called after drawing the 3D skybox. This will not be called if skybox rendering was prevented via the [GM:PreDrawSkyBox](https://wiki.facepunch.com/gmod/GM:PreDrawSkyBox) hook.
      *
@@ -1748,6 +1939,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PostDrawSkyBox
      */
     PostDrawSkyBox(self: GM): void;
+
     /**
      * Called after all translucent entities are drawn.
      *
@@ -1762,6 +1954,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PostDrawTranslucentRenderables
      */
     PostDrawTranslucentRenderables(self: GM, bDrawingDepth: boolean, bDrawingSkybox: boolean, isDraw3DSkybox: boolean): void;
+
     /**
      * Called after view model is drawn.
      *
@@ -1778,6 +1971,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PostDrawViewModel
      */
     PostDrawViewModel(self: GM, viewmodel: Entity, player: Player, weapon: Weapon, flags: number): void;
+
     /**
      * Called every time a bullet pellet (i.e. this hook is called multiple times for a shotgun shot) is fired from an entity. Notably this hook will have the final damage and aim direction for the bullet pellet.
      *
@@ -1790,6 +1984,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PostEntityFireBullets
      */
     PostEntityFireBullets(self: GM, entity: Entity, data: FiredBullet): boolean;
+
     /**
      * Called when an entity receives a damage event, after passing damage filters, etc.
      *
@@ -1802,12 +1997,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PostEntityTakeDamage
      */
     PostEntityTakeDamage(self: GM, ent: Entity, dmginfo: CTakeDamageInfo, wasDamageTaken: boolean): void;
+
     /**
      * Called after the gamemode has loaded.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:PostGamemodeLoaded
      */
     PostGamemodeLoaded(self: GM): void;
+
     /**
      * Called right after [GM:DoPlayerDeath](https://wiki.facepunch.com/gmod/GM:DoPlayerDeath), [GM:PlayerDeath](https://wiki.facepunch.com/gmod/GM:PlayerDeath) and [GM:PlayerSilentDeath](https://wiki.facepunch.com/gmod/GM:PlayerSilentDeath).
      *
@@ -1821,6 +2018,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PostPlayerDeath
      */
     PostPlayerDeath(self: GM, ply: Player): void;
+
     /**
      * Called after a given player in your [PVS (Potential Visibility Set)](https://developer.valvesoftware.com/wiki/PVS "PVS - Valve Developer Community") was drawn.
      *
@@ -1831,18 +2029,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PostPlayerDraw
      */
     PostPlayerDraw(self: GM, ply: Player, flags: number): void;
+
     /**
      * Allows you to suppress post processing effect drawing.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:PostProcessPermitted
      */
     PostProcessPermitted(self: GM, effect_name: string): boolean;
+
     /**
      * Called after the frame has been rendered.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:PostRender
      */
     PostRender(self: GM): void;
+
     /**
      * Called after the VGUI has been drawn.
      *
@@ -1852,12 +2053,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PostRenderVGUI
      */
     PostRenderVGUI(self: GM): void;
+
     /**
      * Called just after performing an undo.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:PostUndo
      */
     PostUndo(self: GM, undo: Undo, count: number): void;
+
     /**
      * Called right before the map cleans up (usually because [game.CleanUpMap](https://wiki.facepunch.com/gmod/game.CleanUpMap) was called)
      *
@@ -1867,6 +2070,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PreCleanupMap
      */
     PreCleanupMap(self: GM): void;
+
     /**
      * Called just after [GM:PreDrawViewModel](https://wiki.facepunch.com/gmod/GM:PreDrawViewModel) and can technically be considered as a "PostDrawAllViewModels".
      *
@@ -1878,6 +2082,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PreDrawEffects
      */
     PreDrawEffects(self: GM): void;
+
     /**
      * Called just after [GM:PostDrawEffects](https://wiki.facepunch.com/gmod/GM:PostDrawEffects) (duplicate of it). Drawing anything in it seems to work incorrectly.
      *
@@ -1887,6 +2092,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PreDrawHUD
      */
     PreDrawHUD(self: GM): void;
+
     /**
      * Called before rendering the halos. This is the place to call [halo.Add](https://wiki.facepunch.com/gmod/halo.Add). This hook is actually running inside of [GM:PostDrawEffects](https://wiki.facepunch.com/gmod/GM:PostDrawEffects).
      *
@@ -1896,6 +2102,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PreDrawHalos
      */
     PreDrawHalos(self: GM): void;
+
     /**
      * Called before all opaque entities are drawn.
      *
@@ -1907,6 +2114,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PreDrawOpaqueRenderables
      */
     PreDrawOpaqueRenderables(self: GM, isDrawingDepth: boolean, isDrawSkybox: boolean, isDraw3DSkybox: boolean): boolean;
+
     /**
      * Called before the player hands are drawn.
      *
@@ -1917,6 +2125,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PreDrawPlayerHands
      */
     PreDrawPlayerHands(self: GM, hands: Entity, vm: Entity, ply: Player, weapon: Weapon, flags: number): boolean;
+
     /**
      * Called before the 3D sky box is drawn. This will not be called for maps with no 3D skybox, or when the 3d skybox is disabled. (`r_3dsky 0`)
      *
@@ -1928,6 +2137,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PreDrawSkyBox
      */
     PreDrawSkyBox(self: GM): boolean;
+
     /**
      * Called before all the translucent entities are drawn.
      *
@@ -1942,6 +2152,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PreDrawTranslucentRenderables
      */
     PreDrawTranslucentRenderables(self: GM, isDrawingDepth: boolean, isDrawSkybox: boolean, isDraw3DSkybox: boolean): boolean;
+
     /**
      * Called before the view model has been drawn.
      *
@@ -1958,6 +2169,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PreDrawViewModel
      */
     PreDrawViewModel(self: GM, vm: Entity, ply: Player, weapon: Weapon, flags: number): boolean;
+
     /**
      * Called just before all view models (there are 3 per player, see [Player:GetViewModel](https://wiki.facepunch.com/gmod/Player:GetViewModel)) and entities with `RENDERGROUP_VIEWMODEL` are drawn.
      *
@@ -1971,12 +2183,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PreDrawViewModels
      */
     PreDrawViewModels(self: GM): void;
+
     /**
      * Called before the gamemode is loaded.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:PreGamemodeLoaded
      */
     PreGamemodeLoaded(self: GM): void;
+
     /**
      * Called before the player is drawn.
      *
@@ -1986,6 +2200,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PrePlayerDraw
      */
     PrePlayerDraw(self: GM, player: Player, flags: number): boolean;
+
     /**
      * Called by [scripted_ents.Register](https://wiki.facepunch.com/gmod/scripted_ents.Register).
      *
@@ -1993,6 +2208,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PreRegisterSENT
      */
     PreRegisterSENT(self: GM, ent: table, _class: string): boolean;
+
     /**
      * Called when a Scripted Weapon (SWEP) is about to be registered, allowing addons to alter the weapon's SWEP table with custom data for later usage. Called internally from [weapons.Register](https://wiki.facepunch.com/gmod/weapons.Register).
      *
@@ -2000,30 +2216,35 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:PreRegisterSWEP
      */
     PreRegisterSWEP(self: GM, swep: table, _class: string): boolean;
+
     /**
      * Called before the renderer is about to start rendering the next frame.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:PreRender
      */
     PreRender(self: GM): boolean;
+
     /**
      * Called just before performing an undo.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:PreUndo
      */
     PreUndo(self: GM, undo: Undo): boolean;
+
     /**
      * This will prevent IN_ATTACK from sending to server when player tries to shoot from C menu.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:PreventScreenClicks
      */
     PreventScreenClicks(self: GM): boolean;
+
     /**
      * Called when a prop has been destroyed.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:PropBreak
      */
     PropBreak(self: GM, attacker: Player, prop: Entity): void;
+
     /**
      * Render the scene. Used by the `Stereoscopy` post-processing effect.
      *
@@ -2034,6 +2255,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:RenderScene
      */
     RenderScene(self: GM, origin: Vector, angles: Angle, fov: number): boolean;
+
     /**
      * Used to render post processing effects.
      *
@@ -2043,6 +2265,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:RenderScreenspaceEffects
      */
     RenderScreenspaceEffects(self: GM): void;
+
     /**
      * Called when the game is reloaded from a Source Engine save system ( not the Sandbox saves or dupes ).
      *
@@ -2052,6 +2275,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:Restored
      */
     Restored(self: GM): void;
+
     /**
      * Called when the game is saved using the Source Engine save system (not the Sandbox saves or dupes).
      *
@@ -2063,6 +2287,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:Saved
      */
     Saved(self: GM): void;
+
     /**
      * Called when an NPC takes damage.
      *
@@ -2073,6 +2298,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:ScaleNPCDamage
      */
     ScaleNPCDamage(self: GM, npc: NPC, hitgroup: number, dmginfo: CTakeDamageInfo): void;
+
     /**
      * This hook allows you to change how much damage a player receives when one takes damage to a specific body part.
      *
@@ -2083,18 +2309,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:ScalePlayerDamage
      */
     ScalePlayerDamage(self: GM, ply: Player, hitgroup: number, dmginfo: CTakeDamageInfo): boolean;
+
     /**
      * Called when player released the scoreboard button (TAB by default).
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:ScoreboardHide
      */
     ScoreboardHide(self: GM): void;
+
     /**
      * Called when player presses the scoreboard button (TAB by default).
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:ScoreboardShow
      */
     ScoreboardShow(self: GM): boolean;
+
     /**
      * An internal function used to send a death notice event to all clients.
      *
@@ -2102,6 +2331,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:SendDeathNotice
      */
     SendDeathNotice(self: GM, attacker: Entity | string | nil, inflictor: string, victim: Entity | string, flags: number): void;
+
     /**
      * Sets player run and sprint speeds.
      * Using a speed of `0` can lead to prediction errors, and can cause players to move at `sv_maxvelocity`
@@ -2112,6 +2342,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:SetPlayerSpeed
      */
     SetPlayerSpeed(self: GM, ply: Player, walkSpeed: number, runSpeed: number): void;
+
     /**
      * SetupMove is called before the engine process movements. This allows us to override the players movement.
      *
@@ -2121,12 +2352,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:SetupMove
      */
     SetupMove(self: GM, ply: Player, mv: CMoveData, cmd: CUserCmd): void;
+
     /**
      * Allows you to add extra positions to the player's [PVS (Potential Visibility Set)](https://developer.valvesoftware.com/wiki/PVS "PVS - Valve Developer Community"). This is the place to call [Global.AddOriginToPVS](https://wiki.facepunch.com/gmod/Global.AddOriginToPVS).
      * @realm server
      * @source https://wiki.facepunch.com/gmod/GM:SetupPlayerVisibility
      */
     SetupPlayerVisibility(self: GM, ply: Player, viewEntity: Entity): void;
+
     /**
      * 		Allows you to use render.Fog* functions to manipulate skybox fog.
      * 		This will not be called for maps with no 3D skybox, or when the 3d skybox is disabled. (`r_3dsky 0`)
@@ -2135,12 +2368,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:SetupSkyboxFog
      */
     SetupSkyboxFog(self: GM, scale: number): boolean;
+
     /**
      * Allows you to use render.Fog* functions to manipulate world fog.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:SetupWorldFog
      */
     SetupWorldFog(self: GM): boolean;
+
     /**
      * Called to decide whether a pair of entities should collide with each other. This is only called if [Entity:SetCustomCollisionCheck](https://wiki.facepunch.com/gmod/Entity:SetCustomCollisionCheck) was used on one or both entities.
      *
@@ -2157,6 +2392,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:ShouldCollide
      */
     ShouldCollide(self: GM, ent1: Entity, ent2: Entity): boolean;
+
     /**
      * Called to determine if the [Global.LocalPlayer](https://wiki.facepunch.com/gmod/Global.LocalPlayer) should be drawn.
      *
@@ -2169,6 +2405,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:ShouldDrawLocalPlayer
      */
     ShouldDrawLocalPlayer(self: GM, ply: Player): boolean;
+
     /**
      * Called when a player executes `gm_showhelp` console command. (Default bind is F1)
      *
@@ -2176,24 +2413,28 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:ShowHelp
      */
     ShowHelp(self: GM, ply: Player): void;
+
     /**
      * Called when a player executes `gm_showspare1` console command ( Default bind is F3 ).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:ShowSpare1
      */
     ShowSpare1(self: GM, ply: Player): void;
+
     /**
      * Called when a player executes `gm_showspare2` console command ( Default bind is F4 ).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:ShowSpare2
      */
     ShowSpare2(self: GM, ply: Player): void;
+
     /**
      * Called when a player executes `gm_showteam` console command. ( Default bind is F2 )
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:ShowTeam
      */
     ShowTeam(self: GM, ply: Player): void;
+
     /**
      * 		Called whenever the Lua environment is about to be shut down, for example on map change, or when the server is going to shut down.
      *
@@ -2201,18 +2442,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:ShutDown
      */
     ShutDown(self: GM): void;
+
     /**
      * Called when the Spawnmenu is Created.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:SpawnMenuCreated
      */
     SpawnMenuCreated(self: GM): void;
+
     /**
      * Called when spawn icon is generated.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:SpawniconGenerated
      */
     SpawniconGenerated(self: GM, lastmodel: string, imagename: string, modelsleft: number): void;
+
     /**
      * Runs when the user tries to open the chat box.
      *
@@ -2223,6 +2467,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:StartChat
      */
     StartChat(self: GM, isTeamChat: boolean): boolean;
+
     /**
      * Allows you to change the players inputs before they are processed by the server. This function is also called for bots, making it the best solution to control them.
      *
@@ -2236,18 +2481,21 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:StartCommand
      */
     StartCommand(self: GM, ply: Player, ucmd: CUserCmd): void;
+
     /**
      * Called right before an entity starts driving. Overriding this hook will cause it to not call [drive.Start](https://wiki.facepunch.com/gmod/drive.Start) and the player will not begin driving the entity.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:StartEntityDriving
      */
     StartEntityDriving(self: GM, ent: Entity, ply: Player): void;
+
     /**
      * Called when you start a new game via the menu.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/GM:StartGame
      */
     StartGame(self: GM): void;
+
     /**
      * Called every rendered frame on client, except when the game is paused.
      *
@@ -2263,6 +2511,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:Think
      */
     Think(self: GM): void;
+
     /**
      * Called every game tick. [engine.TickCount](https://wiki.facepunch.com/gmod/engine.TickCount) is guaranteed to be different between each call.
      *
@@ -2277,6 +2526,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:Tick
      */
     Tick(self: GM): void;
+
     /**
      * 		**NOTE**: Isn't called when CalcMainActivity returns a valid override sequence id
      *
@@ -2286,24 +2536,28 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:TranslateActivity
      */
     TranslateActivity(self: GM, ply: Player, act: number): number;
+
     /**
      * Animation updates (pose params etc) should be done here.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/GM:UpdateAnimation
      */
     UpdateAnimation(self: GM, ply: Player, velocity: Vector, maxSeqGroundSpeed: number): void;
+
     /**
      * Called when user clicks on a VGUI panel.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/GM:VGUIMousePressAllowed
      */
     VGUIMousePressAllowed(self: GM, button: number): boolean;
+
     /**
      * Called when a mouse button is pressed on a VGUI element or menu.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/GM:VGUIMousePressed
      */
     VGUIMousePressed(self: GM, pnl: Panel, mouseCode: number): void;
+
     /**
      * 		Called when a variable is edited on an Entity (called by Edit Properties... menu). See [Editable Entities](https://wiki.facepunch.com/gmod/Editable_Entities) for more information.
      *
@@ -2314,6 +2568,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:VariableEdited
      */
     VariableEdited(self: GM, ent: Entity, ply: Player, key: string, val: string, editor: table): void;
+
     /**
      * Called when you are driving a vehicle. This hook works just like [GM:Move](https://wiki.facepunch.com/gmod/GM:Move).
      *
@@ -2323,6 +2578,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:VehicleMove
      */
     VehicleMove(self: GM, ply: Player, veh: Vehicle, mv: CMoveData): void;
+
     /**
      * Called as a weapon entity is picked up by a player. (Including [Player:Give](https://wiki.facepunch.com/gmod/Player:Give))
      *
@@ -2339,42 +2595,49 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:WeaponEquip
      */
     WeaponEquip(self: GM, weapon: Weapon, owner: Player): void;
+
     /**
      * Called when an addon from the Steam workshop begins downloading. Used by default to place details on the workshop downloading panel.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/GM:WorkshopDownloadFile
      */
     WorkshopDownloadFile(self: GM, id: number, imageID: number, title: string, size: number): void;
+
     /**
      * Called while an addon from the Steam workshop is downloading. Used by default to update details on the fancy workshop download panel.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/GM:WorkshopDownloadProgress
      */
     WorkshopDownloadProgress(self: GM, id: number, imageID: number, title: string, downloaded: number, expected: number): void;
+
     /**
      * Called after [GM:WorkshopStart](https://wiki.facepunch.com/gmod/GM:WorkshopStart).
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/GM:WorkshopDownloadTotals
      */
     WorkshopDownloadTotals(self: GM, remain: number, total: number): void;
+
     /**
      * Called when an addon from the Steam workshop finishes downloading. Used by default to update details on the workshop downloading panel.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/GM:WorkshopDownloadedFile
      */
     WorkshopDownloadedFile(self: GM, id: number, title: string): void;
+
     /**
      * Called when downloading content from Steam workshop ends. Used by default to hide fancy workshop downloading panel.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/GM:WorkshopEnd
      */
     WorkshopEnd(self: GM): void;
+
     /**
      * Called while an addon from the Steam workshop is extracting. Used by default to update details on the fancy workshop download panel.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/GM:WorkshopExtractProgress
      */
     WorkshopExtractProgress(self: GM, id: number, ImageID: number, title: string, percent: number): void;
+
     /**
      * Called when downloading content from Steam workshop begins. Used by default to show fancy workshop downloading panel.
      *
@@ -2391,12 +2654,14 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:WorkshopStart
      */
     WorkshopStart(self: GM): void;
+
     /**
      * Called when UGC subscription status changes.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/GM:WorkshopSubscriptionsChanged
      */
     WorkshopSubscriptionsChanged(self: GM): void;
+
     /**
      * 		Called when a Workshop Message is received?. Currently, it seems like the message will be **#ugc.mounting** every time.
      * 		When does this exactly get called?. If an addon is subscribed, unsubscribed, error occurs or on any event?
@@ -2405,6 +2670,7 @@ interface GM {
      * @source https://wiki.facepunch.com/gmod/GM:WorkshopSubscriptionsMessage
      */
     WorkshopSubscriptionsMessage(self: GM, message: string): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -2415,271 +2681,3 @@ interface GM {
      */
     WorkshopSubscriptionsProgress(self: GM, num: number, max: number): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-