BIS fnc sceneGetParticipants: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma2 | | arma2 | ||
|1.00 | |1.00 | ||
|gr1 = Scenes | |gr1 = Scenes | ||
| gets members of unit's group who are in unit's range. | | gets members of unit's group who are in unit's range. | ||
| [unit, maxDistance] call [[BIS_fnc_sceneGetParticipants]] | | [unit, maxDistance] call [[BIS_fnc_sceneGetParticipants]] | ||
|p1= unit: [[Object]] - if [[nil]] is passed, [[player]] is used. ''Warning: must then not be used on a dedicated server'' | |p1= unit: [[Object]] - if [[nil]] is passed, [[player]] is used. ''Warning: must then not be used on a dedicated server'' | ||
|p2= maxDistance: [[Number]] - if [[nil]] is passed, 30 is used. | |p2= maxDistance: [[Number]] - if [[nil]] is passed, 30 is used. | ||
| [[Array]] of units in ''unit'''s group within ''maxDistance'' from ''unit'' | | [[Array]] of units in ''unit'''s group within ''maxDistance'' from ''unit'' | ||
|x1= <code><nowiki>[</nowiki>[[player]], 20] [[call]] [[BIS_fnc_sceneGetParticipants]];</code> | |x1= <code><nowiki>[</nowiki>[[player]], 20] [[call]] [[BIS_fnc_sceneGetParticipants]];</code> | ||
| | | | ||
}} | }} | ||
Revision as of 23:44, 17 January 2021
Description
Syntax
- Syntax:
- [unit, maxDistance] call BIS_fnc_sceneGetParticipants
- Parameters:
- unit: Object - if nil is passed, player is used. Warning: 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