Skip to content

Commit a399231

Browse files
committed
add qtfred help docs
1 parent 27856f8 commit a399231

3 files changed

Lines changed: 80 additions & 12 deletions

File tree

qtfred/help-src/doc/dialogs/MissionSpecsDialog.html

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -71,18 +71,9 @@ <h2>Loading Screen</h2>
7171
</table>
7272

7373
<h2>Support Ships</h2>
74-
<table>
75-
<tr><th>Control</th><th>Description</th></tr>
76-
<tr><td>Disallow support ships</td><td>Prevents any support ship from appearing
77-
in this mission.</td></tr>
78-
<tr><td>Enable hull repair</td><td>Allows the support ship to repair hull damage
79-
in addition to subsystems. Subsystem repair is always available when a support
80-
ship is present.</td></tr>
81-
<tr><td>Hull repair ceiling</td><td>Maximum percentage of hull the support ship
82-
can restore, when hull repair is enabled.</td></tr>
83-
<tr><td>Subsystem repair ceiling</td><td>Maximum percentage of subsystem
84-
integrity the support ship can restore.</td></tr>
85-
</table>
74+
<p>Opens the <a href="SupportRearmDialog.html">Support Options</a> sub-dialog,
75+
which controls support ship availability, hull and subsystem repair ceilings, rearm
76+
permissions, and the per-weapon rearm pool.</p>
8677

8778
<h2>Ship Trails</h2>
8879
<p>Controls engine contrail visibility. By default, trails are <em>on</em> in
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8"/>
5+
<title>Support Options - QtFRED Help</title>
6+
<link rel="stylesheet" type="text/css" href="../css/help.css"/>
7+
</head>
8+
<body>
9+
<nav class="breadcrumb"><a href="../index.html">QtFRED Help</a> &rsaquo; Mission &rsaquo;
10+
<a href="MissionSpecsDialog.html">Mission Specs</a> &rsaquo; Support Options</nav>
11+
<h1>Support Options</h1>
12+
<p>Opens via <strong>Editors &rsaquo; Mission Specs &rsaquo; Support Options</strong>.</p>
13+
<p>Controls whether support ships appear in the mission, how much they can repair, whether
14+
they can rearm weapons, and how many of each weapon they carry in their rearm pool.</p>
15+
16+
<h2>Repair settings</h2>
17+
<table>
18+
<tr><th>Control</th><th>Description</th></tr>
19+
<tr><td>Allow Support Ships</td><td>When unchecked, no support ship can appear in
20+
this mission regardless of the loadout.</td></tr>
21+
<tr><td>Support Ships Repair Hull</td><td>Allows support ships to repair hull damage
22+
in addition to subsystems. Subsystem repair is always available when support ships
23+
are allowed.</td></tr>
24+
<tr><td>Hull Repair Ceiling</td><td>Maximum percentage of hull integrity a support
25+
ship can restore. Only meaningful when hull repair is enabled.</td></tr>
26+
<tr><td>Subsystem Repair Ceiling</td><td>Maximum percentage of subsystem integrity a
27+
support ship can restore.</td></tr>
28+
</table>
29+
30+
<h2>Rearm options</h2>
31+
<table>
32+
<tr><th>Control</th><th>Description</th></tr>
33+
<tr><td>Disallow Support Rearm</td><td>Prevents support ships from rearming any
34+
weapons. Repair is still permitted if support ships are allowed.</td></tr>
35+
<tr><td>Limit Rearm to Mission Pool</td><td>Restricts rearming to the quantities
36+
defined in the <strong>Support Rearm Pool</strong> table below. Once a weapon's
37+
pool is exhausted, support ships cannot supply more of it. A pool value of
38+
<strong>-1</strong> means unlimited for that weapon.</td></tr>
39+
<tr><td>Set Rearm Pool from Loadout Pool surplus</td><td>Initialises each weapon's
40+
pool amount from any surplus left over in the player loadout pool at mission
41+
start, in addition to any values set manually.</td></tr>
42+
<tr><td>Use Weapon Precedence when pool is empty</td><td>When a weapon's pool is
43+
exhausted, the support ship substitutes a weapon from the precedence list defined
44+
in the weapon tables rather than simply refusing to rearm.</td></tr>
45+
</table>
46+
47+
<h2>Support Rearm Pool</h2>
48+
<p>Sets how many of each weapon the support ships can supply across the entire mission.
49+
Only active when <strong>Limit Rearm to Mission Pool</strong> is checked. Each team in
50+
a Team vs. Team mission has its own independent pool; use <strong>Pool Team</strong> to
51+
switch between them.</p>
52+
<p>Select a weapon in the list to edit its pool amount, then use the buttons to apply a
53+
value. The amount field accepts any integer; use <strong>-1</strong> for unlimited.</p>
54+
<table>
55+
<tr><th>Control</th><th>Description</th></tr>
56+
<tr><td>Pool Team</td><td>Selects which team's pool is shown. In non-Team vs. Team
57+
missions only one team entry is present.</td></tr>
58+
<tr><td>Weapon list</td><td>Lists all player-allowed weapons. Select a weapon to
59+
target it with the amount buttons.</td></tr>
60+
<tr><td>Pool Amount</td><td>Amount to apply when clicking <strong>Set Amount</strong>
61+
or <strong>Set ALL to Amount</strong>.</td></tr>
62+
<tr><td>Set Amount</td><td>Sets the selected weapon's pool to the value in
63+
<strong>Pool Amount</strong>.</td></tr>
64+
<tr><td>Set Unlimited (-1)</td><td>Sets the selected weapon's pool to -1
65+
(unlimited).</td></tr>
66+
<tr><td>Set Zero</td><td>Sets the selected weapon's pool to 0, preventing support
67+
ships from supplying it entirely.</td></tr>
68+
<tr><td>Set ALL to Amount</td><td>Applies the <strong>Pool Amount</strong> value to
69+
every weapon in the list at once.</td></tr>
70+
<tr><td>Set ALL to Unlimited</td><td>Sets every weapon's pool to -1.</td></tr>
71+
<tr><td>Set ALL to Zero</td><td>Sets every weapon's pool to 0.</td></tr>
72+
</table>
73+
</body>
74+
</html>

qtfred/help-src/doc/qtfred.qhp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
<section title="Custom Strings" ref="dialogs/CustomStringsDialog.html"/>
3737
<section title="Custom Wing Names" ref="dialogs/CustomWingNamesDialog.html"/>
3838
<section title="Sound Environment" ref="dialogs/SoundEnvironmentDialog.html"/>
39+
<section title="Support Options" ref="dialogs/SupportRearmDialog.html"/>
3940
</section>
4041
<section title="Mission Statistics" ref="dialogs/MissionStatsDialog.html"/>
4142
<section title="Reinforcements" ref="dialogs/ReinforcementsEditorDialog.html"/>
@@ -112,6 +113,7 @@
112113
<keyword name="Mission Events" id="MissionEventsDialog" ref="dialogs/MissionEventsDialog.html"/>
113114
<keyword name="Mission Goals" id="MissionGoalsDialog" ref="dialogs/MissionGoalsDialog.html"/>
114115
<keyword name="Mission Specs" id="MissionSpecDialog" ref="dialogs/MissionSpecsDialog.html"/>
116+
<keyword name="Support Options" id="SupportRearmDialog" ref="dialogs/SupportRearmDialog.html"/>
115117
<keyword name="Custom Wing Names" id="CustomWingNamesDialog" ref="dialogs/CustomWingNamesDialog.html"/>
116118
<keyword name="Sound Environment" id="SoundEnvironmentDialog" ref="dialogs/SoundEnvironmentDialog.html"/>
117119
<keyword name="Custom Strings" id="CustomStringsDialog" ref="dialogs/CustomStringsDialog.html"/>
@@ -175,6 +177,7 @@
175177
<file>dialogs/MissionEventsDialog.html</file>
176178
<file>dialogs/MissionGoalsDialog.html</file>
177179
<file>dialogs/MissionSpecsDialog.html</file>
180+
<file>dialogs/SupportRearmDialog.html</file>
178181
<file>dialogs/CustomWingNamesDialog.html</file>
179182
<file>dialogs/CustomStringsDialog.html</file>
180183
<file>dialogs/SoundEnvironmentDialog.html</file>

0 commit comments

Comments
 (0)