Correct Frame By Frame description CSF label error, append missing an…

…d correct existing hotkey docs (Phobos-developers#1327) FrameByFrame mistakenly used the `TXT_DISPLAY_DAMAGE_DESC` originally intended for the Display Damage function. It has affected my work, so I submitted this PR to make changes. That's all --------- Co-authored-by: Kerbiter <[email protected]>
Fryone · Aug 15, 2024 · 4daf90f · 4daf90f
1 parent 833767f
commit 4daf90f
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/docs/User-Interface.md b/docs/User-Interface.md
@@ -277,14 +277,23 @@ SelectionFlashDuration=0  ; integer, number of frames
     - These vanilla CSF entries will be used: `TXT_SAVING_GAME`, `TXT_GAME_WAS_SAVED` and `TXT_ERROR_SAVING_GAME`.
     - The save should be looks like `Allied Mission 25: Esther's Money - QuickSaved`
 
+### `[ ]` Save Variables
+
+- Save local & global variables to an INI file. See [this](Miscellanous.html#save-variables-to-file) for details.
+- For localization add `TXT_SAVE_VARIABLES` and `TXT_SAVE_VARIABLES_DESC` into your `.csf` file.
+
 ### `[ ]` Toggle Designator Range
 - Switches on/off super weapon designator range indicator. See [this](#show-designator--inhibitor-range) for details.
 - For localization add `TXT_DESIGNATOR_RANGE` and `TXT_DESIGNATOR_RANGE_DESC` into your `.csf` file.
 
 ### `[ ]` Toggle Digital Display
-- Switches on/off [digital gisplay types](#digital-display).
+- Switches on/off [digital display types](#digital-display).
 - For localization add `TXT_DIGITAL_DISPLAY` and `TXT_DIGITAL_DISPLAY_DESC` into your `.csf` file.
 
+### `[ ]` Toggle Frame By Frame Mode
+- Switches on/off [frame by frame mode](Miscellanous.html#frame-step-in).
+- For localization add `TXT_FRAME_BY_FRAME` and `TXT_FRAME_BY_FRAME_DESC` into your `.csf` file.
+
 ## Loading screen
 
 - PCX files can now be used as loadscreen images.

diff --git a/docs/Whats-New.md b/docs/Whats-New.md
@@ -545,6 +545,7 @@ Phobos fixes:
 - Fixed radiation site damage not taking the radiation level reduction into accord (by Starkku)
 - Correctly update laser trail position while techno is cloaked even if trail is not drawn (by Starkku)
 - Fixed `Shield.Respawn.Amount` not defaulting to shield type default if not set (by Starkku)
+- Fixed frame by frame hotkey description to read `TXT_FRAME_BY_FRAME_DESC` instead of `TXT_DISPLAY_DAMAGE_DESC` (by DeathFishAtEase)
 
 Fixes / interactions with other extensions:
 - All forms of type conversion (including Ares') now correctly update the warp-in delay if unit with teleport `Locomotor` was converted while the delay was active (by Starkku)

diff --git a/src/Commands/FrameByFrame.cpp b/src/Commands/FrameByFrame.cpp
@@ -26,7 +26,7 @@ const wchar_t* FrameByFrameCommandClass::GetUICategory() const
 
 const wchar_t* FrameByFrameCommandClass::GetUIDescription() const
 {
-	return GeneralUtils::LoadStringUnlessMissing("TXT_DISPLAY_DAMAGE_DESC", L"Enter or exit frame by frame mode.");
+	return GeneralUtils::LoadStringUnlessMissing("TXT_FRAME_BY_FRAME_DESC", L"Enter or exit frame by frame mode.");
 }
 
 void FrameByFrameCommandClass::Execute(WWKey eInput) const