BIS fnc sideID: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(43 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Sides


|1.00|= Game version
|descr= Return config side number.
____________________________________________________________________________________________
{{Columns|4|
* 0 {{=}} [[opfor]] ([[east]])
* 1 {{=}} [[blufor]] ([[west]])
* 2 {{=}} [[independent]] ([[resistance]])
* 3 {{=}} [[civilian]]
* 4 {{=}} [[sideUnknown]]
* 5 {{=}} [[sideEnemy]]
* 6 {{=}} [[sideFriendly]]
* 7 {{=}} [[sideLogic]]
* 8 {{=}} [[sideEmpty]]
* 9 {{=}} [[sideAmbientLife]]
}}


| <pre>/*
|s1= testedSide call [[BIS_fnc_sideID]]


Description:
|p1= testedSide: [[Side]] - the tested side (west, east, etc.)
Returns side ID (as used in config).


Parameter(s):
|r1= [[Number]]
0: SIDE


Returns:
|x1= <sqf>west call BIS_fnc_sideID; // returns 1</sqf>
NUMBER
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|x2= <sqf>hint format ["Your side (%1) ID is %2", playerSide, playerSide call BIS_fnc_sideID];</sqf>
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_sideID]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[BIS_fnc_sideType]] [[side]] [[countSide]] [[CfgVehicles Config Reference#side|CfgVehicles side value]] [[Side]] [[playerSide]] [[west]] [[east]] [[resistance]] [[civilian]] [[sideLogic]] [[sideFriendly]] [[sideEnemy]] [[sideUnknown]] [[sideEmpty]] [[sideAmbientLife]] [[Side Relations]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Sides|{{uc:sideID}}]]
[[Category:Functions|{{uc:sideID}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sideID}}]]

Latest revision as of 20:02, 12 June 2023

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Return config side number.
Execution:
call
Groups:
Sides

Syntax

Syntax:
testedSide call BIS_fnc_sideID
Parameters:
testedSide: Side - the tested side (west, east, etc.)
Return Value:
Number

Examples

Example 1:
west call BIS_fnc_sideID; // returns 1
Example 2:
hint format ["Your side (%1) ID is %2", playerSide, playerSide call BIS_fnc_sideID];

Additional Information

See also:
BIS_fnc_sideType side countSide CfgVehicles side value Side playerSide west east resistance civilian sideLogic sideFriendly sideEnemy sideUnknown sideEmpty sideAmbientLife Side Relations

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_sideID&oldid=341625"