Develop (#16)

* Initial Methods for SpearheadAPI * Added Spearhead API * Added Spearhead API * fixed compile for api * Added notes for API in beta * Added notes for API in beta * Added Menu to all doc pages * Added Menu to all doc pages * added it for real * added it for real * fixed develop * fixed develop * fixed develop * wip * wip * updated * work in progress * work in progress * added empty docs page * wip * removed SAR files from persistence branch * Added Blue Sams as seperate class * added initial persistance * added initial persistance * added initial persistance * added initial persistance * added initial persistance * added menu to persistence markdown * added menu to persistence markdown * added menu to persistence markdown * docs update * wip * wip * Refactor of Stage classes. * wip * wip * wip * reworked bluesam and stagebase * Added waiting stage functionality * updated docs * wip * wip * wip * updated * wip * wip * wip * refactored without issues, needs testing --------- Co-authored-by: Dutchie <54616262+dutchie032@users.noreply.github.com> Co-authored-by: dutchie032 <dutchie032> Co-authored-by: ex61wi <tim.rorije@ing.com>
2025-04-22 14:39:22 +02:00
parent 9c6a5ed217
commit ff392e0e7e
37 changed files with 4494 additions and 1732 deletions
@@ -19,51 +19,6 @@ If you however want to go right to the Get Started guide click here: [here](./Ge
 You can always come back later here. <br/>
 The Get Started guide will not show all details and reasoning. <br/>

-## Release Notes
-
-<details>
-<summary>01-10-2024 Initial Version </summary> 
-The initial version with basic functionality
-</details>
-
-## Feature / TODO list
-
- [ ] CAP Manager
-    - [x] RTB flow. Flying out before primary flies back. 
-    - [ ] Out of Missile flow 
- [ ] Stage
-    - [ ] Pre Activate
-      - [x] All SAM Sites
-      - [x] All Red airbase units
-      - [ ] OCA Missions
-    - [ ] Activate
-      - [ ] Activate all DEAD sites. (No surprise pop ups)
-      - [ ] Activate other random mission till 10 max
-    - [ ] Completion Logic
-      - [ ] ?? Custom Conditions ??
-      - [ ] ?? Airbases as final mission ??
-      - [ ] Required Mission types
- [ ] Missions
-  - [x] BAI
-  - [x] DEAD
-  - [x] STRIKE
-  - [ ] INTERCEPT
-  - [ ] LOGISTIC
-  - [ ] EXTRACTION | MEDEVAC
-  - [ ] More?
-
- [ ] Warehouses
-  - [ ] Logistics [OPTIONAL]
-  - [ ] 
-
- [ ] Team creation
- [ ] Airbases
- [ ] Farps 
- [ ] Carrier/Fleet routes
-    - [ ] Fleet tracks
- [ ] Persistance
-
-
 ## Configuration

 Spearhead will always try to be as configurable as possible. <br/>
@@ -77,6 +32,14 @@ Overwrite the values in your own script (before spearhead runs) or <a download="
  ##!config!##
 ```

+## The Spearhead API
+
+> **_NOTE:_** The Spearhead.API space is only release in the Beta branch at the moment.
+
+You can not only use Spearhead, but you can also interact with it via your own scripts.  
+
+See all the reference, explanation here: [SpearheadAPI](./SpearheadApi.html)
+
 ## All Trigger zone name options: 

 <details> 
@@ -84,6 +47,21 @@ Overwrite the values in your own script (before spearhead runs) or <a download="
  A mission stage that encapsulates multiple missions, airbases and other objects.
 </details> 

+<details> 
+  <summary>WAITINGSTAGE_</summary>
+  A stage that functions as a logic delay or timer. <br/>
+  With this you can add a wait before or in between stages. 
+
+  Naming Convention: `WAITINGSTAGE_<order>_<amount of seconds>`
+  Example: `WAITINGSTAGE_2_180`
+
+  A waiting stage can be part of the same stage order as other stages. <br/>
+  This will first activate the DELAYSTAGE and only when the DELAYSTAGE is completed will the other stages be activated. <br/>
+  This is so you can easily add delays later in your mission development, without havint to rename all subsequent stages. 
+
+</details> 
+
+
 <details> 
  <summary>MISSION_</summary>
 </details> 
@@ -106,8 +84,6 @@ Overwrite the values in your own script (before spearhead runs) or <a download="
 A stage is a logical part of a mission. It's isn't anything special per se, but everything revolves around stages in Spearhead. <br/>
 Everything is tied to at a stage. <br/>

-
-
 ## Mission

 A mission is a completable objective with a state and a continuous check to see if itself is completed. <br/>