BIS fnc diagMissionPositions: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Diagnostic


|1.00|= Game version
|descr= Displays positions of units from all missions
____________________________________________________________________________________________


| <pre>/*
|s1= [configPath, allUnits, isCampaign] call [[BIS_fnc_diagMissionPositions]]


Description:
|p1= configPath: [[Config]] - (Optional, default <sqf inline>configFile >> "CfgMissions"</sqf>)
Displays positions of units from all missions


Parameter(s):
|p2= allUnits: [[Boolean]] - (Optional, default [[false]]) [[true]] to display all units, [[false]] to display only player positions
0: CONFIG - config path which will be scanned (default: configfile >> "CfgMissions")
1: (Optional): BOOL - when true, displays all units, otherwise just player positions (default: false)
2: (Optional): BOOL - when true, scan will perceive the main folder as campaign (required when param 0 is direct path to campaign)


Returns:
|p3= isCampaign: [[Boolean]] - (Optional, default [[false]]) [[true]] for the scan to perceive the main folder as campaign (required when ''configPath'' is direct path to campaign)
BOOL
*/


#define ICON_SIZE 26
|r1= [[Boolean]] - [[true]] when done
#define DELETE_CONFIG diag_mergeconfigfile ["O:\arma3\A3\Functions_F\Diagnostic\fn_diagMissionPositions_delete.cfg"];


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|x1= <sqf>[configFile >> "CfgMissions", true, false] call BIS_fnc_diagMissionPositions;</sqf>
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_diagMissionPositions]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[:Category:Function Group: Diagnostic|Diagnostic Function Group]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Diagnostic|{{uc:diagMissionPositions}}]]
[[Category:Functions|{{uc:diagMissionPositions}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:diagMissionPositions}}]]

Latest revision as of 12:55, 13 July 2022

Hover & click on the images for description

Description

Description:
Displays positions of units from all missions
Execution:
call
Groups:
Diagnostic

Syntax

Syntax:
[configPath, allUnits, isCampaign] call BIS_fnc_diagMissionPositions
Parameters:
configPath: Config - (Optional, default configFile >> "CfgMissions")
allUnits: Boolean - (Optional, default false) true to display all units, false to display only player positions
isCampaign: Boolean - (Optional, default false) true for the scan to perceive the main folder as campaign (required when configPath is direct path to campaign)
Return Value:
Boolean - true when done

Examples

Example 1:
[configFile >> "CfgMissions", true, false] call BIS_fnc_diagMissionPositions;

Additional Information

See also:
Diagnostic Function Group

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note