playerSide: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}")
 
(70 intermediate revisions by 17 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|P]]
{{RV|type=command
[[Category:Scripting Commands ArmA|P]]


<new command not populated>
|game1= arma1
|version1= 1.00


|game2= arma2
|version2= 1.00


<h2 style="color:#000066">''''' playerSide '''''</h2>
|game3= arma2oa
|version3= 1.50


|game4= tkoh
|version4= 1.00


'''Operand types:'''
|game5= arma3
|version5= 0.50


'''Type of returned value:'''
|gr1= Sides


'''Compatibility:'''
|descr= Returns the player's [[Side|side]]. This is valid even when the player controlled person is dead (a difference from [[side]] [[player]]).
{{Feature|informative|[[playerSide]] will not change automatically if [[player]] [[join]]s a [[group]] on different [[side]]. However, [[selectPlayer]] command can and does change [[playerSide]] - see {{Link|#Example 3}} for information.}}


'''Description:'''
|s1= [[playerSide]]


|r1= [[Side]]


'''Example:'''
|x1= <sqf>
if (side man1 == playerSide) then
{
hint "man1 is on your side!";
};
</sqf>
 
|x2= <sqf>
switch (playerSide) do
{
case west: { hint "You are BLUFOR"; };
case east: { hint "You are OPFOR"; };
};
</sqf>
 
|x3= the following code will change the side of the player including [[playerSide]]:
<sqf>
private _player = player;
[player] join createGroup east;
selectNoPlayer;
selectPlayer _player;
hint str playerSide; // EAST
</sqf>
 
|seealso= [[Side]] [[side]] [[west]] [[east]] [[resistance]] [[civilian]] [[sideLogic]] [[sideFriendly]] [[sideEnemy]] [[sideUnknown]] [[sideEmpty]] [[sideAmbientLife]] [[Side Relations]]
}}
 
{{Note
|user= Dr_Eyeball
|timestamp= 20080127075200
|text= [[playerSide]] defaults to [[west]] for JIP players early on during initialization regardless of their side.<br>
So if you are a JIP player on another side (like [[east]]), you will need to cater for this for any early initializations.
}}
 
{{Note
|user= Dr_Eyeball
|timestamp= 20081013083000
|text= [[playerSide]] also shows your starting side, even if your [[side]] changes to [[enemy]] due to a bad [[rating]]. In that case, playerSide != side player.
}}

Latest revision as of 19:11, 15 March 2024

Hover & click on the images for description

Description

Description:
Returns the player's side. This is valid even when the player controlled person is dead (a difference from side player).
playerSide will not change automatically if player joins a group on different side. However, selectPlayer command can and does change playerSide - see Example 3 for information.
Groups:
Sides

Syntax

Syntax:
playerSide
Return Value:
Side

Examples

Example 1:
if (side man1 == playerSide) then { hint "man1 is on your side!"; };
Example 2:
switch (playerSide) do { case west: { hint "You are BLUFOR"; }; case east: { hint "You are OPFOR"; }; };
Example 3:
the following code will change the side of the player including playerSide:
private _player = player; [player] join createGroup east; selectNoPlayer; selectPlayer _player; hint str playerSide; // EAST

Additional Information

See also:
Side side 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
Dr_Eyeball - c
Posted on Jan 27, 2008 - 07:52 (UTC)
playerSide defaults to west for JIP players early on during initialization regardless of their side.
So if you are a JIP player on another side (like east), you will need to cater for this for any early initializations.
Dr_Eyeball - c
Posted on Oct 13, 2008 - 08:30 (UTC)
playerSide also shows your starting side, even if your side changes to enemy due to a bad rating. In that case, playerSide != side player.