Update hudeditor.rst

This commit is contained in:
Aranud 2024-03-27 14:39:16 +01:00 committed by GitHub
parent d9967846f0
commit d5961429cc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -35,7 +35,13 @@ The HUD editor is divided in 3 differents frames :
Components can be toggle visible / invisible, which allow their usage or not. An invisible component is not rendered at all and the related functionnality aren't called.
HUD 0 (aka ``ETmain``) is the default HUD and can't be modified or deleted.
There are 5 pre-existing HUDs availabl. They can't be modified or deleted :
* ``ETmain`` (HUD 0 the default)
* ``Alternate Hud 1``
* ``Alternate Hud 2``
* ``Alternate Hud 3``
* ``Competitor Hud``
* ``Shoutcaster``
To start creating / setting a custom HUD, it is required to ``clone`` (copy) an existing HUD or using an existing one but HUD 0.
@ -147,6 +153,29 @@ Usage
+------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| f | Toggle the HUD editor in full screen (back to normal resolution and hiding component and settings panel) |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| a | Toggle the force alignment of component position on the grid when displayed |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| o | Toggle the micro grid visibility |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| c | Toggle the grid visibility to different level from None / Major / Major + Minor / Major + Minor + Rectangle Centered |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| d | Toggle the grid scaling to different level of precision .25 / .125 / .1 (see Scale Table below) |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------+
Scale Table
"""""""""""
+-----------+--------------------+---------------------+---------------------+------------------------------------------------------------------------------+
| Grid | .25 / tick (1:4) | .125 / tick (1:8) | .1 / tick (1:10) | Tickness (px) |
+===========+====================+=====================+=====================+==============================================================================+
| Major | 25 % | 12.5% | 10% | 0.5px |
+-----------+--------------------+---------------------+---------------------+------------------------------------------------------------------------------+
| Minor | 12.5% | 6.25% | 5% | 0.25px |
+-----------+--------------------+---------------------+---------------------+------------------------------------------------------------------------------+
| Rectangle | 25% | 12.5 / 25 / 37.5% | 10 / 20 / 30 / 40% | 1.25px |
+-----------+--------------------+---------------------+---------------------+------------------------------------------------------------------------------+
| Micro | 6.25% | 1,5625% | 1% | 0.1px |
+-----------+--------------------+---------------------+---------------------+------------------------------------------------------------------------------+
Components List
^^^^^^^^^^^^^^^
@ -239,7 +268,7 @@ breathtext
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
| Style Name | Description | Values |
+=======================+====================================================================================================+========+
| N/A | N/A | N/A |
| Draw Suffix | Draw the % Suffix | 1 |
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
centerprint
@ -527,6 +556,12 @@ fireteam
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
| No Header | Toggle header visibility (frame with fireteam name) | 2 |
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
| Colorless Name | Color player name color to white or full color | 4 |
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
| Status Color Name | Color player name depending of status (White: Alive / Yellow: Wounded / Red: Dead) | 8 |
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
| Status Color Row | Color player row depending of his status (White: Alive / Yellow: Wounded / Red: Dead) | 16 |
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
followtext
""""""""""
@ -643,6 +678,8 @@ healthtext
+=======================+====================================================================================================+========+
| Dynamic Color | Gradient the text color depending of player HP: White (>100) yellow (>66) orange (> 33) red (>0) | 1 |
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
| Draw Suffix | Draw the HP Suffix | 2 |
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
hudhead
"""""""
@ -1244,7 +1281,7 @@ sprinttext
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
| Style Name | Description | Values |
+=======================+====================================================================================================+========+
| N/A | N/A | N/A |
| Draw Suffix | Draw the % Suffix | 1 |
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
staminabar
@ -1503,7 +1540,7 @@ weaponchargetext
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
| Style Name | Description | Values |
+=======================+====================================================================================================+========+
| N/A | N/A | N/A |
| Draw Suffix | Draw the % Suffix | 1 |
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
weaponicon
@ -1621,7 +1658,7 @@ xptext
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
| Style Name | Description | Values |
+=======================+====================================================================================================+========+
| N/A | N/A | N/A |
| Draw Suffix | Draw the XP Suffix | 1 |
+-----------------------+----------------------------------------------------------------------------------------------------+--------+
Annexe