BIS fnc sceneGetParticipants: Difference between revisions

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


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| gets members of unit's group who are in unit's range. |DESCRIPTION=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| [unit, maxDistance] call [[BIS_fnc_sceneGetParticipants]] |SYNTAX=
|game4= arma3
|version4= 0.50


|p1= unit: [[Object]] - if [[nil]] is passed, [[player]] is used. ''Warning: must then not be used on a dedicated server'' |PARAMETER1=
|gr1= Scenes


|p2= maxDistance: [[Number]] - if [[nil]] is passed, 30 is used. |PARAMETER2=
|descr= gets members of unit's group who are in unit's range.


| [[Array]] of units in ''unit'''s group within ''maxDistance'' from ''unit'' |RETURNVALUE=
|s1= [unit, maxDistance] call [[BIS_fnc_sceneGetParticipants]]
____________________________________________________________________________________________


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


| |SEEALSO=
|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"