Hook intelligence

Overview

GMod addons use hooks to respond to game events. GLuaLS understands hook.Add, hook.Remove, hook.Run, hook.Call, and GM: definitions. It provides completions, type inference, and validation for each one.

Hook name validation

Unrecognized hook names in hook.Add and hook.Remove trigger a diagnostic:

hook.Add("PlayerSpan", "MyAddon", function(ply) -- ❌ did you mean PlayerSpawn?
    -- ...
end)

GLuaLS recognizes built-in GMod hooks from the downloaded API definitions. It also tracks custom hook names used by your workspace.

Parameter type inference

When GLuaLS knows the hook name, it types the callback parameters:

hook.Add("PlayerSpawn", "MyAddon", function(ply)
    --                                       ^^^
    --                                       typed as Player automatically
    local hp = ply:Health() -- ✅ typed, Player method
end)

hook.Add("EntityTakeDamage", "MyDamageHook", function(target, dmg)
    -- target: Entity
    -- dmg: CTakeDamageInfo
    -- All typed from the GMod wiki annotations
end)

Callback snippet completion

When you type hook.Add("HookName", and trigger completion on the callback argument, GLuaLS inserts a typed function snippet:

-- Accepting completion for hook.Add("PlayerSpawn") inserts:
hook.Add("PlayerSpawn", "MyAddon", function(ply)
    -- YOUR CODE
end)

The snippet includes the correct number of parameters with their names.

GM: hook definitions

Files in a gamemode context, such as gamemodes/*/gamemode/, define GM as the gamemode table. GLuaLS recognizes function GM:HookName() as a hook override:

function GM:PlayerSpawn(ply)
    -- ply is typed as Player ✅
    self.BaseClass.PlayerSpawn(self, ply)
end

A GM: definition gives a custom hook a clear signature and definition target.

hook.Run and hook.Call completions

When typing the first argument to hook.Run or hook.Call, GLuaLS autocompletes from known hook names:

hook.Run("PlayerSpawn", ply)  -- "PlayerSpawn" autocompletes

Custom hooks

GLuaLS also tracks hooks created by your code or your library:

-- Somewhere in your code:
hook.Run("MyAddon.OnPlayerAction", ply, action)

-- Elsewhere:
hook.Add("MyAddon.OnPlayerAction", "handler", function(ply, action)
    -- ply and action types are inferred from call sites
end)

Add annotations to a custom GM: method when you want stable parameter types and hover documentation across the project.

Hook wrappers

Framework wrappers around hook registration and execution can provide the same features. GLuaLS reads wrapper behavior from the Garry’s Mod annotations instead of requiring a specific function name. See @call_arg when you need to describe your own wrapper.

VS Code integration

Hook intelligence works when you use hook.Add, hook.Run, or define GM: methods. Configure validation behavior in the settings panel. See Garry’s Mod settings for the full reference.

Configuration

Control hook validation and mappings through the gmod section in .gluarc.json, especially gmod.hookMappings and the global diagnostics settings.

Setting	Default	Description
`gmod.hookMappings.methodToHook`	`{}`	Map method names to hook names (e.g. `"Think": "Think"`)
`gmod.hookMappings.emitterToHook`	`{}`	Map custom emitter functions to hook names
`gmod.hookMappings.methodPrefixes`	`[]`	Custom method prefixes for inferred `GM:` hook methods
`diagnostics.disable`	`[]`	Disable individual diagnostics (e.g., `"gmod-invalid-hook-name"`)

Overview

Code intelligence

Garry's Mod

Classes

Debugger

AI integration

Overview

Hook name validation

Parameter type inference

Callback snippet completion

GM: hook definitions

hook.Run and hook.Call completions

Custom hooks

Hook wrappers

VS Code integration

Configuration

​Overview

​Hook name validation

​Parameter type inference

​Callback snippet completion

​GM: hook definitions

​hook.Run and hook.Call completions

​Custom hooks

​Hook wrappers

​VS Code integration

​Configuration

Overview

Hook name validation

Parameter type inference

Callback snippet completion

GM: hook definitions

hook.Run and hook.Call completions

Custom hooks

Hook wrappers

VS Code integration

Configuration