BIS fnc sideID: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Remove placeholder link - added an example to apologise!)
m (Some wiki formatting)
 
(40 intermediate revisions by 3 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|
 
| Return config side number.
* 0 {{=}} [[opfor]] ([[east]])
* 0 {{=}} [[opfor]] ([[east]])
* 1 {{=}} [[blufor]] ([[west]])
* 1 {{=}} [[blufor]] ([[west]])
Line 19: Line 18:
* 8 {{=}} [[sideEmpty]]
* 8 {{=}} [[sideEmpty]]
* 9 {{=}} [[sideAmbientLife]]
* 9 {{=}} [[sideAmbientLife]]
|= Description
}}
____________________________________________________________________________________________


| testedSide call [[BIS_fnc_sideID]] |= Syntax
|s1= testedSide call [[BIS_fnc_sideID]]


|p1= testedSide: [[Side]] - the tested side (west, east, etc.) |= Parameter 1
|p1= testedSide: [[Side]] - the tested side (west, east, etc.)


| [[Number]] |= Return value
|r1= [[Number]]
____________________________________________________________________________________________


|x1= <code>west call [[BIS_fnc_sideID]]; {{codecomment|// returns 1}}</code> |= Example 1
|x1= <sqf>west call BIS_fnc_sideID; // returns 1</sqf>


|x2= <code>[[hint]] [[format]] ["Your side (%1) ID is %2", playerSide, playerSide call [[BIS_fnc_sideID]]];</code> |= Example 2
|x2= <sqf>hint format ["Your side (%1) ID is %2", playerSide, playerSide call BIS_fnc_sideID];</sqf>
____________________________________________________________________________________________


| [[side]], [[countSide]], [[CfgVehicles_Config_Reference#side|CfgVehicles config side value]], [[Side]], [[playerSide]], [[west]], [[east]], [[resistance]], [[civilian]], [[sideLogic]], [[sideFriendly]], [[sideEnemy]], [[sideUnknown]], [[sideEmpty]], [[sideAmbientLife]], [[Side relations]] |= 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 21:02, 12 June 2023

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