side: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (template:command argument fix)
(56 intermediate revisions by 28 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|SIDE]]
{{Command|= Comments
[[Category:Scripting Commands OFP 1.96|SIDE]]
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|SIDE]]
 
[[Category:Scripting Commands ArmA|SIDE]]
| ofp |= Game name
 
|1.00|= Game version
 
|arg= global |= Arguments in MP
____________________________________________________________________________________________
 
| Returns the side of a unit, vehicle, object or location.
* a renegade soldier's side will return a [[sideEnemy]]
* an empty vehicle will return [[civilian]]
* a crewed vehicle will return, 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
* 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:
* [[east]] {{=}} "EAST"
* [[west]] {{=}} "WEST"
* [[resistance]] {{=}} "GUER"
* [[civilian]] {{=}} "CIV"
* [[sideUnknown]] {{=}} "UNKNOWN"
* [[sideEnemy]] {{=}} "ENEMY"
* [[sideFriendly]] {{=}} "FRIENDLY"
* [[sideLogic]] {{=}} "LOGIC"
* [[sideEmpty]] {{=}} "EMPTY"
* [[sideAmbientLife]] {{=}} "AMBIENT LIFE"
}}
|DESCRIPTION=
____________________________________________________________________________________________
 
| '''side''' object |SYNTAX=
 
|p1= object: [[Object]], [[Group]] or [[Location]] |PARAMETER1=
 
| [[Side]] |RETURNVALUE=
____________________________________________________________________________________________


|x1= <code>[[if]] ([[side]] [[player]] == [[west]]) [[then]] { [[hint]] "Player is on the West side" };</code> |EXAMPLE1=


<h2 style="color:#000066">'''side ''unit'''''</h2>
|x2= <code>_sideAlsoWorkingForDead = [[side]] [[group]] [[player]];</code> |EXAMPLE2=


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


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


'''unit:''' [[Object]] or [[Group]]
| [[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=


'''Type of returned value:'''
}}


[[Side]]
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<dd class="notedate">
<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.<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]]


'''Description:'''
<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 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.


'''Side''' of '''unit'''.
<dd class="notedate">
<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.


'''Note:''' This does not change the '''side''' of the unit.
<dd class="notedate">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"'


'''Example:'''
<!-- Note Section END -->
</dl>


? ('''side''' [[player]] == [[west]]) : [[hint]] "You are on the West side."
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|SIDE]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|SIDE]]
[[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 Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 15:49, 7 April 2019

Hover & click on the images for description

Description

Description:
Returns the side of a unit, vehicle, object or location.
  • a renegade soldier's side will return a sideEnemy
  • an empty vehicle will return civilian
  • a crewed vehicle will return, if present, commander's > gunner's > driver's or > cargo's side, in this order
  • a captive or dead unit will return civilian. Use side group _unit to get the underlying side
  • you can use playerSide to know the real player's side
Template:note
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 player;
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 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.
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