side: Difference between revisions
Jump to navigation
Jump to search
(added see also) |
Lou Montana (talk | contribs) m (Text replacement - "Category:Scripting Commands ArmA2" to "Category:Scripting Commands Arma 2") |
||
(38 intermediate revisions by 19 users not shown) | |||
Line 1: | Line 1: | ||
{{Command|= | {{Command|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| ofp | | | ofp |Game name= | ||
|1.00| | |1.00|Game version= | ||
|arg= global |Multiplayer Arguments= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Returns the side of a unit or | | 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 | |||
{{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= | |||
____________________________________________________________________________________________ | |||
| [[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= | ||
|x2= <code>_sideAlsoWorkingForDead = [[side]] [[group]] _deadUnit;</code> |EXAMPLE2= | |||
| | |x3= <code>_sideLocation = [[side]] myLocation;</code> |EXAMPLE3= | ||
| [[ | |x4= <code>[[if]] ([[side]] [[player]] != [[playerSide]]) [[then]] { [[hint]] "player is renegade or dead"; };</code> |EXAMPLE4= | ||
|x5= Check the [[side]] of the vehicle: <code>_vehicleSide = [[side]] [[group]] _vehicle; {{cc|[[sideUnknown]] if empty or dead [[crew]], otherwise the appropriate [[side]]}}</code> |EXAMPLE5= | |||
| | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[ | | [[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 32: | Line 43: | ||
<dl class="command_description"> | <dl class="command_description"> | ||
<!-- Note Section BEGIN --> | <!-- Note Section BEGIN --> | ||
<dd class="notedate" | <dd class="notedate"> | ||
<dt class="note"> | <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]] | |||
<dd class="notedate" | <dd class="notedate"> | ||
<dt class="note"> | <dt class="note">[[User:Ceeeb|Ceeeb]] | ||
<dd class="note">In '''OFP | <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. | |||
<dd class="notedate" | <dd class="notedate"> | ||
<dt class="note"> | <dt class="note">[[User:Tankbuster|Tankbuster]] | ||
<dd class="note"> | <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"> | <dd class="notedate">February 4, 2011 | ||
<dt class="note"> | <dt class="note">[[User:RKurtzDmitriyev|RKurtzDmitriyev]] | ||
<dd class="note"> | <dd class="note"> | ||
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 62: | Line 68: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Scripting Commands| | [[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands OFP 1.96| | [[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands OFP 1. | [[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands ArmA| | [[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]] | [[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]] | ||
Revision as of 16:22, 10 January 2020
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
- Groups:
- Uncategorised
Syntax
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"; };
- Example 5:
- Check the side of the vehicle:
_vehicleSide = side group _vehicle; // sideUnknown if empty or dead crew, otherwise the appropriate side
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
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands OFP 1.46
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.99
- Scripting Commands ArmA
- Scripting Commands Arma 2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters
- Command Group: Object Information