BIS fnc getFactions: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling)
m (template:command argument fix)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Gets list and sides of current factions. |= Description
| Gets list and sides of current factions. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [parameter] call [[BIS_fnc_getFactions]] |= Syntax
| [parameter] call [[BIS_fnc_getFactions]] |SYNTAX=


|p1= parameter:
|p1= parameter:
Line 21: Line 21:
* [[Array]] of [[String|Strings]]
* [[Array]] of [[String|Strings]]
* [[Array]] of [[Side|Sides]]
* [[Array]] of [[Side|Sides]]
* [[Number]] - an index |= Return value
* [[Number]] - an index |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 37: Line 37:
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[faction]], [[side]] |= See also
| [[faction]], [[side]] |SEEALSO=
}}
}}



Revision as of 12:28, 7 April 2019

Hover & click on the images for description

Description

Description:
Gets list and sides of current factions.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[parameter] call BIS_fnc_getFactions
Parameters:
parameter:
  • Nothing or empty Array - returns all factions
  • Object - returns index of the object side
  • Array - side of the first element is returned, others are ignored
 
Return Value:

Examples

Example 1:
call BIS_fnc_getFactions; // returns all factions
Example 2:
[] call BIS_fnc_getFactions; // same as Example 1
Example 3:
[player] call BIS_fnc_getFactions; // returns index of player's faction
Example 4:
["BLU_F"] call BIS_fnc_getFactions; // returns index of given faction
Example 5:
[[]] call BIS_fnc_getFactions; // will return all faction sides
Example 6:
[[player]] call BIS_fnc_getFactions; // will return player's side

Additional Information

See also:
factionside

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