BIS fnc KMLimport: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " " to " ")
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| tkoh
|game1= tkoh
|version1= 1.00


|1.00
|game2= arma3
|version2= 0.50


|gr1 = Map and Markers
|gr1= Map and Markers


| Read positions from a [https://en.wikipedia.org/wiki/Keyhole_Markup_Language KML file].
|descr= Read positions from a {{Link|https://en.wikipedia.org/wiki/Keyhole_Markup_Language|KML file}}.
{{Informative|Recommended to execute in loading screen.}}
{{Feature|informative|Recommended to execute in loading screen.}}


| filePath call [[BIS_fnc_KMLimport]]
|s1= filePath call [[BIS_fnc_KMLimport]]


|p1= filePath: [[String]] - (Optional, default {{Inline code|"hsim\Doc_H\GoogleEarth\Missions\" + [[missionName]] + ".kml"}}) KML file path
|p1= filePath: [[String]] - (Optional, default <sqf inline>"hsim\Doc_H\GoogleEarth\Missions\" + missionName + ".kml"</sqf>) KML file path
{{Feature|arma3|Default value only works in {{tkoh}}. Do not rely on it in {{arma3}}}}
{{Feature|arma3|Default value only works in {{tkoh}}. Do not rely on it in {{arma3}}.}}


| [[Array]] of [[Array|Arrays]] in format [type, positionXYZ, folder, name, description]
|r1= [[Array]] of [[Array]]s 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 [[Position#PositionAGL|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
* description: [[String]] - location's description


|x1= <code>_data = "subDir\myFile.kml" [[call]] [[BIS_fnc_KMLimport]];</code>
|x1= <sqf>private _data = "subDir\myFile.kml" call BIS_fnc_KMLimport;</sqf>


| [[BIS_fnc_keypointsExportFromKML]], [[BIS_fnc_dbImportXML]], [[BIS_fnc_posDegToWorld]]
|seealso= [[BIS_fnc_keypointsExportFromKML]] [[BIS_fnc_dbImportXML]] [[BIS_fnc_posDegToWorld]]
}}
}}
[[Category:Functions|{{uc:KMLimport}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:KMLimport}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:KMLimport}}]]

Latest revision as of 00:25, 2 February 2024

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:
private _data = "subDir\myFile.kml" call BIS_fnc_KMLimport;

Additional Information

See also:
BIS_fnc_keypointsExportFromKML BIS_fnc_dbImportXML BIS_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