BIS fnc mapSize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "<code>(\[?[^\[]+\]?) *(\[\[)?(call|spawn)(\]\])? *(\[\[)?(BI(N|S)_fnc_[a-zA-Z0-9_]+)(\]\])?;?<\/code>" to "<sqf>$1 $3 $6;</sqf>")
 
(27 intermediate revisions by 2 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= Map and Markers
____________________________________________________________________________________________


| Returns map size. |DESCRIPTION=
|descr= Returns map size from config. Do not confuse with [[worldSize]]. The engine command calculates the map size and doesn't read it from config.
____________________________________________________________________________________________


| terrainName call [[BIS_fnc_mapSize]] |SYNTAX=
|s1= terrainName call [[BIS_fnc_mapSize]]


|p1= terrainName: [[String]] - (Optional, default [[worldName]]) world name |PARAMETER1=
|p1= terrainName: [[String]] - (Optional, default [[worldName]]) world name


| [[Number]] |RETURNVALUE=
|r1= [[Number]]
____________________________________________________________________________________________


|x1= <code>"Altis" [[call]] [[BIS_fnc_mapSize]];</code> |EXAMPLE1=
|x1= <sqf>"Altis" call BIS_fnc_mapSize;</sqf>


|x2= <code>[[worldName]] [[call]] [[BIS_fnc_mapSize]]; {{codecomment|// equivalent to [[worldSize]]}}</code> |EXAMPLE2=
|x2= <sqf>worldName call BIS_fnc_mapSize;</sqf>


|x3= <code>[[call]] [[BIS_fnc_mapSize]]; {{codecomment|// equivalent to [[worldSize]]}}</code> |EXAMPLE3=
|x3= <sqf>call BIS_fnc_mapSize;</sqf>
____________________________________________________________________________________________


| [[BIS_fnc_mapGridSize]], [[worldSize]], [[worldName]] |SEEALSO=
|seealso= [[BIS_fnc_mapGridSize]] [[worldSize]] [[worldName]]
}}
}}
<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:mapSize}}]]
[[Category:Functions|{{uc:mapSize}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:mapSize}}]]

Latest revision as of 14:24, 1 July 2022

Hover & click on the images for description

Description

Description:
Returns map size from config. Do not confuse with worldSize. The engine command calculates the map size and doesn't read it from config.
Execution:
call
Groups:
Map and Markers

Syntax

Syntax:
terrainName call BIS_fnc_mapSize
Parameters:
terrainName: String - (Optional, default worldName) world name
Return Value:
Number

Examples

Example 1:
"Altis" call BIS_fnc_mapSize;
Example 2:
worldName call BIS_fnc_mapSize;
Example 3:
call BIS_fnc_mapSize;

Additional Information

See also:
BIS_fnc_mapGridSize worldSize worldName

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