BIS fnc exportMapToBiTXT: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix description, add Object Builder link)
m (Text replacement - "<code>(\[[a-zA-Z0-9_, ]*\] )?\[\[(call|spawn)\]\] \[\[(BI[NS]\_fnc\_[a-zA-Z0-9_]+)\]\];?<\/code>" to "<sqf>$1$2 $3;</sqf>")
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|= Game version
|gr1= Diagnostic
____________________________________________________________________________________________


| Returns terrain height map to BiTXT (Universal Bistudio TXT) format, which can be imported to [[Object Builder]]. Output is also [[copyToClipboard|copied to clipboard]].
|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]].
{{Important|
{{Feature|important|
Be wary that '''this function is CPU-demanding''' and may lock your computer for up to minutes!}} |= Description
Be wary that '''this function is CPU-demanding''' and may lock your computer for minutes!}}
____________________________________________________________________________________________


| [resolution, size, zCoeff] call [[BIS_fnc_exportMapToBiTXT]] |= Syntax
|s1= [resolution, size, zCoeff] call [[BIS_fnc_exportMapToBiTXT]]


|p1= resolution: [[Number]] - (Optional, default 64) object resolution, i.e, number of points per side |= Parameter 1
|p1= resolution: [[Number]] - (Optional, default 64) object resolution, i.e, number of points per side


|p2= size: [[Number]] - (Optional, default 10) object size in metres |= Parameter 2
|p2= size: [[Number]] - (Optional, default 10) object size in metres


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


| [[String]] - height map, same data as in the clipboard |= Return value
|r1= [[String]] - height map, same data as in the clipboard
____________________________________________________________________________________________


|x1= <code>[10, 10, 1] [[call]] [[BIS_fnc_exportMapToBiTXT]];</code> |= Example 1
|x1= <sqf>[10, 10, 1] call BIS_fnc_exportMapToBiTXT;</sqf>


|x2= <code>[[call]] [[BIS_fnc_exportMapToBiTXT]];</code> |= Example 2
|x2= <sqf>call BIS_fnc_exportMapToBiTXT;</sqf>
____________________________________________________________________________________________


| |= 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 13: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"