From be9a6e3047fa7ba026bb4a6ba4260f6c7392b6a2 Mon Sep 17 00:00:00 2001 From: Aranud Date: Thu, 28 Dec 2023 12:03:21 +0100 Subject: [PATCH] Update hudeditor.rst --- hudeditor.rst | 140 +++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 117 insertions(+), 23 deletions(-) diff --git a/hudeditor.rst b/hudeditor.rst index 53349ad..be37a23 100644 --- a/hudeditor.rst +++ b/hudeditor.rst @@ -33,7 +33,7 @@ The HUD editor is divided in 3 differents frames : * Customization panel on the left * Components selection panel on the bottom -Components can be toogle visible / invisible, which allow their usage or not. An invisible component is not rendered at all and the related functionnality aren't called. +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. @@ -94,10 +94,10 @@ The panel is divided in 4 differents categories : - B: Blue color selector ranged from 0 to 255 - A: Alpha (aka transparency) selector ranged from 0 to 255 - Style: Customizable options separated in 2 categories, generic option and specific one. All component have access to generic option, but not all use specific one. See Component ``Style``. - - Visible : Toogle the component visibility - - AutoAdj : Toogle the automatic adjustement of the border position and size depending of the content - - Background : Toogle the background visibility - - Border : Toogle the border visibility + - Visible : Toggle the component visibility + - AutoAdj : Toggle the automatic adjustement of the border position and size depending of the content + - Background : Toggle the background visibility + - Border : Toggle the border visibility Usage """"" @@ -139,13 +139,13 @@ Usage +------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | Page Down | Move component to the middle height of the HUD (if above it) or to the bottom of the HUD | +------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| l | Toogle the layout visibilty of **None** / **Visible** / **All** components (aka outline) | +| l | Toggle the layout visibilty of **None** / **Visible** / **All** components (aka outline) | +------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| h | Toogle the help window visibility | +| h | Toggle the help window visibility | +------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| n | Toogle the noise generator to simulate components animation | +| n | Toggle the noise generator to simulate components animation | +------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| f | Toogle the HUD editor in full screen (back to normal resolution and hiding component and settings panel) | +| f | Toggle the HUD editor in full screen (back to normal resolution and hiding component and settings panel) | +------------------------------------+----------------------------------------------------------------------------------------------------------------------+ Components List @@ -285,7 +285,7 @@ chat +-----------------------+----------------------------------------------------------------------------------------------------+--------+ | Style Name | Description | Values | +=======================+====================================================================================================+========+ -| No Team Flag | Toogle team flag visibility next to the chat line | 1 | +| No Team Flag | Toggle team flag visibility next to the chat line | 1 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ compass @@ -374,11 +374,11 @@ crosshairbar +-----------------------+----------------------------------------------------------------------------------------------------+--------+ | Style Name | Description | Values | +=======================+====================================================================================================+========+ -| Class | Toogle class icon visibility of targeted player | 1 | +| Class | Toggle class icon visibility of targeted player | 1 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ -| Rank | Toogle rank icon visibility of targeted player | 2 | +| Rank | Toggle rank icon visibility of targeted player | 2 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ -| Prestige | Toogle prestige icon visibility of targeted player | 4 | +| Prestige | Toggle prestige icon visibility of targeted player | 4 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ | Left | Move maximum on left. If ``Vertical`` is set, maximum is on top. Ignored if ``Center`` is set | 8 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ @@ -500,7 +500,7 @@ disconnect +-----------------------+----------------------------------------------------------------------------------------------------+--------+ | Style Name | Description | Values | +=======================+====================================================================================================+========+ -| No Text | Toogle string visibility "Connection Interrupted" when client loast connection to server | 1 | +| No Text | Toggle string visibility "Connection Interrupted" when client loast connection to server | 1 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ fireteam @@ -525,7 +525,7 @@ fireteam +=======================+====================================================================================================+========+ | Latched Class | Draw the team mate selected class on next respawn if different from the current one | 1 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ -| No Header | Toogle header visibility (frame with fireteam name) | 2 | +| No Header | Toggle header visibility (frame with fireteam name) | 2 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ followtext @@ -710,7 +710,7 @@ limbotext +-----------------------+----------------------------------------------------------------------------------------------------+--------+ | Style Name | Description | Values | +=======================+====================================================================================================+========+ -| No Wounded Msg | Toogle string visibility "You are wounded and waiting for a medic" | 1 | +| No Wounded Msg | Toggle string visibility "You are wounded and waiting for a medic" | 1 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ livesleft @@ -756,7 +756,7 @@ localtime +-----------------------+----------------------------------------------------------------------------------------------------+--------+ | Style Name | Description | Values | +=======================+====================================================================================================+========+ -| Second | Toogle seconds visibility | 1 | +| Second | Toggle seconds visibility | 1 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ | 12 Hours | Change hours time format between 24 or 12 suffixed by AM / PM | 2 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ @@ -921,6 +921,8 @@ popupmessages +-----------------------+----------------------------------------------------------------------------------------------------+--------+ | Force Colors | Force the font color by using defined ``Main Color`` | 256 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ +| Scroll Down | Toggle pop-up appearance beginning from Up or Bottom | 512 | ++-----------------------+----------------------------------------------------------------------------------------------------+--------+ powerups """""""" @@ -1015,6 +1017,98 @@ roundtimer | Simple | Don't show reinforcement and enemy spaw timer next to round timer | 1 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ +scPlayerListAllies +"""""""""""""""""" + +:Description: The list containing allies player status, used in shoutcaster mod to display up to 6 axis players + +:Game type Availability: Shoutcaster only + +:Type: Specific + ++-----------------------+-------------------------------------------------------------------------------------------------------------+ +| Color | Description | ++=======================+=============================================================================================================+ +| Main Color | Font color | ++-----------------------+-------------------------------------------------------------------------------------------------------------+ +| Secondary Color | Health Bar Color | ++-----------------------+-------------------------------------------------------------------------------------------------------------+ + ++-----------------------+----------------------------------------------------------------------------------------------------+--------+ +| Style Name | Description | Values | ++=======================+====================================================================================================+========+ +| N/A | N/A | N/A | ++-----------------------+----------------------------------------------------------------------------------------------------+--------+ + +scPlayerListAxis +"""""""""""""""" + +:Description: The list containing axis player status, used in shoutcaster mod to display up to 6 axis players + +:Game type Availability: Shoutcaster only + +:Type: Specific + ++-----------------------+-------------------------------------------------------------------------------------------------------------+ +| Color | Description | ++=======================+=============================================================================================================+ +| Main Color | Font color | ++-----------------------+-------------------------------------------------------------------------------------------------------------+ +| Secondary Color | Health Bar Color | ++-----------------------+-------------------------------------------------------------------------------------------------------------+ + ++-----------------------+----------------------------------------------------------------------------------------------------+--------+ +| Style Name | Description | Values | ++=======================+====================================================================================================+========+ +| N/A | N/A | N/A | ++-----------------------+----------------------------------------------------------------------------------------------------+--------+ + +scTeamNamesAllies +""""""""""""""""" + +:Description: The banner text contaning custom name for allies team + +:Game type Availability: Shoutcaster only + +:Type: Text + ++-----------------------+-------------------------------------------------------------------------------------------------------------+ +| Color | Description | ++=======================+=============================================================================================================+ +| Main Color | Font color | ++-----------------------+-------------------------------------------------------------------------------------------------------------+ +| Secondary Color | Font shadow color | ++-----------------------+-------------------------------------------------------------------------------------------------------------+ + ++-----------------------+----------------------------------------------------------------------------------------------------+--------+ +| Style Name | Description | Values | ++=======================+====================================================================================================+========+ +| N/A | N/A | N/A | ++-----------------------+----------------------------------------------------------------------------------------------------+--------+ + +scTeamNamesAxis +""""""""""""""" + +:Description: The banner text contaning custom name for axis team + +:Game type Availability: Shoutcaster only + +:Type: Text + ++-----------------------+-------------------------------------------------------------------------------------------------------------+ +| Color | Description | ++=======================+=============================================================================================================+ +| Main Color | Font color | ++-----------------------+-------------------------------------------------------------------------------------------------------------+ +| Secondary Color | Font shadow color | ++-----------------------+-------------------------------------------------------------------------------------------------------------+ + ++-----------------------+----------------------------------------------------------------------------------------------------+--------+ +| Style Name | Description | Values | ++=======================+====================================================================================================+========+ +| N/A | N/A | N/A | ++-----------------------+----------------------------------------------------------------------------------------------------+--------+ + snapshot """""""" @@ -1272,7 +1366,7 @@ votetext +-----------------------+----------------------------------------------------------------------------------------------------+--------+ | Style Name | Description | Values | +=======================+====================================================================================================+========+ -| Complaint | Toogle complaint proposal text visibility on player getting team killed | 1 | +| Complaint | Toggle complaint proposal text visibility on player getting team killed | 1 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ warmuptext @@ -1502,9 +1596,9 @@ xpgain +-----------------------+----------------------------------------------------------------------------------------------------+--------+ | Style Name | Description | Values | +=======================+====================================================================================================+========+ -| Scroll Down | Toogle pop-up appearance beginning from Up or Bottom | 1 | +| Scroll Down | Toggle pop-up appearance beginning from Up or Bottom | 1 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ -| No Reason | Toogle XP gain message visility and draw skill icon + gain only | 2 | +| No Reason | Toggle XP gain message visility and draw skill icon + gain only | 2 | +-----------------------+----------------------------------------------------------------------------------------------------+--------+ xptext @@ -1546,7 +1640,7 @@ Options list +--------------------+-----------------------------------------------------------------------------------+-------------------------------------------------+ | h | Component Height | 0 - 480 (visible grid limit, can be out ranged) | +--------------------+-----------------------------------------------------------------------------------+-------------------------------------------------+ -| visible | Toogle component visibility | 0 - 1 (boolean) | +| visible | Toggle component visibility | 0 - 1 (boolean) | +--------------------+-----------------------------------------------------------------------------------+-------------------------------------------------+ | style | Customize component depending of his usage (if available) | See Style Section | +--------------------+-----------------------------------------------------------------------------------+-------------------------------------------------+ @@ -1556,11 +1650,11 @@ Options list +--------------------+-----------------------------------------------------------------------------------+-------------------------------------------------+ | colorSecondary | Change secondary component color (specific, not available for text component) | See :ref:`Color Usage` | +--------------------+-----------------------------------------------------------------------------------+-------------------------------------------------+ -| showBackGround | Toogle background visibility | 0 - 1 (boolean) | +| showBackGround | Toggle background visibility | 0 - 1 (boolean) | +--------------------+-----------------------------------------------------------------------------------+-------------------------------------------------+ | colorBackground | Change the component background color | See :ref:`Color Usage` | +--------------------+-----------------------------------------------------------------------------------+-------------------------------------------------+ -| showBorder | Toogle border visibility | 0 - 1 (boolean) | +| showBorder | Toggle border visibility | 0 - 1 (boolean) | +--------------------+-----------------------------------------------------------------------------------+-------------------------------------------------+ | colorBorder | Change the component border color | See :ref:`Color Usage` | +--------------------+-----------------------------------------------------------------------------------+-------------------------------------------------+