Difference between revisions of "BIS fnc KMLimport"

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling)
m (Some wiki formatting)
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
+
{{RV|type=function
____________________________________________________________________________________________
 
  
| tkoh |Game name=
+
|game1= tkoh
 +
|version1= 1.00
  
|1.00|Game version=
+
|game2= arma3
____________________________________________________________________________________________
+
|version2= 0.50
  
| Read positions from a [https://en.wikipedia.org/wiki/Keyhole_Markup_Language KML file].
+
|gr1= Map and Markers
{{Informative|Recommended to execute in loading screen.}}|Description=
 
____________________________________________________________________________________________
 
  
| filePath call [[BIS_fnc_KMLimport]] |Syntax=
+
|descr= Read positions from a {{Wikipedia|Keyhole_Markup_Language|KML file}}.
 +
{{Feature|Informative|Recommended to execute in loading screen.}}
  
|p1= filePath: [[String]] - (Optional, default {{Inline code|"hsim\Doc_H\GoogleEarth\Missions\" + [[missionName]] + ".kml"}}) KML file path
+
|s1= filePath call [[BIS_fnc_KMLimport]]
{{Feature arma3|Default value only works in {{tkoh}}. Do not rely on it in {{arma3}}}}|Parameter 1=
 
  
| [[Array]] of [[Array|Arrays]] in format [type, positionXYZ, folder, name, description]
+
|p1= filePath: [[String]] - (Optional, default {{ic|"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}}}}
 +
 
 +
|r1= [[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
 
* type: [[Number]] - 0 for a point, 1 for a line, 2 for a polygon
 
* positionXYZ: [[Position]] - format [[PositionAGL]]
 
* positionXYZ: [[Position]] - format [[PositionAGL]]
 
* folder: [[String]] - path to the value, "" if in the .kml root
 
* folder: [[String]] - path to the value, "" if in the .kml root
 
* name: [[String]] - location's name
 
* name: [[String]] - location's name
* description: [[String]] - location's description|Return value=
+
* description: [[String]] - location's description
____________________________________________________________________________________________
 
  
|x1= <code>_data = "subDir\myFile.kml" [[call]] [[BIS_fnc_KMLimport]];</code> |Example 1=
+
|x1= <code>_data = "subDir\myFile.kml" [[call]] [[BIS_fnc_KMLimport]];</code>
____________________________________________________________________________________________
 
  
| [[BIS_fnc_keypointsExportFromKML]], [[BIS_fnc_dbImportXML]], [[BIS_fnc_posDegToWorld]] |See also=
+
|seealso= [[BIS_fnc_keypointsExportFromKML]], [[BIS_fnc_dbImportXML]], [[BIS_fnc_posDegToWorld]]
 
}}
 
}}
 
<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:Functions|{{uc:KMLimport}}]]
 
[[Category:Function Group: Map|{{uc:KMLimport}}]]
 
[[Category:{{Name|tkoh}}: Functions|{{uc:KMLimport}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:KMLimport}}]]
 

Latest revision as of 04:03, 13 June 2021

Hover & click on the images for description

Description

Description:
Read positions from a KML file.
Recommended to execute in loading screen.
Execution:
call
Groups:
Map and Markers

Syntax

Syntax:
filePath call BIS_fnc_KMLimport
Parameters:
filePath: String - (Optional, default "hsim\Doc_H\GoogleEarth\Missions\" + missionName + ".kml") KML file path
Arma 3
Default value only works in Take On Helicopters. Do not rely on it in Arma 3
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