side: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Update description)
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| ofp |= Game name
| ofp |Game name=


|1.00|= Game version
|1.00|Game version=


|arg= global |Multiplayer Arguments=
|arg= global |Multiplayer Arguments=
Line 10: Line 10:


| Returns the side of a unit, vehicle, object or location.
| Returns the side of a unit, vehicle, object or location.
* a renegade soldier's side will return a [[sideEnemy]]
* side of a renegade soldier is [[sideEnemy]]
* an empty vehicle will return [[civilian]]
* side of an empty vehicle is [[civilian]]
* a crewed vehicle will return, if present, commander's > gunner's > driver's or > cargo's side, in this order
* side of a crewed vehicle is, if present, commander's > gunner's > driver's or > cargo's side, in this order
* a captive or dead unit will return [[civilian]]. Use <tt>[[side]] [[group]] _unit</tt> to get the underlying side
* side of a captive or dead unit is [[civilian]]. Use {{Inline code|[[side]] [[group]] _unit}} to get the underlying side (see '''Example 2''')
* you can use [[playerSide]] to know the real player's side
* you can use [[playerSide]] to know the real player's side


{{note|converting a side to string (''via'' [[str]] or [[format]]} will '''not''' return the side command:
{{Informative | Converting a side to string will '''not''' always return the side command text: e.g {{Inline code|[[str]] [[resistance]] {{cc|returns "GUER"}}}}.<br>
* [[east]] {{=}} "EAST"
See [[Side]] page to see the return value of all side commands.}} |DESCRIPTION=
* [[west]] {{=}} "WEST"
* [[resistance]] {{=}} "GUER"
* [[civilian]] {{=}} "CIV"
* [[sideUnknown]] {{=}} "UNKNOWN"
* [[sideEnemy]] {{=}} "ENEMY"
* [[sideFriendly]] {{=}} "FRIENDLY"
* [[sideLogic]] {{=}} "LOGIC"
* [[sideEmpty]] {{=}} "EMPTY"
* [[sideAmbientLife]] {{=}} "AMBIENT LIFE"
}}
|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''side''' object |SYNTAX=
| [[side]] object |SYNTAX=


|p1= object: [[Object]], [[Group]] or [[Location]] |PARAMETER1=
|p1= object: [[Object]], [[Group]] or [[Location]] |PARAMETER1=
Line 40: Line 29:
|x1= <code>[[if]] ([[side]] [[player]] == [[west]]) [[then]] { [[hint]] "Player is on the West side" };</code> |EXAMPLE1=
|x1= <code>[[if]] ([[side]] [[player]] == [[west]]) [[then]] { [[hint]] "Player is on the West side" };</code> |EXAMPLE1=


|x2= <code>_sideAlsoWorkingForDead = [[side]] [[group]] [[player]];</code> |EXAMPLE2=
|x2= <code>_sideAlsoWorkingForDead = [[side]] [[group]] _deadUnit;</code> |EXAMPLE2=


|x3= <code>_sideLocation = [[side]] myLocation;</code> |EXAMPLE3=
|x3= <code>_sideLocation = [[side]] myLocation;</code> |EXAMPLE3=


|x4= <code>if (side player != [[playerSide]]) [[then]] { [[hint]] "player is renegade or dead"; };</code> |EXAMPLE4=
|x4= <code>[[if]] ([[side]] [[player]] != [[playerSide]]) [[then]] { [[hint]] "player is renegade or dead"; };</code> |EXAMPLE4=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[CfgVehicles_Config_Reference#side|CfgVehicles config side value]], [[Side]], [[playerSide]], [[west]], [[east]], [[resistance]], [[civilian]], [[sideLogic]], [[sideFriendly]], [[sideEnemy]], [[sideUnknown]], [[sideEmpty]], [[sideAmbientLife]], [[Side relations]], [[BIS_fnc_sideID]], [[BIS_fnc_objectSide]] |SEEALSO=
| [[CfgVehicles_Config_Reference#side|CfgVehicles config side value]], [[Side]], [[playerSide]], [[west]], [[east]], [[resistance]], [[civilian]], [[sideLogic]], [[sideFriendly]], [[sideEnemy]], [[sideUnknown]], [[sideEmpty]], [[sideAmbientLife]], [[Side relations]], [[BIS_fnc_sideID]], [[BIS_fnc_objectSide]] |SEEALSO=
}}
}}


Line 66: Line 54:
<dd class="notedate">
<dd class="notedate">
<dt class="note">[[User:Tankbuster|Tankbuster]]
<dt class="note">[[User:Tankbuster|Tankbuster]]
<dd class="note">As CEEB says above, in '''ArmA2''', side for a vehicle often depends on who the command or driver is, for example, A KA52, piloted by a USMC guy will have side WEST. For an accurate result of what 'where the vehicle was made', use [[faction]]. This ignores the pilot/commander, so in my example here, this KA52 will always return faction "RU". Note that faction returns different values to side though.
<dd class="note">As Ceeeb says above, in '''{{arma2}}''', side for a vehicle often depends on who the command or driver is, for example, A KA52, piloted by a USMC guy will have side WEST. For an accurate result of what 'where the vehicle was made', use [[faction]]. This ignores the pilot/commander, so in my example here, this KA52 will always return faction "RU". Note that faction returns different values to side though.


<dd class="notedate">February 4, 2011
<dd class="notedate">February 4, 2011
<dt class="note">[[User:RKurtzDmitriyev|RKurtzDmitriyev]]
<dt class="note">[[User:RKurtzDmitriyev|RKurtzDmitriyev]]
<dd class="note">
<dd class="note">
Side values for ambient life (animals) are bizarre. ''side _unit'' returns "CIV", but [[playerSide]] returns "AMBIENT LIFE" when the player is an animal. In that case, ''playerSide == side player'' returns false!
Side values for ambient life (animals) are bizarre. {{Inline code|[[side]] _unit}} returns "CIV", but [[playerSide]] returns "AMBIENT LIFE" when the player is an animal. In that case, {{Inline code|[[playerSide]] {{=}}{{=}} [[side]] player''}} returns false!


Fortunately, you can easily check if a unit is an animal with ''_unit [[isKindOf]] "ANIMAL"'
Fortunately, you can easily check if a unit is an animal with {{Inline code|_unit [[isKindOf]] "ANIMAL"}}


<!-- Note Section END -->
<!-- Note Section END -->
Line 79: Line 67:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|SIDE]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|SIDE]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|SIDE]]
[[Category:Scripting Commands ArmA|SIDE]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]

Revision as of 01:20, 8 September 2019

Hover & click on the images for description

Description

Description:
Returns the side of a unit, vehicle, object or location.
  • side of a renegade soldier is sideEnemy
  • side of an empty vehicle is civilian
  • side of a crewed vehicle is, if present, commander's > gunner's > driver's or > cargo's side, in this order
  • side of a captive or dead unit is civilian. Use side group _unit to get the underlying side (see Example 2)
  • you can use playerSide to know the real player's side
Converting a side to string will not always return the side command text: e.g str resistance // returns "GUER".
See Side page to see the return value of all side commands.
Groups:
Uncategorised

Syntax

Syntax:
side object
Parameters:
object: Object, Group or Location
Return Value:
Side

Examples

Example 1:
if (side player == west) then { hint "Player is on the West side" };
Example 2:
_sideAlsoWorkingForDead = side group _deadUnit;
Example 3:
_sideLocation = side myLocation;
Example 4:
if (side player != playerSide) then { hint "player is renegade or dead"; };

Additional Information

See also:
CfgVehicles config side valueSideplayerSidewesteastresistanceciviliansideLogicsideFriendlysideEnemysideUnknownsideEmptysideAmbientLifeSide relationsBIS_fnc_sideIDBIS_fnc_objectSide

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

Ceeeb
In ArmA, the following objects are on side civilian: dead bodies and vehicles, empty vehicles, all mission editor placed objects (that do not have an inherit side), all objects with interactive components such as ladders and doors, man made structures such as buildings (including classless wrp placed objects), docks, high tension powerlines, see-saws, large rubbish bins, fountains. Basically if an object uses a non-simple damage or physics simulation it is likely to be on the civilian side.
NOTE: If you need to know the side of a dead body, you can use faction command as a workaround -- Killzone_Kid
Ceeeb
In OFP v1.96, the side return value for a vehicle is based on the side of its commander, then gunner, then driver, then cargo. It will retain its side value until it is either empty, or a unit of another side takes over in a equal or higher role, irrespective of the side of other units still on board. This can be used to simulate friendly fire, as a vehicle can be made to appear to be an enemy even though all units on board are actually friendly.
Tankbuster
As Ceeeb says above, in Arma 2, side for a vehicle often depends on who the command or driver is, for example, A KA52, piloted by a USMC guy will have side WEST. For an accurate result of what 'where the vehicle was made', use faction. This ignores the pilot/commander, so in my example here, this KA52 will always return faction "RU". Note that faction returns different values to side though.
February 4, 2011
RKurtzDmitriyev
Side values for ambient life (animals) are bizarre. side _unit returns "CIV", but playerSide returns "AMBIENT LIFE" when the player is an animal. In that case, playerSide == side player returns false! Fortunately, you can easily check if a unit is an animal with _unit isKindOf "ANIMAL"

Bottom Section