Difference between revisions of "side"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Update description)
 
(15 intermediate revisions by 5 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=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Returns the side of a unit or object.
+
| 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 {{Inline code|[[side]] [[group]] _unit}} to get the underlying side (see '''Example 2''')
 +
* you can use [[playerSide]] to know the real player's side
  
Once dead, a unit will be on the [[civilian]] side. Query the side of the [[Group]] to get a reliable result.
+
{{Informative | Converting a side to string will '''not''' always return the side command text: e.g {{Inline code|[[str]] [[resistance]] {{cc|returns "GUER"}}}}.<br>
 
+
See [[Side]] page to see the return value of all side commands.}} |DESCRIPTION=
When used in conjunction with a [[format]] statement (<tt>hint [[format]]["%1",side player]</tt>), the returned strings are: <tt>"[[west|WEST]]"</tt>, <tt>"[[east|EAST]]"</tt>, <tt>"[[resistance|GUER]]"</tt>, <tt>"[[civilian|CIV]]"</tt>, <tt>"[[sideLogic|LOGIC]]"</tt>, <tt>"[[sideEnemy|ENEMY]]"</tt> (eg: renegades), <tt>"[[ambient life|AMBIENT LIFE]]"</tt> or <tt>"UNKNOWN"</tt>.
 
|= Description
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[Side]] <nowiki>=</nowiki> '''side''' unitName |= Syntax
+
| [[side]] object |SYNTAX=
  
|p1= unitName: [[Object]] or [[Group]] |= Parameter 1
+
|p1= object: [[Object]], [[Group]] or [[Location]] |PARAMETER1=
  
| [[Side]] |= Return value
+
| [[Side]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
 
|x1= <code>? (side [[player]] <nowiki>==</nowiki> [[west]]) : [[hint]] "You are on the West side."</code> SQS |= Example 1
 
  
|x2= <code>if (side [[player]] <nowiki>==</nowiki> [[west]]) then {[[hint]] "You are on the West side.";};</code> SQF |= Example 2
+
|x1= <code>[[if]] ([[side]] [[player]] == [[west]]) [[then]] { [[hint]] "Player is on the West side" };</code> |EXAMPLE1=
 +
 
 +
|x2= <code>_sideAlsoWorkingForDead = [[side]] [[group]] _deadUnit;</code> |EXAMPLE2=
 +
 
 +
|x3= <code>_sideLocation = [[side]] myLocation;</code> |EXAMPLE3=
  
|x3= <code>_sideAlsoWorkingForDead <nowiki>=</nowiki> side (group [[player]]);</code> |= Example 3
+
|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]], [[playerSide]] ,[[side location]], [[Side relations]]|= See also
+
| [[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 37: Line 43:
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
 
<dd class="notedate">
 
<dd class="notedate">
<dt class="note">'''[[User:Ceeeb|Ceeeb]]'''
+
<dt class="note">[[User:Ceeeb|Ceeeb]]
<dd class="note">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.
+
<dd class="note">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.<br>
 
+
'''NOTE:''' If you need to know the side of a dead body, you can use [[faction]] command as a workaround -- [[User:Killzone_Kid|Killzone_Kid]]
NOTE: If you need to know the side of a dead body, you can use [[faction]] command as a workaround -- [[User:Killzone_Kid|Killzone_Kid]]
 
 
 
<dd class="notedate">
 
<dt class="note">'''[[User:Bdfy|Bdfy]]'''
 
<dd class="note">In '''OFP 1.96''', side return value for empty vehicles will be [[civilian]].
 
 
 
<dd class="notedate">
 
<dt class="note">'''[[User:Ceeeb|Ceeeb]]'''
 
<dd class="note">
 
In '''OFP v1.96''', the side return value for a vehicle is based on the side of it's commander, then gunner, then driver, then cargo. It will retain it's 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.
 
 
 
 
 
<dd class="notedate">
 
<dt class="note">'''[[User:Crowe|Crowe]]'''
 
<dd class="note">
 
Units with negative score(rating) are [[sideEnemy]].
 
 
 
  
 
<dd class="notedate">
 
<dd class="notedate">
<dt class="note">'''[[User:Shuko|Shuko]]'''
+
<dt class="note">[[User:Ceeeb|Ceeeb]]
 
<dd class="note">
 
<dd class="note">
The [[Side]] for civilians is [[civilian]] and the string name of the side is "CIV". For Resistance/Independent (Guerilla) they are [[resistance]] and "GUER".
+
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.
  
 
<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="February 4, 2011">
 
<dt class="note">'''[[User:RKurtzDmitriyev|RKurtzDmitriyev]]'''
 
<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!
 
 
 
Fortunately, you can easily check if a unit is an animal with ''_unit [[isKindOf]] "ANIMAL"'
 
  
 
+
<dd class="notedate">February 4, 2011
<dd class="notedate">
+
<dt class="note">[[User:RKurtzDmitriyev|RKurtzDmitriyev]]
<dt class="note">'''[[User:Lester|Lester]]'''
 
 
<dd class="note">
 
<dd class="note">
Units who set via 'this setcaptive true' are always on side [[civilian]].
+
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 {{Inline code|_unit [[isKindOf]] "ANIMAL"}}
  
 
<!-- Note Section END -->
 
<!-- Note Section END -->
Line 86: 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}}}}]]

Latest revision as of 00:20, 8 September 2019

Introduced with Operation Flashpoint version1.00
  Arguments of this scripting command don't have to be local to the client the command is executed on

Click on the images for descriptions

Introduced in

Game:
Operation Flashpoint
Version:
1.00

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.

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

Multiplayer:
-
See also:
CfgVehicles config side valueSideplayerSidewesteastresistanceciviliansideLogicsideFriendlysideEnemysideUnknownsideEmptysideAmbientLifeSide relationsBIS_fnc_sideIDBIS_fnc_objectSide

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

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