Gmod Thirst Mod + HUD Builder - Script
Gmod Thirst Mod + HUD Builder is an operational thirst and drink system for your Gmod server, a customizable thirst bar will display the thirst of your users in the design you want and at the location you chose with the included HUD Builder, the game will work according to gameplay rules that you can complete by enabling and disabling modules. The sample drinks will allow you to create your own drinks with the values you choose.
❮
❯
Description of Gmod Thirst Mod + HUD Builder
Summary:- 📘 Description of the addon: Gmod Thirst Mod + HUD Builder
- 📦 Contents
- 💧 Max Thirst Level Upgrade System
- 🎨 Editing options for the thirst bar in the HUD.
- 🕹️ Commands
- 💾 Backup and persistence
- 🥤 Spawnable Drinks model in Gmod Thirst Mod + HUD Builder
- 📚 Functions added to FindMetaTable("Player") for development
- ⚡ Shortcut system to open the interfaces of the scripts of the same collection
- 🏞️ Drink directly from the environment of the map where there are water points
- ✔️ Compatibility
- 🧱 HUD's Collection
📘 Description the addon: Gmod Thirst Mod + HUD Builder
Gmod Thirst Mod + HUD Builder is not just a HUD customization addon. It brings your players the feeling of thirst. This addon has been designed to work without any other gamemode or addon.
This way you can start off on a sound footing and on a system that won't spam the GMod SQL module with every update of the variable (thirst progression). Gmod Thirst Mod + HUD Builder is designed to make backups of the user at the time of logging out.
Regarding drink templates:
Sample drink templates are included if you want to add more drinks specific to your server environment.
I would also create free compatible drink packages on the Gmod workshop on Steam.
Lots of choices are available or if in the immediate future you need to change the thirst rules, you can make the thirst deadly or just constraining to the user, for example making them lose stamina or hit points but not fatal.
Disable thirst with a single button, by rank, job, or completely if needed.
Regarding the HUD, as in my buildable HUD collection, the thirst bar is completely customizable, from the icons to the style, shape, and location. New styles will appear as free updates are released.
📦 Contents
You will find:
1. A SQL backup system for users and for backups.
2. A management module of the thirst system according to the ranks: superadmin, admin, moderator, vip, user, etc.
3. An adjustable thirst bar in the HUD.
4. A module to manage the thirst system according to the DARKRP JOBS: mayer, citizen, vip, etc.
5. A customization system for the thirst bar in the HUD.
6. A large number of customizable HUD styles.
7. An entity of upgrade of the max thirst.
8. Sample drinks for creating your own entities.
9. Gameplay customization options.
10. Various drinks available on the workshop in a drink pack that you can use as an example and develop your own drinks.
11. Simple and light HUD mod = Possibility to not show the thirst bar but a thirst icon only when thirst is there,
12. And finally a support.
💧 Max Thirst Level Upgrade System
With Gmod Thirst Mod + HUD Builder, you will be able to choose if the max thirst increases with the level of the user, provided you have a leveling system installed on your server garry's mod, you will find one of my collection in the store / Section Gmod addons
It will be possible to choose the upgrade possibilities of the max thirst either by finding a spawnable key item as well, or depending on the level of your users. The progress of your users is recorded at their disconnection.
🎨 Editing options for the thirst bar in the HUD.
The Thirst System HUD is made for you to express your creativity, as in my editable HUD collection the Thirst Bar is fully customizable, from icons to style to shape and position. No need to update files or workshops. All you see when editing is a preview, don't forget to save to apply your changes.
List of customizable variables in the HUD:
1. X Y position
2. Length and Width
3. The background color of the bar
4. The color of the progress bars
5. The color of the text
6. The color of the icon
7. The font of the text
8. Replace default icons with your own by simple image link.
9. 19 HUD styles, circle, horizontal bar, hearts, pixelated bottles, water drops, textual, etc.
10. Modifications applicable without rebooting your server.
🕹️ Commands
To access the interface the chat command : !thirst
The console command : norda_hud_thirst_system
💾 Backup and persistence
Like most of my player stats management scripts, the player's evolution is saved at the time of disconnection for optimization reasons, it's a choice you can make from the configuration file.
🥤 Spawnable drink models in Gmod Thirst Mod + HUD Builder
The addon includes a spawn menu for drinks.
The drinks already present named drink_example_1 and drink_example_2 serve as examples to help you create your own, you can then store them in containers or at a merchant.
You can choose the values of each drink, for example if it affects the life points, the armor points, the stamina, the thirst, the hunger ect... A drink can have more or less values than another one according to your choices. You can do it with the drinks already present or those you add.
An item named upgrade of the max thirst will give you the choice to increase the max capacity of the thirst bar.
📚 Functions added to FindMetaTable("Player") for development
1. The Glua functions on the Client and Server sides:
player:Thirst() = Allows to know the remaining thirst points of the user.
player:GetMaxThirst() [/b]= Allows you to return the user's maximum thirst points.
2. Glua functions on the server side :
The following functions allow :
player:addThirst(number) = Allows to give or remove the thirst. For example. 10 = Adds 10 thirst to the thirst he already has. -10 Removes 10. It cannot go below Zero.
player:setThirst(number) = Allows you to define the player's thirst.
Management of the maximum thirst via items of the functions :
player:addMaxThirst(number) = Allows you to increase or decrease the max thirst. If you want to create entities that upgrade or downgrade the max thirst points, you can do so.
player:setMaxThirst(number) = Allows to define the max thirst points of the player. Like hunger, by default the max thirst is capped at 200. This limit can be changed.
⚡ Shortcut system to open the interfaces of the scripts of the same collection
Following the creation of the various gameplay elements linked to the HUD with their own customization systems, I include a shortcut system that allows you to switch between the different interfaces of these scripts, this system is added to the other scripts. So by opening only one of the interfaces, you can access all the others without typing the commands.
🏞️ Drink directly from the environment of the map where there are water points
If you have activated the option, press USE near the water to drink directly from the environment of the map which presents a water point it can be a river, a lake, etc.
✔️ Compatibility
Compatible with Gamemodes DarkRP, CityRP, SCPRP, StarwarsRP, HogwartsRP, PoudlardRP, CloneRP, MilitaryRP, AnimRP, MangaRP, ect... Works independently of any gamemode, make your own gamemode.
🧱 HUD's Collection
Gmod Thirst Mod + HUD Builder is part of the HUD collection :
Gmod Leveling System
Gmod Health Modules + HUD Editor
Gmod Stamina System + Customisable HUD
Gmod Hunger Mod + Customizable HUD
Gmod Thirst Mod + HUD Builder
Path: garrysmod/addons/norda_hud_thirst_mod
- The AddWorkshop function is automatically added to the script server file and can be deactivated from the configuration file. : resource.AddWorkshop( 2723114290 )
- To add gmod workshop resources to your collection : Gmod Thirst Mod + HUD Builder [Content Only] | Gmod Workshop
The console command: norda_hud_thirst_system or thirst
Or the F4 button. Disable from the configuration file.
From the shortcut button of my administration system.
Here will be displayed the list of players in the database, you can see and modify the thirst and max thirst, even of users not logged in.
ON: The player will have his thirst altered.
OFF : The thirst player is turned off. Useful when you want to temporarily disable thirst. To not spend your time feeding everyone during the explanations of an event. Or during construction periods.
ON : The thirst bar wears out normally, but physical actions like sprinting and jumping alter it.
OFF: The thirst bar wears out normally.
ON : When the thirst bar is at zero, then the stamina bar will start to burn out.
OFF: Disable the interaction of the Gmod Thirst Mod addon with stamina.
ON: When the thirst bar is at zero, then the life point bar will start to burn out.
OFF: Disable the interaction of the Gmod Thirst Mod addon with life points.
ON : When the thirst bar is at zero, then the player dies.
OFF : Disabled
ON : The player will not be able to die of thirst, he will see his stamina decrease and his health too. Even if the health reaches 0 the player will stay alive.
OFF: Module disabled.
OFF: The player will regain his thirst level. Before death.
1. X Y position
2. Length and width
3. The background color of the bar
4. The color of the progress bars
5. The color of the text
6. The color of the icon
7. The font of the text
8. Replace default icons with your own by simple image link.
9. 19 HUD styles, circle, horizontal bar, hearts, Bottle Style, Water style, textual, etc.
10. Changes applicable without rebooting your server.
Several examples of drinks can be found in the configuration file: norda_hud_thirst_mod_config.lua in the variable: Drink_List
If we take the provided example, the index popcan01a is the class name of the object:
local Drink_List={
popcan01a={
Name="Water cans",
Model="models/props_junk/popcan01a.mdl",
UseSound="nord_hud_sounds/action_soda.mp3",
Life=0,Armor=0,Stamina=0,Food=0,Drink=100,Mana=0,
},
soda_211={
Name="211 Cans",
Model="models/mechanics/various/211.mdl",
UseSound="nord_hud_sounds/action_soda.mp3",
Life=0,Armor=20,Stamina=0,Food=0,Drink=50,Mana=0,
},
}For the image in the spawnmenu you can simply create it in the material folder: vgui/entities/Entity_Class_Name.png