BIS fnc getFactions: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*) *<\/code>" to "<code>$1$2$3</code>")
m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*) *<\/code>" to "<code>$1$2$3</code>")
Line 29: Line 29:
* [[Number]] - an index
* [[Number]] - an index


|x1= <code>call [[BIS_fnc_getFactions]]; {{cc|returns all factions}}</code>
|x1= <code>call BIS_fnc_getFactions; {{cc|returns all factions}}</code>


|x2= <code>[] call [[BIS_fnc_getFactions]]; {{cc|same as {{HashLink|#Example 1}}}}</code>
|x2= <code>[] call BIS_fnc_getFactions; {{cc|same as {{HashLink|#Example 1}}}}</code>


|x3= <code>[<nowiki/>[[player]]] [[call]] [[BIS_fnc_getFactions]]; {{cc|returns index of player's faction}}</code>
|x3= <code>[<nowiki/>[[player]]] [[call]] [[BIS_fnc_getFactions]]; {{cc|returns index of player's faction}}</code>


|x4= <code>["BLU_F"] call [[BIS_fnc_getFactions]]; {{cc|returns index of given faction}}</code>
|x4= <code>["BLU_F"] call BIS_fnc_getFactions; {{cc|returns index of given faction}}</code>


|x5= <code><nowiki>[[]]</nowiki> [[call]] [[BIS_fnc_getFactions]]; {{cc|will return all faction sides}}</code>
|x5= <code><nowiki>[[]]</nowiki> [[call]] [[BIS_fnc_getFactions]]; {{cc|will return all faction sides}}</code>

Revision as of 21:36, 12 July 2022

Hover & click on the images for description

Description

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

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:
faction side

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