Difference between revisions of "BIS fnc KMLimport"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 1: Line 1:
 
+
{{Function|Comments=
{{Function|= Comments
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| tkoh |= Game name
+
| tkoh |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| <pre>/*
+
| Read positions from a [https://en.wikipedia.org/wiki/Keyhole_Markup_Language KML file].
 
+
{{Informative|Recommended to execute in loading screen.}}|Description=
Description:
 
Read positions from KLM file.
 
Recommended to execute in loading screen.
 
 
 
Parameter(s):
 
_this: STRING - path to .kml file
 
 
 
Returns:
 
ARRAY of ARRAYs in format [positionXYZ, folder, name, description]
 
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| <!-- [] call [[BIS_fnc_KMLimport]]; --> |= Syntax
+
| filePath call [[BIS_fnc_KMLimport]] |Syntax=
  
|p1= |= Parameter 1
+
|p1= filePath: [[String]] - (Optional, default {{Inline code|"hsim\Doc_H\GoogleEarth\Missions\" + [[missionName]] + ".kml"}}) KML file path
 +
{{Feature arma3|Default value only works in {{tkoh}}. Do not rely on it in {{arma3}}}}|Parameter 1=
  
| |= Return value
+
| [[Array]] of [[Array|Arrays]] in format [type, positionXYZ, folder, name, description]
 +
* type: [[Number]] - 0 for a point, 1 for a line, 2 for a polygon
 +
* positionXYZ: [[Position]] - format [[PositionAGL]]
 +
* folder: [[String]] - path to the value, "" if in the .kml root
 +
* name: [[String]] - location's name
 +
* description: [[String]] - location's description|Return value=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|x1= <code></code> |=  
+
|x1= <code>_data = "subDir\myFile.kml" [[call]] [[BIS_fnc_KMLimport]];</code> |Example 1=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| |= See also
+
| [[BIS_fnc_keypointsExportFromKML]], [[BIS_fnc_dbImportXML]], [[BIS_fnc_posDegToWorld]] |See also=
 
 
 
}}
 
}}
  
Line 45: Line 38:
  
 
<h3 style="display:none">Bottom Section</h3>
 
<h3 style="display:none">Bottom Section</h3>
 +
[[Category:Functions|{{uc:KMLimport}}]]
 
[[Category:Function Group: Map|{{uc:KMLimport}}]]
 
[[Category:Function Group: Map|{{uc:KMLimport}}]]
[[Category:Functions|{{uc:KMLimport}}]]
 
 
[[Category:{{Name|tkoh}}: Functions|{{uc:KMLimport}}]]
 
[[Category:{{Name|tkoh}}: Functions|{{uc:KMLimport}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:KMLimport}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:KMLimport}}]]

Revision as of 17:24, 2 July 2018

Hover & click on the images for description

Description

Description:
Read positions from a KML file. Template:Informative
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
filePath call BIS_fnc_KMLimport
Parameters:
filePath: String - (Optional, default Template:Inline code) KML file path Template:Feature arma3
Return Value:
Array of Arrays in format [type, positionXYZ, folder, name, description]
  • type: Number - 0 for a point, 1 for a line, 2 for a polygon
  • positionXYZ: Position - format PositionAGL
  • folder: String - path to the value, "" if in the .kml root
  • name: String - location's name
  • description: String - location's description

Examples

Example 1:
_data = "subDir\myFile.kml" call BIS_fnc_KMLimport;

Additional Information

See also:
BIS_fnc_keypointsExportFromKMLBIS_fnc_dbImportXMLBIS_fnc_posDegToWorld

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

Notes

Bottom Section