Merge branch 'main' of https://github.com/LiliaFramework/Modules

Author: bleonheart

alcoholism/docs/hooks.md

@@ -72,7 +72,7 @@ end)
 
 * `client` (`Player`): `The affected player.`
 
-* `amount` (`number`): `Amount added to the BAC.`
+* `amt` (`number`): `Amount added to the BAC.`
 
 * `newBac` (`number`): `The resulting BAC value.`
 
@@ -87,8 +87,8 @@ end)
 **Example**
 
 ```lua
-hook.Add("BACIncreased", "NotifyBACIncrease", function(client, amount, newBac)
-    client:ChatPrint("BAC increased by " .. amount .. " to " .. newBac .. "%")
+hook.Add("BACIncreased", "NotifyBACIncrease", function(client, amt, newBac)
+    client:ChatPrint("BAC increased by " .. amt .. " to " .. newBac .. "%")
 end)
 ```
 
@@ -190,7 +190,7 @@ end)
 
 * `client` (`Player`): `The affected player.`
 
-* `amount` (`number`): `Amount being added.`
+* `amt` (`number`): `Amount being added.`
 
 **Realm**
 
@@ -203,8 +203,8 @@ end)
 **Example**
 
 ```lua
-hook.Add("PreBACIncrease", "CheckIncrease", function(client, amount)
-    if amount > 50 then return false end
+hook.Add("PreBACIncrease", "CheckIncrease", function(client, amt)
+    print("BAC will increase by", amt)
 end)
 ```
 
@@ -250,7 +250,7 @@ end)
 
 * `client` (`Player`): `Player whose BAC will drop.`
 
-* `current` (`number`): `Their current BAC before drop.`
+* `bac` (`number`): `Their current BAC before drop.`
 
 **Realm**
 
@@ -263,7 +263,7 @@ end)
 **Example**
 
 ```lua
-hook.Add("PreBACDecrease", "CheckDrop", function(client, current)
+hook.Add("PreBACDecrease", "CheckDrop", function(client, bac)
     -- You could modify decay here
 end)
 ```

alcoholism/docs/meta.md

@@ -40,7 +40,7 @@ Raises the player's BAC by the specified amount.
 
 | ------- | ------ | ------------------ |
 
-| `amount` | number | BAC points to add. |
+| `amt` | number | BAC points to add. |
 
 **Realm**
 

autorestarter/docs/hooks.md

@@ -114,5 +114,3 @@ hook.Add("AutoRestartCountdown", "DisplayTimer", function(remaining)
 end)
 ```
 
----
-

broadcasts/docs/hooks.md

@@ -136,7 +136,7 @@ end)
 
 **Purpose**
 
-`Fires when the class broadcast selection menu is presented.`
+`Runs before the class broadcast selection menu is presented.`
 
 **Parameters**
 
@@ -228,7 +228,7 @@ end)
 
 **Purpose**
 
-`Fires when the faction broadcast selection menu appears.`
+`Runs before the faction broadcast selection menu appears.`
 
 **Parameters**
 

captions/docs/hooks.md

@@ -78,11 +78,16 @@ end)
 
 **Parameters**
 
-* `clientOrText` (`Player|string`): `On the server this is the target player, on the client this is the caption text.`
+**Server**
 
-* `textOrDuration` (`string|number`): `On the server this is the caption text, on the client this is the duration.`
+* `client` (`Player`): `The player receiving the caption.`
+* `text` (`string`): `Caption text.`
+* `duration` (`number`): `How long the caption should display.`
 
-* `duration` (`number`, optional): `Duration when running server side.`
+**Client**
+
+* `text` (`string`): `Caption text.`
+* `duration` (`number`): `How long the caption should display.`
 
 **Realm**
 
@@ -110,7 +115,13 @@ end)
 
 **Parameters**
 
-* `client` (`Player`, optional): `The player whose caption ended when on the server.`
+**Server**
+
+* `client` (`Player`): `The player whose caption ended.`
+
+**Client**
+
+* *(None)*
 
 **Realm**
 

captions/docs/libraries.md

@@ -22,7 +22,7 @@ The net strings `StartCaption` and `EndCaption` are registered automatically whe
 
 ---
 
-### lia.caption.start
+### lia.caption.start (Server)
 
 **Purpose**
 
@@ -57,7 +57,7 @@ lia.caption.start(ply, "Access Granted", 5)
 
 ---
 
-### lia.caption.finish
+### lia.caption.finish (Server)
 
 **Purpose**
 
@@ -88,7 +88,7 @@ lia.caption.finish(ply)
 
 ---
 
-### lia.caption.start
+### lia.caption.start (Client)
 
 **Purpose**
 
@@ -121,7 +121,7 @@ lia.caption.start("Mission Complete", 3)
 
 ---
 
-### lia.caption.finish
+### lia.caption.finish (Client)
 
 **Purpose**
 

cigs/docs/hooks.md

@@ -78,7 +78,7 @@ Occurs when a player releases smoke after holding a cigarette.
 
 * `cigID` (`number`): Identifier of the cigarette item.
 
-* `puffs` (`number`): How many puffs were taken.
+* `puffs` (`number`): Total puffs taken so far.
 
 **Realm**
 

cinematictext/docs/hooks.md

@@ -20,7 +20,7 @@ Called when a cinematic display begins on the client.
 
 * `blackBars` (`boolean`): Whether letterbox bars are drawn.
 
-* `playMusic` (`boolean`): Whether background music should play.
+* `music` (`boolean`): Whether background music should play.
 
 * `color` (`Color`): Color applied to the text.
 
@@ -35,7 +35,7 @@ Called when a cinematic display begins on the client.
 **Example**
 
 ```lua
-hook.Add("CinematicDisplayStart", "ExampleStart", function(text, bigText, duration, blackBars, playMusic, color)
+hook.Add("CinematicDisplayStart", "ExampleStart", function(text, bigText, duration, blackBars, music, color)
     print("Cinematic started:", text)
 end)
 ```
@@ -144,7 +144,7 @@ Called server-side when a player requests to trigger a cinematic display.
 
 * `blackBars` (`boolean`): Whether to include black bars.
 
-* `playMusic` (`boolean`): Whether to play music.
+* `music` (`boolean`): Whether to play music.
 
 * `color` (`Color`): Text color.
 
@@ -159,7 +159,7 @@ Called server-side when a player requests to trigger a cinematic display.
 **Example**
 
 ```lua
-hook.Add("CinematicTriggered", "OnCinematicTrigger", function(client, text, bigText, duration, blackBars, playMusic, color)
+hook.Add("CinematicTriggered", "OnCinematicTrigger", function(client, text, bigText, duration, blackBars, music, color)
     print(client:Name() .. " started a cinematic.")
 end)
 ```

cursor/docs/hooks.md

@@ -53,7 +53,7 @@ Runs right after the cursor texture has been drawn.
 **Example**
 
 ```lua
-hook.Add("PostRenderCursor", "ResetColor", function()
+hook.Add("PostRenderCursor", "ResetColor", function(mat)
     surface.SetDrawColor(255, 255, 255)
 end)
 ```
@@ -82,7 +82,7 @@ Executed every frame before the hovered panel has its cursor style changed.
 
 ```lua
 hook.Add("PreCursorThink", "BlockCursor", function(panel)
-    if panel.NoCursor then return false end
+    if panel.NoCursor then return end
 end)
 ```
 

cutscenes/docs/hooks.md

@@ -12,9 +12,9 @@ Fired when a cutscene begins running. On the server it is called for every playe
 
 **Parameters**
 
-* `player` (`Player`|nil): Player who started viewing the cutscene (server only).
+* `player` (`Player`): Player who started viewing the cutscene. *(Server only)*
 
-* `id` (`string`): Identifier of the cutscene.
+* `id` (`string`): Identifier of the cutscene. On the client this is the sole parameter.
 
 **Realm**