BIS fnc exportMapToBiTXT: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "<code>(\[[a-zA-Z0-9_, ]*\] )?\[\[(call|spawn)\]\] \[\[(BI[NS]\_fnc\_[a-zA-Z0-9_]+)\]\];?<\/code>" to "<sqf>$1$2 $3;</sqf>")
 
(31 intermediate revisions by 4 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= Returns terrain height map to BiTXT (Universal Bistudio TXT) format, which can be imported to [[Object Builder]]. Output is also [[copyToClipboard|copied to clipboard]].
____________________________________________________________________________________________
{{Feature|important|
Be wary that '''this function is CPU-demanding''' and may lock your computer for minutes!}}


| <pre>/*
|s1= [resolution, size, zCoeff] call [[BIS_fnc_exportMapToBiTXT]]


Description:
|p1= resolution: [[Number]] - (Optional, default 64) object resolution, i.e, number of points per side
Export terrain height map to BiTXT (Universal Bistudio TXT) file, which can be imported to Object Builder.
Output is copied to clipboard.


Parameter(s):
|p2= size: [[Number]] - (Optional, default 10) object size in metres
0 (Optional): NUMBER - object resolution, i.e, number of points per side (default: 64)
1 (Optional): NUMBER - object size in metres (default: 10)
2 (Optional): NUMBER - vertical coefficient. All Z coordinates will be multiplied by this number to highlight hills and mountains (default: 2)


Returns:
|p3= zCoeff: [[Number]] - (Optional, default 2) vertical coefficient. All Z coordinates will be multiplied by this number to highlight hills and mountains
STRING - file output
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|r1= [[String]] - height map, same data as in the clipboard
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_exportMapToBiTXT]]; --> |= Syntax
|x1= <sqf>[10, 10, 1] call BIS_fnc_exportMapToBiTXT;</sqf>


|p1= |= Parameter 1
|x2= <sqf>call BIS_fnc_exportMapToBiTXT;</sqf>
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso=
}}
}}
<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: Map|{{uc:exportMapToBiTXT}}]]
[[Category:Functions|{{uc:exportMapToBiTXT}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:exportMapToBiTXT}}]]

Latest revision as of 14:04, 5 May 2022

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Returns terrain height map to BiTXT (Universal Bistudio TXT) format, which can be imported to Object Builder. Output is also copied to clipboard.
⚠
Be wary that this function is CPU-demanding and may lock your computer for minutes!
Execution:
call
Groups:
Diagnostic

Syntax

Syntax:
[resolution, size, zCoeff] call BIS_fnc_exportMapToBiTXT
Parameters:
resolution: Number - (Optional, default 64) object resolution, i.e, number of points per side
size: Number - (Optional, default 10) object size in metres
zCoeff: Number - (Optional, default 2) vertical coefficient. All Z coordinates will be multiplied by this number to highlight hills and mountains
Return Value:
String - height map, same data as in the clipboard

Examples

Example 1:
[10, 10, 1] call BIS_fnc_exportMapToBiTXT;
Example 2:
call BIS_fnc_exportMapToBiTXT;

Additional Information

See also:
See also needed

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_exportMapToBiTXT&oldid=309369"