dutchie031andGitHub
0233b9e2d7
- Refactored all CAP classes. - Improved timing - Zones are now not tied to MissionStages - CAPROUTE_<routeID>_<free> - routeID is now what is used in the naming convention. - Units taxi back to their spawn parking space and rearm there. (Units destroyed while in the Rearming or Repairing state are not taken into account)
330 lines
19 KiB
HTML
330 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" data-theme="dark">
|
|
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>Spearhead Reference</title>
|
|
<link rel="stylesheet" href="../style/style.css">
|
|
<script src="../js/site.js"></script>
|
|
<style>
|
|
.side-nav a.active {
|
|
font-weight: bold;
|
|
color: #4fc3f7;
|
|
}
|
|
</style>
|
|
</head>
|
|
|
|
<body>
|
|
<header>
|
|
<div class="header-box">
|
|
<a class="logo" href="../index.html">Spearhead</a>
|
|
<div class="header-right">
|
|
<nav>
|
|
<a href="../index.html">Home</a>
|
|
<a href="../pages/tutorials.html">Tutorials</a>
|
|
<a href="../pages/persistence.html">Persistence</a>
|
|
<a href="../pages/reference.html">Reference</a>
|
|
<a href="../pages/spearheadapi.html">API</a>
|
|
</nav>
|
|
<button id="theme-toggle" class="theme-toggle" title="Toggle light/dark theme">
|
|
<svg id="moon-icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
|
<path d="M12 11.807A9.002 9.002 0 0 1 10.049 2a9.942 9.942 0 0 0-5.12 2.735c-3.905 3.905-3.905 10.237 0 14.142 3.906 3.906 10.237 3.905 14.143 0a9.946 9.946 0 0 0 2.735-5.119A9.003 9.003 0 0 1 12 11.807z"/>
|
|
</svg>
|
|
<svg id="sun-icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" style="display: none;">
|
|
<path d="M6.995 12c0 2.761 2.246 5.007 5.007 5.007s5.007-2.246 5.007-5.007-2.246-5.007-5.007-5.007S6.995 9.239 6.995 12zM12 8.993c1.658 0 3.007 1.349 3.007 3.007S13.658 15.007 12 15.007 8.993 13.658 8.993 12 10.342 8.993 12 8.993zM10.998 19H12.998V22H10.998zM10.998 2H12.998V5H10.998zM1.998 11H4.998V13H1.998zM18.998 11H21.998V13H18.998z"/>
|
|
<path transform="rotate(-45.017 5.986 18.01)" d="M4.986 17.01H6.986V19.01H4.986z"/>
|
|
<path transform="rotate(-45.001 18.008 5.99)" d="M17.008 4.99H19.008V6.99H17.008z"/>
|
|
<path transform="rotate(-134.983 5.988 5.99)" d="M4.988 4.99H6.988V6.99H4.988z"/>
|
|
<path transform="rotate(134.999 18.008 18.01)" d="M17.008 17.01H19.008V19.01H17.008z"/>
|
|
</svg>
|
|
</button>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<main>
|
|
<div class="reference-container">
|
|
<div class="side-nav">
|
|
<h4 class="side-nav-title"></h4>
|
|
<ul>
|
|
<li><a href="#configuration" class="side-nav-h2">Configuration</a></li>
|
|
<li><a href="#general-naming-conventions" class="side-nav-h2">Naming Conventions</a>
|
|
<ul>
|
|
<li><a href="#stage-zones" class="side-nav-h3">Stage Zones</a></li>
|
|
<li><a href="#waiting-stages" class="side-nav-h3">Waiting Stages</a></li>
|
|
<li><a href="#mission-zones" class="side-nav-h3">Mission Zones</a></li>
|
|
<li><a href="#cap-routes" class="side-nav-h3">CAP Routes</a></li>
|
|
<li><a href="#farp-zones" class="side-nav-h3">FARP Zones</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#mission-types" class="side-nav-h2">Mission Types</a>
|
|
<ul>
|
|
<li><a href="#sam" class="side-nav-h3">SAM</a></li>
|
|
<li><a href="#dead" class="side-nav-h3">DEAD</a></li>
|
|
<li><a href="#bai" class="side-nav-h3">BAI</a></li>
|
|
<li><a href="#cas" class="side-nav-h3">BAI</a></li>
|
|
<li><a href="#strike" class="side-nav-h3">STRIKE</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#mission-briefings" class="side-nav-h2">Mission Briefings</a>
|
|
<ul>
|
|
<li><a href="#special-fields" class="side-nav-h3">Special Fields</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#cap-configuration" class="side-nav-h2">CAP Configuration</a>
|
|
<ul>
|
|
<li><a href="#cap-group-naming" class="side-nav-h3">CAP Group Naming</a></li>
|
|
<li><a href="#cap-group-config" class="side-nav-h3">CAP Group Config</a></li>
|
|
<li><a href="#active-and-backup-cap" class="side-nav-h3">Active and Backup CAP</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#randomization" class="side-nav-h2">Randomization</a></li>
|
|
<li><a href="#in-stage-dependencies" class="side-nav-h2">In stage dependencies</a></li>
|
|
<li><a href="#buildable" class="side-nav-h2">Buildables</a></li>
|
|
<li><a href="#runway-bombing" class="side-nav-h2">Runway Bombing</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="content-wrapper">
|
|
<h1>Reference</h1>
|
|
<p>
|
|
This page provides a detailed overview of all settings, naming conventions, and logic used in
|
|
Spearhead. <br />
|
|
For a quick start guide, visit the <a href="./tutorials.html">Tutorials</a> page.
|
|
</p>
|
|
<h2 id="configuration">Configuration</h2>
|
|
<p>
|
|
For the configuration you can reference the configuration as it is below:
|
|
|
|
</p>
|
|
|
|
<pre>
|
|
@@CONFIG_CODE@@
|
|
</pre>
|
|
|
|
|
|
<h2 id="general-naming-conventions">Naming Conventions</h2>
|
|
<p>
|
|
Spearhead uses specific naming conventions for zones, missions, and CAP configurations. These
|
|
conventions are critical for the framework to function correctly.
|
|
</p>
|
|
|
|
<h3 id="stage-zones">Stage Zones</h3>
|
|
<p>
|
|
<strong>Format:</strong> <span class="inline-lua"><span class="lua-variable">MISSIONSTAGE_[OrderNumber]_[FreeForm]</span></span>
|
|
<br />
|
|
<strong>Example:</strong> <span class="inline-lua"><span class="lua-variable">MISSIONSTAGE_1_EAST</span></span>
|
|
</p>
|
|
<p>
|
|
Stages are logical parts of a mission. They encapsulate multiple missions, airbases, and other
|
|
objects. <br />
|
|
Secondary stages can be defined using the format: <span
|
|
class="inline-lua"><span class="lua-variable">MISSIONSTAGE_x[OrderNumber]</span></span>.
|
|
</p>
|
|
|
|
<h3 id="waiting-stages">Waiting Stages</h3>
|
|
<p>
|
|
<strong>Format:</strong> <span class="inline-lua"><span class="lua-variable">WAITINGSTAGE_[Order]_[Seconds]</span></span> <br />
|
|
<strong>Example:</strong> <span class="inline-lua"><span class="lua-variable">WAITINGSTAGE_2_180</span></span>
|
|
</p>
|
|
<p>
|
|
Waiting stages introduce delays between stages. They activate only after the previous stage is
|
|
completed.
|
|
</p>
|
|
|
|
<h3 id="mission-zones">Mission Zones</h3>
|
|
<p>
|
|
<strong>Format:</strong> <span class="inline-lua"><span class="lua-variable">MISSION_[Type]_[Name]</span></span> <br />
|
|
<strong>Example:</strong> <span class="inline-lua"><span class="lua-variable">MISSION_DEAD_BYRON</span></span>
|
|
</p>
|
|
<p>
|
|
Missions are completable objectives with specific types, such as DEAD, BAI, STRIKE, or SAM. <br />
|
|
Randomized missions can be defined using the format: <span
|
|
class="inline-lua"><span class="lua-variable">RANDOMMISSION_[Type]_[Name]_[Index]</span></span>.
|
|
</p>
|
|
|
|
<h3 id="cap-routes">CAP Routes</h3>
|
|
<p>
|
|
<strong>Format:</strong> <span class="inline-lua"><span class="lua-variable">CAPROUTE_[routeID]_[Name]</span></span> <br />
|
|
<strong>Example:</strong> <span class="inline-lua"><span class="lua-variable">CAPROUTE_103_ALPHA</span></span>
|
|
</p>
|
|
<p>
|
|
CAP routes define the patrol paths for CAP units. They are tied to specific stages and zones.
|
|
</p>
|
|
|
|
<h3 id="farp-zones">FARP Zones</h3>
|
|
<p>
|
|
<strong>Format:</strong> <span class="inline-lua"><span class="lua-variable">FARP_A|B_[Name]</span></span> <br />
|
|
<strong>Example:</strong> <span class="inline-lua"><span class="lua-variable">FARP_A_HOUSTON</span></span>
|
|
<strong>Example:</strong> <span class="inline-lua"><span class="lua-variable">FARP_B_HOUSTON</span></span>
|
|
</p>
|
|
<p>
|
|
FARP zones are spawned and activated based on the "activation parameter". <br/>
|
|
A: Activates when the parent stage zone activates. <br/>
|
|
B: Activates when the parent stage is "Blue". <br/>
|
|
<br/>
|
|
Future: FARP zones will be "buildable" once logistics are implemented.
|
|
|
|
|
|
</p>
|
|
|
|
<h3 id="supply-hub">Supply Hub</h3>
|
|
<p>
|
|
<strong>Format:</strong> <span class="inline-lua"><span class="lua-variable">SUPPLYHUB_[Name]</span></span> <br />
|
|
<strong>Format:</strong> <span class="inline-lua"><span class="lua-variable">SUPPLYHUB_A_[Name]</span></span> <br />
|
|
<strong>Example:</strong> <span class="inline-lua"><span class="lua-variable">SUPPLYHUB_HOUSTON</span></span> <br/> <br/>
|
|
|
|
Supply hubs are used as zones to pick up logistics for logistic missions. <br/>
|
|
They are activated when their parent is activated. <br/>
|
|
Activated depends on what it's parent is. <br/>
|
|
If it's a stage. It can be SUPPLYHUB_A_[name] when you want it to be active when the stage is initiated. (red state) or SUPPLYHUB_B_ it you want it activated when it's BLUE only. <br/>
|
|
If you place the Supply Hub trigger zone inside of a FARP zone the supply hub will activate when the FARP zone is activated. <br/>
|
|
If the FARP needs to be built first, then that means the supply hub also is activated later. <br/>
|
|
|
|
NOTE: The supply hub does not spawn anything, but merely give options to pick up logistics.
|
|
</p>
|
|
|
|
<h2 id="mission-types">Mission Types</h2>
|
|
<p>
|
|
Each mission type has specific logic and completion criteria. Below are the supported types:
|
|
</p>
|
|
|
|
<h3 id="sam">SAM</h3>
|
|
<p>
|
|
SAM missions involve surface-to-air missile sites. These missions are activated when a stage is
|
|
"Pre-Active." <br />
|
|
<strong>Completion Logic:</strong> Destroy all air defenses in the zone.
|
|
</p>
|
|
|
|
<h3 id="dead">DEAD</h3>
|
|
<p>
|
|
DEAD missions target enemy air defenses. They are activated at the start of a stage. <br />
|
|
<strong>Completion Logic:</strong> Destroy all designated targets in the zone.
|
|
</p>
|
|
|
|
<h3 id="bai">BAI</h3>
|
|
<p>
|
|
BAI missions involve battlefield air interdiction. These missions target enemy ground forces.
|
|
</p>
|
|
|
|
<h3 id="cas">CAS</h3>
|
|
<p>
|
|
CAS missions involve close air support for friendly ground forces. <br />
|
|
CAS mission have a special "BattleManager" module added by defualt. This will make blue and red units shoot at eachoter. <br/>
|
|
This creates a nice effect. <br/>
|
|
To see how it's done see: <a href="./tutorials.html#mission-cas">[Tutorials] Mission: CAS</a>
|
|
</p>
|
|
|
|
<h3 id="strike">STRIKE</h3>
|
|
<p>
|
|
STRIKE missions target strategic objectives, such as supply depots or command centers. <br />
|
|
<strong>Completion Logic:</strong> Destroy all designated targets in the zone.
|
|
</p>
|
|
|
|
<h2 id="mission-briefings">Mission Briefings</h2>
|
|
<p>
|
|
Mission briefings are text boxes (draw layer) inside of the trigger zone of the mission. <br />
|
|
</p>
|
|
|
|
<h3 id ="special-fields">Special Fields</h3>
|
|
<p>
|
|
Special fields are used to display information in the mission briefings. <br />
|
|
They are replaced with the corresponding values at the time a briefing is requested and can therefore show real time data. <br/>
|
|
|
|
|
|
<strong>Field:</strong> <span class="inline-lua"><span class="lua-variable">{{coords}}</span></span><br/>
|
|
Coords are taken from the location of the trigger zone. Then converted to the aircrafts preferred format. <br/>
|
|
</p>
|
|
|
|
<h2 id="cap-configuration">CAP Configuration</h2>
|
|
<p>
|
|
CAP (Combat Air Patrol) units are managed using specific naming conventions and configurations.
|
|
</p>
|
|
|
|
<h3 id="cap-group-naming">CAP Group Naming</h3>
|
|
<p>
|
|
<strong>Format:</strong> <span class="inline-lua"><span class="lua-variable">CAP_[A|B][Config]_[FreeForm]</span></span> <br />
|
|
<strong>Example:</strong> <span class="inline-lua"><span class="lua-variable">CAP_A[1-4]5_SomeName</span></span>
|
|
</p>
|
|
|
|
<h3 id="cap-group-config">CAP Group Config</h3>
|
|
<pre>
|
|
<span class="lua-comment">1 at x:</span> <span class="lua-variable">[<activeStage>]<CapRouteID></span>
|
|
<span class="lua-comment">n and n at x:</span> <span class="lua-variable">[<activeStage>,<activeStage>]<CapRouteID></span>
|
|
<span class="lua-comment">n till n at x:</span> <span class="lua-variable">[<activeStage>-<activeStage>]<CapRouteID></span>
|
|
<span class="lua-comment">n till n and n at x:</span> <span class="lua-variable">[<activeStage>-<activeStage>,<activeStage>]<CapRouteID></span>
|
|
|
|
<span class="lua-comment">Divider: |</span>
|
|
|
|
<span class="lua-comment">Examples:</span>
|
|
<span class="lua-variable">CAP_A[1-4,6]7|[5,7]8_SomeName</span> <span class="lua-comment">=> Will fly CAP at stage 7 when stages 1 through 4 and 6 are active and will fly CAP at 8 when 5 and 7 are active.</span>
|
|
<span class="lua-variable">CAP_A[2-5]5|[6]6_SomeName</span> <span class="lua-comment">=> Will fly CAP at stage 5 when stages 2 through 5 are active and will fly CAP at CapRoute 6 when 6 is active.</span>
|
|
</pre>
|
|
|
|
<h3 id="active-and-backup-cap">Active and Backup CAP</h3>
|
|
<p>
|
|
<strong>Active Units:</strong> Define the maximum number of groups in a zone at a time. <br />
|
|
<strong>Backup Units:</strong> Fill in when active units are unavailable due to RTB, death, or
|
|
rearming.
|
|
</p>
|
|
|
|
<h2 id="randomization">Randomization</h2>
|
|
<p>
|
|
Missions can be randomized using the <span class="inline-lua"><span class="lua-variable">RANDOMMISSION</span></span> prefix. <br />
|
|
Spearhead will pick one random mission from zones with the same name.
|
|
</p>
|
|
|
|
<h2 id="in-stage-dependencies">In stage depencies</h2>
|
|
<p>
|
|
If you want to have missions inside of a stage depends on each other you can. <br/>
|
|
Add a text drawing box inside of the mission trigger zone with the name:
|
|
<span class="inline-lua"><span class="lua-variable">dependson_[freeform]</span></span> <br/>
|
|
And in the text add the "Name" of the mission zone you want the mission to depend on. <br/>
|
|
The mission will be "pre-activated" (spawned) but won't have a f10 mission menu until the mission(s) it depends on is completed. <br/>
|
|
</p>
|
|
|
|
<h2 id="buildable">Buildables</h2>
|
|
<p>
|
|
Current buildables: <br/>
|
|
<span class="inline-lua"><span class="lua-variable">FARP_</span></span> <br/>
|
|
<span class="inline-lua"><span class="lua-variable">BLUESAM_</span></span> <br/>
|
|
<span class="inline-lua"><span class="lua-variable">Airbases</span></span> <br/>
|
|
<br/>
|
|
|
|
Buildables are zones or objects that first require logistics. <br/>
|
|
Eg. A forward SAM site or FARP requires logistic crates before it can be built. <br/>
|
|
|
|
To make an item buildable add a text box inside of the trigger zone and name it: <span class="inline-lua"><span class="lua-variable">buildable_[freeform]</span></span> <br/>
|
|
Then in the text box type amount of kilo's you want to be transfered before the logistisc mission is complete. <br/>
|
|
The base will slowly build up with each crate giving both a nice view of it happening AND it's good for performance as there's not a big addition of objects at once. <br/>
|
|
Right now a crate takes 15 seconds to unpack per 500kg. Meaning 2 crates of 1000kg will be faster than 1 crate of 2000kg. <br/>
|
|
|
|
All helicopters have a max limit set based on quick google searches and cannot be changed but the ME at this point: <br/>
|
|
UH-1H : 2000kg <br/>
|
|
Mi-8 : 4000kg <br/>
|
|
CH-47 : 10000kg <br/>
|
|
MI-24 : 2000kg <br/>
|
|
</p>
|
|
|
|
<h2>Runway Bombing</h2>
|
|
<p>
|
|
Runway bombing can be a very effective OCA tactic. With Spearhead we've tried adding as much logic and detail to it so it will feel as engaging as possible. <br/>
|
|
|
|
Firstly, the runway is split up in 5 sections and only sections 2, 3 and 4 are then actually tracked. <br/>
|
|
|
|
<span style="font-family: Consolas, Monaco, 'Lucida Console', monospace;">
|
|
+-----------+-----------+-----------+-----------+-----------+ <br/>
|
|
| Section 1 | Section 2 | Section 3 | Section 4 | Section 5 | <br/>
|
|
+-----------+-----------+-----------+-----------+-----------+ <br/>
|
|
</span>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</main>
|
|
<footer>
|
|
<p>© 2025 Spearhead Project</p>
|
|
</footer>
|
|
</body>
|
|
|
|
</html> |