wip

2024-09-24 11:25:13 +02:00
parent 9ddbb87138
commit b2af51e125
2 changed files with 22 additions and 81 deletions
@@ -1,84 +1,3 @@
--[[
-# 3. Missions
-
-A mission is a completable objective with a state and a continuous check to see if itself is completed. <br/>
-The delay between checks is quite big, but it also is checked on unit deaths and other events.
-
-### Placement
-The placement of MISSION trigger zones can be anywhere. <br/>
-The order of unit detection is `CAP` > `MISSION` > `AIRBASE` > `STAGE` <br/>
-This means that if a unit has a name that starts with `"CAP_"` it will not be included in a mission. <br/>
-But all other units in a `MISSION` trigger zone will be managed as part of that mission.
-
-Units inside a `MISSION` do not have to stay within the triggerzone. <br/>
-They just need to be inside the zone at the start of the mission. <br/>
-You can for example let a `BAI` mission drive back and forth between airbases. The `MISSIONZONE` only needs to be around the units that are part of the objective, not the waypoints.
-
-### Naming
-`MISSION_<type>_<name>` <br/>
-`RANDOMMISSION_<type>_<name>_<index>` (Read RANDOMISATION below)
-
-With: <br/>
-`name` = A name that is easy to remember and type. Like a codename. Exmaples: BYRON, PLUKE, etc. <br/>
-`type` = any of the below described types. Special types are marked with an *
-
-TIP: You can click on the type to get more details
-
-<details> 
-<summary>SAM*</summary>
-&emsp; SAM Sites are managed a little different. SAM Sites can be used to guide players and to protect airfields. <br/>
-&emsp; In the future when deepstrike missions might come into scope these SAM sites will also be more important. <br/>
-&emsp; SAM sites will be activated when a zone is "Pre-Active". <br/>
-&emsp; A stage is "Pre-Active" when there is a CAP base active, or there is other things to do that would need the SAM site to be live (OCA, DEEPSTRIKE, EXTRACTION \<= all feature development)<br/>
-&emsp; If you want a SAM site to become active ONLY when the stage is fully active, then `DEAD` is the type for you!
-
-&emsp; <u>Completion logic</u> <br/>
-&emsp; TODO: documentation: Completion logic 
-
-</details>
-
-<details> 
-<summary>DEAD</summary>
-
-&emsp; DEAD missions will be spawned on activation of the stage. <br/>
-&emsp; ALL DEAD missions will be activated right at the start of a stage. <br/>
-&emsp; This might be against the "randomisation" feel, but it is to make sure mission don't get activated randomly and players get ambushed by a random spawn. <br/>
-
-&emsp; <u>Completion logic</u> <br/>
-&emsp; TODO: documentation: Completion logic 
-
-
-</details>
-
-<details> 
-<summary>BAI</summary>
-</details>
-
-<details> 
-<summary>STRIKE</summary>
-&emsp; STRIKE missions will be activated randomly until all of them are completed. <br/>
-&emsp; A strike mission can be placed anywhere, even on airbases
-
-&emsp; <u>Completion logic</u> <br/>
-&emsp; TODO: documentation: Completion logic 
-
-</details>
-
-### Randomisation
-
-You can randomise missions. <br/>
-Spearhead will pick up all mission zones that start with `"RANDOMMISSION_"` <br/>
-Then it will combine each `RANDOMMISSION` in a zone with the same `<name>` and pick a random one. <br/>
-It will always pick 1 and only 1.
-
-This means you have some options for randomisation. <br/>
-For example, if you have 1 missionzone with name `RANDOMMISSION_SAM_PLUKE_1` that is filled with an SA-2 and another zone with `RANDOMMISSION_SAM_PLUKE_2` filled with an SA-3 then some runs of the mission it will spawn an SA-3 and sometimes spawn an SA-3. (works for any mission type)
-
-What you can also do is add empty `RANDOMMISSION_` zones next to the filled `RANDOMMISSION_` zone. 
-For example. You have a `RANDOMMISSION_DEAD_BYRON_1` filled with an SA-19 driving around and 2 more `RANDOMMISSION_DEAD_BYRON_<2 & 3>` zones then it will have a 33% chance of being spawned.
-If a zone is empty it will not be briefed, activated or count towards completion of the `STAGE`
-
-]]

 --- A mission Object.
 local Mission = {}