search_docs
Search Source 2 documentation and game data by free text or identifier to find convars, commands, entities, events, scripts, and examples for modding and scripting.
Instructions
Full-text search across everything. Each hit's key feeds the detail tool for its kind:
convar/command→get_convar(name), entity→get_entity('side:classname'), schema_class/schema_enum→
get_schema_class('module:Name'), event→get_game_event, script→get_script_api, pulse→search_pulse,
example→get_example(key), doc→get_doc(key). With game set, general docs are included too.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| game | No | Restrict to one game id | |
| kinds | No | Restrict result kinds: convar, command, entity, schema_class, schema_enum, event, script, pulse, example, doc | |
| limit | No | ||
| query | Yes | Free text or identifier, e.g. 'round time', 'OnTrigger' |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | ||
| limit | Yes | ||
| total | Yes | ||
| offset | Yes |