Add a status to a player.
| client | **What does `Status_Type` and `Amount` mean?** | **Status\_Type (string)** | **Amount (number)** | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | 'hunger' | 0 - 100 (0 is empty and 100 is full) | | 'thirst' | 0 - 100 (0 is empty and 100 is full) | | 'stress | 0 - 100 (0 is empty and 100 is full) | | 'oxygen' | 0 - ∞ (You can add any amount, this is to support the use of diving gear, etc. But be sure to set a player's oxygen back to the maximum default value of **30** when the diving gear has been removed) | **Do you need an example?** The example below will add 20 'hunger' to a player when being triggered from the **client-side to the client-side.** ```lua TriggerEvent('cd_playerhud:status:add', 'hunger', 20) ``` The example below will add 20 'hunger' to a player when being triggered from the **server-side to the client-side.** ```lua TriggerClientEvent('cd_playerhud:status:add', source, 'hunger', 20) ``` {% endtab %} {% tab title="Remove Status" %} **Here is some information about this event.** | **Event Name** | **Description** | **Event Type** | | --------------------------------------------------------------------- | -------------------------------------------- | -------------- | | TriggerEvent('cd\_playerhud:status:remove', **Status\_Type, Amount)** |Remove a status from a player.
| client | **What does `Status_Type` and `Amount` mean?** | **Status\_Type (string)** | **Amount (number)** | | ------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | 'hunger' | 0 - 100 (0 is empty and 100 is full) | | 'thirst' | 0 - 100 (0 is empty and 100 is full) | | 'stress | 0 - 100 (0 is empty and 100 is full) | | 'oxygen' | 0 - ∞ (You can remove any amount, this is to support the use of diving gear, etc. The maximum default value is **30**) | **Do you need an example?** The example below will remove 20 'stress' from a player when being triggered from the **client-side to the client-side.** ```lua TriggerEvent('cd_playerhud:status:remove', 'stress', 40) ``` The example below will remove 20 'stress' from a player when being triggered from the **server-side to the client-side.** ```lua TriggerClientEvent('cd_playerhud:status:remove', source, 'stress', 40) ``` {% endtab %} {% tab title="Set Status" %} **Here is some information about this event.** | **Event Name** | **Description** | **Event Type** | | ------------------------------------------------------------------ | ------------------------------------ | -------------- | | TriggerEvent('cd\_playerhud:status:set', **Status\_Type, Amount)** |Set a player's status.
| client | **What does `Status_Type` and `Amount` mean?** | **Status\_Type (string)** | **Amount (number)** | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | 'hunger' | 0 - 100 (0 is empty and 100 is full) | | 'thirst' | 0 - 100 (0 is empty and 100 is full) | | 'stress | 0 - 100 (0 is empty and 100 is full) | | 'oxygen' | 0 - ∞ (You can set any amount, this is to support the use of diving gear, etc. But be sure to set a player's oxygen back to the maximum default value of **30** when the diving gear has been removed) | **Do you need an example?** The example below will set a player's 'oxygen' to 30 when being triggered from the **client-side to the client-side.** ```lua TriggerEvent('cd_playerhud:status:set', 'oxygen', 30) ``` The example below will set a player's 'oxygen' to 30 when being triggered from the **server-side to the client-side.** ```lua TriggerClientEvent('cd_playerhud:status:set', source, 'oxygen', 30) ``` {% endtab %} {% tab title="Reset Status" %} **Here is some information about this event.** | **Event Name** | **Description** | **Event Type** | | ----------------------------------------------- | ----------------------------------------------------------- | -------------- | | TriggerServerEvent('cd\_playerhud:ResetStatus') |Reset a player's status to the default values
| server | **Do you need an example?** The example below reset a player's statuses to the default values when being triggered from the **client-side to the server-side.** ```lua TriggerServerEvent('cd_playerhud:ResetStatus') ``` {% endtab %} {% tab title="Toggle Watch UI" %} **Here is some information about this event.** | **Event Name** | **Description** | **Event Type** | | ----------------------------------------------------- | ------------------------------------------------------------ | -------------- | | TriggerEvent('cd\_playerhud:OpenWatchUI', **Action)** |Open or close the watch UI from other scripts.
| client | **What does `Action` mean?** | **Action** | **Description** | | ---------- | ---------------------------------------------------- | | 'open' | Open the watch UI. | | 'close' | Close the watch UI. | | nil | If the Action is nil, this will toggle the watch UI. | **Do you need an example?** The example below will show a players watch when being triggered from the **client-side to the client-side.** ```lua TriggerEvent('cd_playerhud:OpenWatchUI', 'open') ``` The example below will show a players watch when being triggered from the **server-side to the client-side.** ```lua TriggerClientEvent('cd_playerhud:OpenWatchUI', source, 'open') ``` {% endtab %} {% endtabs %} ### Exports These exports are completely optional; you can use them if needed. {% tabs %} {% tab title="client-side exports" %} **Get Status** {% code title="Returns the hunger, thirst, stress, and oxygen stats (table)." %} ```lua exports['cd_playerhud']:GetStatus() ``` {% endcode %} {% endtab %} {% endtabs %} ## ## COMMON ISSUES Please check out our [**Troubleshooting Guide**](https://docs.codesign.pro/coding-information/self-debugging#troubleshooting) before contacting our support. 🔔 **Folder Name** Make sure the name of the folder is `cd_playerhud`. 🔔 **Encrypted Files** Do not edit the encrypted files in any way. > **Money/Hunger etc is not being updated on the UI?** > > eg., if certain things like your hunger/thirst/stress/money are not **being updat**ed, that most likely means your framework has renamed the events. > > {% code overflow="wrap" %} > > ``` > ✔️ We can not directly offer support with this, we create compatibility for default versions of frameworks. But what you need to do is change the event names in the client_customise_me.lua to the ones that currently work for your framework. > ``` > > {% endcode %} ## ERROR CODES If you see an error code not listed below, please open a script support ticket in the [Codesign Discord](https://discord.gg/codesign). {% tabs %} {% tab title="Server" %} N/A {% endtab %} {% tab title="Client" %} **8846** - You are sending the wrong data in the `cd_playerhud:status:set` event. The first argument should be the status and the 2nd argument should be a number, refer to this for how this event should be formatted [#Events](#events). {% endtab %} {% endtabs %} ## CHANGELOG > **Files Changed** > > Not every update requires you to replace the whole folder. We do this because we understand it's a pain to redo the configs for every update. * **All Files -** This means you should delete your old `cd_playerhud` folder, download and add in the latest version, reconfigure the configs folder and restart your server. * **All Files Except config.lua -** This means you should do all of the above (in the All Files section) but additionally **make a backup of the `config.lua`** file and replace the new config.lua file with the one you made a backup of. * **Specific Files -** This means you can copy and paste the **SPECIFIC** new files over the old ones and restart the server. > **Update Type** > > On rare occasions, you are forced to update to the latest version. Mostly due to authentication updates where the old versions will no longer work. * **Mandatory -** This means you MUST update to this new version, or the old versions will no longer work. * **Optional -** This means it's completely your choice whether you wish to update to the latest version. But we do not offer support for old versions for obvious reasons; they are old. {% hint style="warning" %} **Skipping Updates** If you are attempting to update to the latest version but have skipped previous updates, you should update all files just to be safe. For example., let's say you are currently on v4.0.1, you did not update when v4.0.2 was released, and now v4.0.3 is released, and you want to update; you should always use the “All Files” update method. {% endhint %} {% tabs %} {% tab title="v3.0.0" %} ### 26/12/2020 - 10/08/2021 v3.0.0 - v3.1.1 **Files Changed:** * [x] All Files * [ ] All Files Except config.lua * [ ] Specific Files **Update Type:** * [x] Mandatory * [ ] Optional **Changelog:** {% hint style="success" %} Add * Added config options for framework version. * Added the ability to rename all esx events such as the setjob and playerloaded events. * Added drag-and-drop compatibility for QBCore. * Added 2 new files (stress and underwater\_oxygen) to make them open-source and editable. * Added a new config option to save the hunger/thirst/stress to the database without needing to use esx\_status. This is more optimized than how esx\_status saves to the database as now this data is only saved when a player exits the server or switches character. * Added a new config option so you can choose the effect when a player's hunger/thirst is empty. By default, you can choose between slowly losing health or blurring the screen. * Added a new system where if the usable food/drink items are spammed, they will get added to a queue and the animations will execute one at a time * Added a staff command to reset a players status. * Added the ability to set the under water oxygen from other scripts to support diving gear etc. * Added support for cd\_multicharacter when switching characters in game to reset the cached client side status data and re cache the new characters status data since you are able to save a characters data in the database now. * Added the ability for customers to make their own apps. {% endhint %} {% hint style="info" %} Edit * Changed disable move mode to right click instead of K. * Updated the codesign error handlers. * Allowed the stress value to be changed even tho config.stress is disabled. * Added the oxygen (in water) to the GetStatus() export. * Re-wrote and updated parts of the code. * Reworked the logic behind getting a players money to be **far** more optimized so it does not need to get the data from the server-side anymore. {% endhint %} {% hint style="warning" %} Fix * Fixed having to re-configure the hunger/thirst alert every time you relog. * Fixed random server error on server start. * Minor bug fixes. * Fixed the scale locale on the UI. * Temporary fix for the canary issue until the new Tebex FiveM license system is ready to launch, when this is released we will be fully switching over to the new system. * Fixed a typo which caused removing a status to only remove 1. {% endhint %} {% endtab %} {% tab title="4.0.0" %} ### 05/11/2021 **Files Changed:** * [x] All Files * [ ] All Files Except config.lua * [ ] Specific Files **Update Type:** * [x] Mandatory * [ ] Optional **Changelog:** {% hint style="danger" %} **Authentication** * **We are now using the official Authentication System provided by FiveM. The old auth system will be taken offline 1 week from now (give or take a few days if needed).** {% endhint %} {% hint style="success" %} **Add** * Added compatibility for oxmysq {% endhint %} {% endtab %} {% tab title="v4.0.1" %} ### 08/11/2021 **Files Changed:** * [ ] All Files * [ ] All Files Except config.lua * [x] Specific Files ```lua fxmanifest.lua - (IMPORTANT) server/main/server.lua - (IMPORTANT) client/main/client.lua - (IMPORTANT) html (FULL FOLDER) - (IMPORTANT) ``` **Update Type:** * [x] Mandatory * [ ] Optional **Changelog:** {% hint style="danger" %} **Authentication** * **Small authentication update to ensure stability**. {% endhint %} {% endtab %} {% tab title="v4.0.2" %} ### 14/06/2022 **Files Changed:** * [x] All Files * [ ] All Files Except config.lua * [ ] Specific Files **Update Type:** * [ ] Mandatory * [x] Optional **Changelog:** {% hint style="success" %} **Add** * Added compatibility with new oxmysql version. * Added compatibility with new qbcore permission changes. {% endhint %} {% hint style="info" %} **Edit** * Added some extra checks to make sure important config options have been set correctly. {% endhint %} {% hint style="warning" %} Fix * Fixed issue with blurred screen not resetting when setting or adding hunger/thirst using the /resetstatus command and other similar issues. {% endhint %} {% endtab %} {% endtabs %}