Skip to content

Commit 25495eb

Browse files
committed
2 parents e4feac2 + a9ce1a4 commit 25495eb

File tree

124 files changed

+1817
-58
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

124 files changed

+1817
-58
lines changed

advert/docs/hooks.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
# Hooks
2+
23
Module-specific events raised by the Advert module.
34

45
---
6+
57
### `AdvertSent`
68

79
**Purpose**
10+
811
`Fires after a player successfully sends an advertisement message.`
912

1013
**Parameters**
1114

1215
* `client` (`Player`): `Player who posted the advert.`
16+
1317
* `message` (`string`): `Text that was advertised.`
1418

1519
**Realm**
20+
1621
`Server`
1722

1823
**Returns**
24+
1925
`nil``This hook does not return anything.`
2026

2127
**Example**
@@ -27,3 +33,4 @@ end)
2733
```
2834

2935
---
36+

advert/module.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
MODULE.name = "Advert"
22
MODULE.author = "Samael"
33
MODULE.discord = "@liliaplayer"
4-
MODULE.version = 1.15
4+
MODULE.version = 1.16
55
MODULE.desc = "Provides a paid /advert command so players can broadcast server-wide messages with a built-in cooldown."
66
MODULE.Public = true
77
MODULE.Features = {"Adds a paid /advert command players can use", "Adds a cooldown via AdvertCooldown to limit spam", "Adds colored broadcast messages across the server", "Adds price control via AdvertPrice configuration", "Adds notifications when players lack funds"}

alcoholism/docs/hooks.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
# Hooks
2+
23
Module-specific events raised by the Alcoholism module.
34

45
---
6+
57
### `BACChanged`
68

79
**Purpose**
10+
811
`Called whenever a player's Blood Alcohol Content (BAC) value is updated.`
912

1013
**Parameters**
1114

1215
* `client` (`Player`): `The player whose BAC changed.`
16+
1317
* `newBac` (`number`): `The player's new BAC value.`
1418

1519
**Realm**
20+
1621
`Server`
1722

1823
**Returns**
24+
1925
`nil``This hook does not return anything.`
2026

2127
**Example**
@@ -31,16 +37,19 @@ end)
3137
### `BACReset`
3238

3339
**Purpose**
40+
3441
`Runs when a player's BAC is reset to 0.`
3542

3643
**Parameters**
3744

3845
* `client` (`Player`): `The player whose BAC was reset.`
3946

4047
**Realm**
48+
4149
`Server`
4250

4351
**Returns**
52+
4453
`nil`
4554

4655
**Example**
@@ -56,18 +65,23 @@ end)
5665
### `BACIncreased`
5766

5867
**Purpose**
68+
5969
`Fires when a player's BAC is increased through consuming alcohol.`
6070

6171
**Parameters**
6272

6373
* `client` (`Player`): `The affected player.`
74+
6475
* `amount` (`number`): `Amount added to the BAC.`
76+
6577
* `newBac` (`number`): `The resulting BAC value.`
6678

6779
**Realm**
80+
6881
`Server`
6982

7083
**Returns**
84+
7185
`nil`
7286

7387
**Example**
@@ -83,17 +97,21 @@ end)
8397
### `AlcoholConsumed`
8498

8599
**Purpose**
100+
86101
`Triggered when an alcohol item is used by a player.`
87102

88103
**Parameters**
89104

90105
* `client` (`Player`): `Player that consumed the item.`
106+
91107
* `item` (`Item`): `The alcohol item that was consumed.`
92108

93109
**Realm**
110+
94111
`Server`
95112

96113
**Returns**
114+
97115
`nil`
98116

99117
**Example**
@@ -109,16 +127,19 @@ end)
109127
### `PreBACReset`
110128

111129
**Purpose**
130+
112131
`Runs right before a player's BAC value is cleared.`
113132

114133
**Parameters**
115134

116135
* `client` (`Player`): `The player about to be reset.`
117136

118137
**Realm**
138+
119139
`Server`
120140

121141
**Returns**
142+
122143
`nil`
123144

124145
**Example**
@@ -134,16 +155,19 @@ end)
134155
### `PostBACReset`
135156

136157
**Purpose**
158+
137159
`Called after a player's BAC has been cleared.`
138160

139161
**Parameters**
140162

141163
* `client` (`Player`): `The player that was reset.`
142164

143165
**Realm**
166+
144167
`Server`
145168

146169
**Returns**
170+
147171
`nil`
148172

149173
**Example**
@@ -159,17 +183,21 @@ end)
159183
### `PreBACIncrease`
160184

161185
**Purpose**
186+
162187
`Invoked before a player's BAC value increases.`
163188

164189
**Parameters**
165190

166191
* `client` (`Player`): `The affected player.`
192+
167193
* `amount` (`number`): `Amount being added.`
168194

169195
**Realm**
196+
170197
`Server`
171198

172199
**Returns**
200+
173201
`nil`
174202

175203
**Example**
@@ -185,17 +213,21 @@ end)
185213
### `BACThresholdReached`
186214

187215
**Purpose**
216+
188217
`Fires when a player's BAC crosses the drunk threshold.`
189218

190219
**Parameters**
191220

192221
* `client` (`Player`): `The player who crossed the threshold.`
222+
193223
* `newBac` (`number`): `Their new BAC value.`
194224

195225
**Realm**
226+
196227
`Server`
197228

198229
**Returns**
230+
199231
`nil`
200232

201233
**Example**
@@ -211,17 +243,21 @@ end)
211243
### `PreBACDecrease`
212244

213245
**Purpose**
246+
214247
`Runs before the server lowers a player's BAC over time.`
215248

216249
**Parameters**
217250

218251
* `client` (`Player`): `Player whose BAC will drop.`
252+
219253
* `current` (`number`): `Their current BAC before drop.`
220254

221255
**Realm**
256+
222257
`Server`
223258

224259
**Returns**
260+
225261
`nil`
226262

227263
**Example**
@@ -237,17 +273,21 @@ end)
237273
### `PostBACDecrease`
238274

239275
**Purpose**
276+
240277
`Runs after a player's BAC has decayed for the tick.`
241278

242279
**Parameters**
243280

244281
* `client` (`Player`): `Affected player.`
282+
245283
* `newBac` (`number`): `Their BAC after decay.`
246284

247285
**Realm**
286+
248287
`Server`
249288

250289
**Returns**
290+
251291
`nil`
252292

253293
**Example**
@@ -259,3 +299,4 @@ end)
259299
```
260300

261301
---
302+

alcoholism/docs/meta.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
Helper functions for tracking a player's blood alcohol content.
44

55
---
6+
67
### Player:ResetBAC (Server)
78

89
**Purpose**
@@ -36,7 +37,9 @@ client:ResetBAC()
3637
Raises the player's BAC by the specified amount.
3738

3839
| Name | Type | Description |
40+
3941
| ------- | ------ | ------------------ |
42+
4043
| `amount` | number | BAC points to add. |
4144

4245
**Realm**
@@ -100,3 +103,4 @@ local level = client:GetBAC()
100103
```
101104

102105
---
106+

alcoholism/module.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
MODULE.name = "Alcoholism"
22
MODULE.author = "Samael"
33
MODULE.discord = "@liliaplayer"
4-
MODULE.version = 1.15
4+
MODULE.version = 1.16
55
MODULE.desc = "Introduces drinkable alcohol items that raise intoxication levels and temporarily blur the player's vision and movement."
66
MODULE.Public = true
77
MODULE.Features = {"Adds alcohol items that raise BAC and gradually wear off", "Adds screen blur and movement effects that scale with intoxication", "Adds player notification when reaching DrunkNotifyThreshold", "Adds configurable BAC settings like AlcoholTickTime", "Adds multiple drink items with varying strength"}

autorestarter/docs/hooks.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
# Hooks
2+
23
Module-specific events raised by the Autorestarter module.
34

45
---
6+
57
### `AutoRestartScheduled`
68

79
**Purpose**
10+
811
`Called when the next automatic restart time is calculated.`
912

1013
**Parameters**
1114

1215
* `timestamp` (`number`): `Unix time of the upcoming restart.`
1316

1417
**Realm**
18+
1519
`Server`
1620

1721
**Returns**
22+
1823
`nil`
1924

2025
**Example**
@@ -30,16 +35,19 @@ end)
3035
### `AutoRestart`
3136

3237
**Purpose**
38+
3339
`Fires right before the map is reloaded for the automatic restart.`
3440

3541
**Parameters**
3642

3743
* `timestamp` (`number`): `Time when the restart triggered.`
3844

3945
**Realm**
46+
4047
`Server`
4148

4249
**Returns**
50+
4351
`nil`
4452

4553
**Example**
@@ -55,16 +63,19 @@ end)
5563
### `AutoRestartStarted`
5664

5765
**Purpose**
66+
5867
`Runs when the restart command is issued.`
5968

6069
**Parameters**
6170

6271
* `map` (`string`): `Map that will be loaded.`
6372

6473
**Realm**
74+
6575
`Server`
6676

6777
**Returns**
78+
6879
`nil`
6980

7081
**Example**
@@ -80,16 +91,19 @@ end)
8091
### `AutoRestartCountdown`
8192

8293
**Purpose**
94+
8395
`Called periodically during the final quarter of the restart interval.`
8496

8597
**Parameters**
8698

8799
* `remaining` (`number`): `Seconds remaining until restart.`
88100

89101
**Realm**
102+
90103
`Server`
91104

92105
**Returns**
106+
93107
`nil`
94108

95109
**Example**
@@ -101,3 +115,4 @@ end)
101115
```
102116

103117
---
118+

0 commit comments

Comments
 (0)