BIS fnc sceneGetParticipants: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling - missing see also)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>
| gets members of unit's group who are in unit's range. |= Description
/*******************************************************************************
*
* 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
| [unit, maxDistance] call [[BIS_fnc_sceneGetParticipants]] |= Syntax


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


| |= Return value
|p2= maxDistance: [[Number]] - if [[nil]] is passed, 30 is used. |= Parameter 2
 
| [[Array]] of units in ''unit'''s group within ''maxDistance'' from ''unit'' |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code><nowiki>[</nowiki>[[player]], 20] [[call]] [[BIS_fnc_sceneGetParticipants]];</code> |= Example 1
____________________________________________________________________________________________
____________________________________________________________________________________________


Revision as of 14:45, 22 April 2018


Logo A2.png1.00
Hover & click on the images for description

Description

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

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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_sceneGetParticipants&oldid=106666"