Spearhead 1944 Frontline Function: Difference between revisions
Jump to navigation
Jump to search
m (added example screenshots, thanks to Galse for bringing that to my attention) |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
== 1. Create Layer == | == 1. Create Layer == | ||
Create a layer in Eden Editor called | Create a layer in Eden Editor called {{hl|Frontline Control Points}}. This layer is referenced by the function to generate the frontline data points. | ||
== 2 | == 2. Start Preview == | ||
Execute the following code in the [[Arma 3: Debug Console]] from within [[Eden Editor]] to create a real-time preview of the frontline. Close the window that shows up for now. We will need it later. | Execute the following code in the [[Arma 3: Debug Console]] from within [[Eden Editor]] to create a real-time preview of the frontline. Close the window that shows up for now. We will need it later. | ||
| Line 22: | Line 16: | ||
[[File:SPE Frontline CodeExecution.png|400px]] | [[File:SPE Frontline CodeExecution.png|400px]] | ||
== 3. Create Markers == | |||
Inside the layer {{hl|Frontline Control Points}}, create as many markers as needed to shape the frontline (The wavy black line). These markers act as control points for bezier interpolation and their position will influence the curvature. | |||
The markers will automatically be hidden at mission start. | |||
{{Feature|warning|The more markers you place, the more accurate your frontline will be, but the calculation will be more expensive and generating the data will take longer.}} | |||
== 4. Shape Frontline == | == 4. Shape Frontline == | ||
| Line 47: | Line 47: | ||
[ | [ | ||
call compile preprocessFileLineNumbers "frontline_data.sqf", | call compile preprocessFileLineNumbers "frontline_data.sqf", | ||
false, // Don't draw axis area (outside area) | |||
nil, // Preview mode is not needed so we ignore it | |||
"ColorRed", // Fill area color | |||
"ColorBlue", // Outside area color (if enabled) | |||
0.5, // Alpha of inside fill markers | |||
0.3 // Alpha of ourside fill markers | |||
] call SPE_MISSIONUTILITYFUNCTIONS_fnc_generateFrontline; | ] call SPE_MISSIONUTILITYFUNCTIONS_fnc_generateFrontline; | ||
</sqf> | </sqf> | ||
| Line 58: | Line 64: | ||
== Syntax == | == Syntax == | ||
<sqf>[ | <sqf>[data, drawOutsideArea, frontlineQuality, insideMarkerColor, outsideMarkerColor, insideMarkerAlpha, outsideMarkerAlpha, interpolationQuality] call SPE_MISSIONUTILITYFUNCTIONS_fnc_generateFrontline;</sqf> | ||
== Parameters == | == Parameters == | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! Index !! Data type !! Description !! Default value | ! Parameter Name !! Index !! Data type !! Description !! Default value | ||
|- | |- | ||
| 0 || [[Array]] || Data for placing the fill markers inside frontline. If this data is provided the function assumes that the frontline should be created during mission runtime. Leave this empty for previewing in the Editor || [] | | data || 0 || [[Array]] || Data for placing the fill markers inside frontline. If this data is provided the function assumes that the frontline should be created during mission runtime. Leave this empty for previewing in the Editor || [] | ||
|- | |- | ||
| 1 || [[Boolean]] || True to draw axis area, false to not || false | | drawOutsideArea || 1 || [[Boolean]] || True to draw axis area, false to not || false | ||
|- | |- | ||
| 2 || [[String]] || Quality setting of the exported data | | frontlineQuality || 2 || [[String]] || Quality setting of the exported data | ||
* "preview" - Used for preview, resolution is 500 m | * "preview" - Used for preview, resolution is 500 m | ||
* "very low" - Resolution 32 m | * "very low" - Resolution 32 m | ||
| Line 79: | Line 85: | ||
|| "preview" | || "preview" | ||
|- | |- | ||
| 3 || [[String]] || CfgMarker color of the inside fill || "SPE_ColorAllies" | | insideMarkerColor || 3 || [[String]] || CfgMarker color of the inside fill || "SPE_ColorAllies" | ||
|- | |- | ||
| 4 || [[String]] || CfgMarker color of the outside fill || "SPE_ColorAxis" | | outsideMarkerColor || 4 || [[String]] || CfgMarker color of the outside fill || "SPE_ColorAxis" | ||
|- | |- | ||
| 5 || [[Number]] || Alpha of inside marker || 0.6 | | insideMarkerAlpha || 5 || [[Number]] || Alpha of inside marker || 0.6 | ||
|- | |- | ||
| 6 || [[Number]] || Alpha of outside marker || 0.6 | | outsideMarkerAlpha || 6 || [[Number]] || Alpha of outside marker || 0.6 | ||
|- | |- | ||
| 7 || [[Number]] || Interpolation quality of the border. Lower value means it's smoother, but generates more data || 0.002 | | interpolationQuality || 7 || [[Number]] || Interpolation quality of the border. Lower value means it's smoother, but generates more data || 0.002 | ||
|} | |} | ||
= Example Scenario = | = Example Scenario = | ||
* | * {{Link/External|link=https://drive.google.com/drive/folders/1A0gSMkaNi7Xx7FadH8D9TKrIbFC3UTaz|text=Download}} | ||
= Limitatons = | = Limitatons = | ||
| Line 97: | Line 103: | ||
* Only one frontline can be drawn | * Only one frontline can be drawn | ||
= Example Frontlines = | = Example Frontlines = | ||
Latest revision as of 11:51, 6 September 2024
Tutorial
This page explains how to draw a frontline on the map similar to how it is done in the Operation Cobra campaign of the Spearhead 1944 CDLC.
1. Create Layer
Create a layer in Eden Editor called Frontline Control Points. This layer is referenced by the function to generate the frontline data points.
2. Start Preview
Execute the following code in the Arma 3: Debug Console from within Eden Editor to create a real-time preview of the frontline. Close the window that shows up for now. We will need it later.
3. Create Markers
Inside the layer Frontline Control Points, create as many markers as needed to shape the frontline (The wavy black line). These markers act as control points for bezier interpolation and their position will influence the curvature. The markers will automatically be hidden at mission start.
4. Shape Frontline
Now drag the previously placed markers to shape the frontline. You can also add new markers by copy and pasting an existing one.
5. Generate Data
Once you are happy with the shape of the frontline, execute the following code again in the Arma 3: Debug Console from within Eden Editor. Instead of "preview" quality, use "high", "very high" or "ultra" instead.
6. Create Data File
Once the data was generated a window will show. Copy the content of the window and paste it into a script file. Place this script file into your mission folder. In our case we call it frontline_data.sqf and place it into the root of our test scenario.
7. Add Code
Add code that creates frontline for every client to the init.sqf. The script has local effect and thus needs to be run on every connecting client. Clients without interface are automatically excluded (headless clients, dedicated server).
init.sqf
[
call compile preprocessFileLineNumbers "frontline_data.sqf",
false, // Don't draw axis area (outside area)
nil, // Preview mode is not needed so we ignore it
"ColorRed", // Fill area color
"ColorBlue", // Outside area color (if enabled)
0.5, // Alpha of inside fill markers
0.3 // Alpha of ourside fill markers
] call SPE_MISSIONUTILITYFUNCTIONS_fnc_generateFrontline;
Function Syntax
Description
Previews a frontline in Eden Editor, or depending on parameter, generates data for it so it can be created during runtime.
Syntax
[data, drawOutsideArea, frontlineQuality, insideMarkerColor, outsideMarkerColor, insideMarkerAlpha, outsideMarkerAlpha, interpolationQuality] call SPE_MISSIONUTILITYFUNCTIONS_fnc_generateFrontline;
Parameters
| Parameter Name | Index | Data type | Description | Default value |
|---|---|---|---|---|
| data | 0 | Array | Data for placing the fill markers inside frontline. If this data is provided the function assumes that the frontline should be created during mission runtime. Leave this empty for previewing in the Editor | [] |
| drawOutsideArea | 1 | Boolean | True to draw axis area, false to not | false |
| frontlineQuality | 2 | String | Quality setting of the exported data
|
"preview" |
| insideMarkerColor | 3 | String | CfgMarker color of the inside fill | "SPE_ColorAllies" |
| outsideMarkerColor | 4 | String | CfgMarker color of the outside fill | "SPE_ColorAxis" |
| insideMarkerAlpha | 5 | Number | Alpha of inside marker | 0.6 |
| outsideMarkerAlpha | 6 | Number | Alpha of outside marker | 0.6 |
| interpolationQuality | 7 | Number | Interpolation quality of the border. Lower value means it's smoother, but generates more data | 0.002 |
Example Scenario
Limitatons
As of Spearhead 1944 v1 there are some limitations:
- Only one frontline can be drawn
