BIS fnc buildingPositions: 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>")
 
(34 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Positions


|1.00|= Game version
|descr= Get all available positions within a building or structure.
____________________________________________________________________________________________


| <pre>/*
|s1= param call [[BIS_fnc_buildingPositions]]
Description:
This function return all available positions of a building defined in model, if any
Parameter(s):
_this select 0: OBJECT - The building object
_this select 1: NUMBER - The maximum number of positions to return
Returns:
ARRAY - List of all available positions within building
*/


//Parameters
|p1= param: [[Object]]
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_buildingPositions]]; --> |= Syntax
|p2= param: [[Number]]


|p1= |= Parameter 1
|r1= [[Array]]


| |= Return value
|x1= <sqf>[_building] call BIS_fnc_buildingPositions;</sqf>
____________________________________________________________________________________________


|x1= <code></code> |=
|x2= <sqf>[_building, _maxNumberOfPositions] call BIS_fnc_buildingPositions;</sqf>
____________________________________________________________________________________________
 
| |= See also


|seealso= [[buildingPos]] [[buildingExit]]
}}
}}
<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: Misc|{{uc:buildingPositions}}]]
[[Category:Functions|{{uc:buildingPositions}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:buildingPositions}}]]

Latest revision as of 13:04, 5 May 2022

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

Description

Description:
Get all available positions within a building or structure.
Execution:
call
Groups:
Positions

Syntax

Syntax:
param call BIS_fnc_buildingPositions
Parameters:
param: Object
param: Number
Return Value:
Array

Examples

Example 1:
[_building] call BIS_fnc_buildingPositions;
Example 2:
[_building, _maxNumberOfPositions] call BIS_fnc_buildingPositions;

Additional Information

See also:
buildingPos buildingExit

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_buildingPositions&oldid=309416"