BIS fnc sceneGetParticipants: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(29 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>
|game4= arma3
/*******************************************************************************
|version4= 0.50
*
* version: 1.0
* name: sceneGetParticipants
* description: gets members of group who is in range (_MAXDISTANCE)
* parameters: described bellow
* return value: array of units in range
*  
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_sceneGetParticipants]]; --> |= Syntax
|gr1= Scenes


|p1= |= Parameter 1
|descr= gets members of unit's group who are in unit's range.


| |= Return value
|s1= [unit, maxDistance] call [[BIS_fnc_sceneGetParticipants]]
____________________________________________________________________________________________


|x1= <code></code> |=
|p1= unit: [[Object]] - if [[nil]] is passed, [[player]] is used - [[nil]] must then '''not''' be used on a dedicated server
____________________________________________________________________________________________


| |= See also
|p2= maxDistance: [[Number]] - if [[nil]] is passed, 30 is used.


}}
|r1= [[Array]] of units in ''unit'''s group within ''maxDistance'' from ''unit''


<h3 style="display:none">Notes</h3>
|x1= <sqf>[player, 20] call BIS_fnc_sceneGetParticipants;</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso=
</dl>
}}
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Scenes|{{uc:sceneGetParticipants}}]]
[[Category:Functions|{{uc:sceneGetParticipants}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:sceneGetParticipants}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:sceneGetParticipants}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:sceneGetParticipants}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sceneGetParticipants}}]]

Latest revision as of 17:00, 13 July 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
gets members of unit's group who are in unit's range.
Execution:
call
Groups:
Scenes

Syntax

Syntax:
[unit, maxDistance] call BIS_fnc_sceneGetParticipants
Parameters:
unit: Object - if nil is passed, player is used - nil must then not be used on a dedicated server
maxDistance: Number - if nil is passed, 30 is used.
Return Value:
Array of units in unit's group within maxDistance from unit

Examples

Example 1:
[player, 20] call BIS_fnc_sceneGetParticipants;

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_sceneGetParticipants&oldid=328385"