Merge pull request #127 from LiliaFramework/codex/revise-hooks.md-and-fix-mismatches

bleonheart · web-flow · commit 78fee34d5a5e · 2025-07-25T10:01:40.000+01:00
Fix hook doc module names
diff --git a/alcoholism/docs/hooks.md b/alcoholism/docs/hooks.md
@@ -300,3 +300,4 @@ end)
 
 ---
 
+
diff --git a/autorestarter/docs/hooks.md b/autorestarter/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Autorestarter module.
+Module-specific events raised by the Auto Restarter module.
 
 ---
 
diff --git a/chatmessages/docs/hooks.md b/chatmessages/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Chatmessages module.
+Module-specific events raised by the Chat Messages module.
 
 ---
 
diff --git a/cigs/docs/hooks.md b/cigs/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Cigs module.
+Module-specific events raised by the Cigarettes module.
 
 ---
 
diff --git a/cinematictext/docs/hooks.md b/cinematictext/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Cinematictext module.
+Module-specific events raised by the Cinematic Text module.
 
 ---
 
diff --git a/communitycommands/docs/hooks.md b/communitycommands/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Communitycommands module.
+Module-specific events raised by the Community Commands module.
 
 ---
 
diff --git a/cutscenes/docs/hooks.md b/cutscenes/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Cutscenes module.
+Module-specific events raised by the Simple Cutscenes module.
 
 ---
 
diff --git a/damagenumbers/docs/hooks.md b/damagenumbers/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Damagenumbers module.
+Module-specific events raised by the Damage Numbers module.
 
 ---
 
diff --git a/developmenthud/docs/hooks.md b/developmenthud/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Developmenthud module.
+Module-specific events raised by the Development HUD module.
 
 ---
 
diff --git a/developmentserver/docs/hooks.md b/developmentserver/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Developmentserver module.
+Module-specific events raised by the Development Server module.
 
 ---
 
diff --git a/discordrelay/docs/hooks.md b/discordrelay/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Discordrelay module.
+Module-specific events raised by the Discord Relay module.
 
 ---
 
diff --git a/doorkick/docs/hooks.md b/doorkick/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Doorkick module.
+Module-specific events raised by the Door Kick module.
 
 ---
 
diff --git a/extendeddescriptions/docs/hooks.md b/extendeddescriptions/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Extendeddescriptions module.
+Module-specific events raised by the Extended Descriptions module.
 
 ---
 
diff --git a/firstpersoneffects/docs/hooks.md b/firstpersoneffects/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Firstpersoneffects module.
+Module-specific events raised by the First Person Effects module.
 
 ---
 
diff --git a/freelook/docs/hooks.md b/freelook/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Freelook module.
+Module-specific events raised by the Free Look module.
 
 ---
 
diff --git a/hud_extras/docs/hooks.md b/hud_extras/docs/hooks.md
@@ -4,6 +4,34 @@ Module-specific events raised by the HUD Extras module.
 
 ---
 
+### `RefreshFonts`
+
+**Purpose**
+
+`Rebuilds HUD fonts whenever font configuration changes.`
+
+**Parameters**
+
+* *(None)*
+
+**Realm**
+
+`Client`
+
+**Returns**
+
+`nil` — `No return value.`
+
+**Example**
+
+```lua
+hook.Add("RefreshFonts", "HUDExtrasFonts", function()
+    surface.CreateFont("HUDFont", {font = lia.config.get("HUDExtrasFont"), size = 24})
+end)
+```
+
+---
+
 ### `HUDExtrasPreDrawFPS`
 
 **Purpose**
diff --git a/joinleavemessages/docs/hooks.md b/joinleavemessages/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Joinleavemessages module.
+Module-specific events raised by the Join Leave Messages module.
 
 ---
 
diff --git a/loadmessages/docs/hooks.md b/loadmessages/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Loadmessages module.
+Module-specific events raised by the Load Messages module.
 
 ---
 
diff --git a/loyalism/docs/hooks.md b/loyalism/docs/hooks.md
@@ -148,3 +148,4 @@ end)
 
 ---
 
+
diff --git a/mapcleaner/docs/hooks.md b/mapcleaner/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Mapcleaner module.
+Module-specific events raised by the Map Cleaner module.
 
 ---
 
diff --git a/modelpay/docs/hooks.md b/modelpay/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Modelpay module.
+Module-specific events raised by the Model Pay module.
 
 ---
 
diff --git a/modeltweaker/docs/hooks.md b/modeltweaker/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Modeltweaker module.
+Module-specific events raised by the Model Tweaker module.
 
 ---
 
diff --git a/npcdrop/docs/hooks.md b/npcdrop/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Npcdrop module.
+Module-specific events raised by the NPC Drops module.
 
 ---
 
diff --git a/npcspawner/docs/hooks.md b/npcspawner/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Npcspawner module.
+Module-specific events raised by the NPC Spawner module.
 
 ---
 
diff --git a/permaremove/docs/hooks.md b/permaremove/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Permaremove module.
+Module-specific events raised by the Perma Remove module.
 
 ---
 
diff --git a/radio/docs/hooks.md b/radio/docs/hooks.md
@@ -36,39 +36,6 @@ end)
 
 ---
 
-### `AddTextField`
-
-**Purpose**
-
-`Creates a text field inside a radio information section.`
-
-**Parameters**
-
-* `section` (`string`): `Section title to place the field in.`
-
-* `id` (`string`): `Unique identifier for the text field.`
-
-* `label` (`string`): `Text displayed before the value.`
-
-* `callback` (`function`): `Function returning the value to display.`
-
-**Realm**
-
-`Client`
-
-**Returns**
-
-`nil` — `No return value.`
-
-**Example**
-
-```lua
-hook.Add("AddTextField", "AddRadioFreq", function(section, id, label, callback)
-    -- Custom fields can be inserted here
-end)
-```
-
----
 
 ### `ShouldRadioBeep`
 
diff --git a/raisedweapons/docs/hooks.md b/raisedweapons/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Raisedweapons module.
+Module-specific events raised by the Raised Weapons module.
 
 ---
 
diff --git a/realisticdamage/docs/hooks.md b/realisticdamage/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Realisticdamage module.
+Module-specific events raised by the Realistic Damage module.
 
 ---
 
diff --git a/realisticview/docs/hooks.md b/realisticview/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Realisticview module.
+Module-specific events raised by the Realistic View module.
 
 ---
 
diff --git a/shootlock/docs/hooks.md b/shootlock/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Shootlock module.
+Module-specific events raised by the Shoot Locks module.
 
 ---
 
diff --git a/simple_lockpicking/docs/hooks.md b/simple_lockpicking/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the SimpleLockpicking module.
+Module-specific events raised by the Lockpicking module.
 
 ---
 
diff --git a/stungun/docs/hooks.md b/stungun/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Stungun module.
+Module-specific events raised by the Stun Gun module.
 
 ---
 
diff --git a/vmanip/docs/hooks.md b/vmanip/docs/hooks.md
@@ -66,3 +66,61 @@ end)
 
 ---
 
+### `VManipChooseAnim`
+
+**Purpose**
+
+`Allows overriding which animation is played for a picked up item.`
+
+**Parameters**
+
+* `itemID` (`string`): `Unique ID of the item being picked up.`
+
+**Realm**
+
+`Client`
+
+**Returns**
+
+`string|nil` — `Return the animation name or nil for the default.`
+
+**Example**
+
+```lua
+hook.Add("VManipChooseAnim", "UseFastAnim", function(itemID)
+    if itemID == "apple" then
+        return "interactfast"
+    end
+end)
+```
+
+---
+
+### `VManipAnimationPlayed`
+
+**Purpose**
+
+`Notifies that a viewmodel animation has begun playing.`
+
+**Parameters**
+
+* `itemID` (`string`): `Unique ID of the related item.`
+
+**Realm**
+
+`Client`
+
+**Returns**
+
+`nil` — `No return value.`
+
+**Example**
+
+```lua
+hook.Add("VManipAnimationPlayed", "DebugAnim", function(itemID)
+    print("Animation started for", itemID)
+end)
+```
+
+---
+
diff --git a/warrants/docs/hooks.md b/warrants/docs/hooks.md
@@ -104,3 +104,4 @@ end)
 
 ---
 
+
diff --git a/wartable/docs/hooks.md b/wartable/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Wartable module.
+Module-specific events raised by the War Table module.
 
 ---
 
diff --git a/wordfilter/docs/hooks.md b/wordfilter/docs/hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-Module-specific events raised by the Wordfilter module.
+Module-specific events raised by the Word Filter module.
 
 ---
 

Original file line number	Diff line number	Diff line change
`@@ -300,3 +300,4 @@ end)`
`300`	`300`
`301`	`301`	`---`
`302`	`302`
	`303`	`+`
-Original file line number
+Diff line change
@@ @@ -1,6 +1,6 @@ @@
 # Hooks
 -Module-specific events raised by the Autorestarter module.
 +Module-specific events raised by the Auto Restarter module.
 ---