assignedVehicleRole: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\: ?Command[ _]Group\:.*\|\{\{uc\:\{\{PAGENAME\}\}\}\}\]\] " to "")
m (Some wiki formatting)
 
(55 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma |Game name=
|game1= arma1
|version1= 1.05


|1.05|Game version=
|game2= arma2
|version2= 1.00


|arg= global |Multiplayer Arguments=
|game3= arma2oa
|version3= 1.50


|gr1= Object Manipulation |GROUP1=
|game4= tkoh
|version4= 1.00


| mp= On a client the command will return empty arrays for every unit that is not local. On the server the command correctly returns the role, regardless of the units locality.
|game5= arma3
|version5= 0.50


|Returns the role a unit is assigned to within its assigned vehicle.
|arg= global


<br><br>
|gr1= Object Manipulation
'''Notes:'''
* When an unit enters a vehicle crew position, it gets assigned the vehicle role automatically for the given crew position.
* The unit does not have to be in the vehicle when getting the role assignment (ie via assignAsXXX or human/AI GL getIn radio commands).
* GL getIn radio commands result in instant assignment - the unit does not yet have to occupy the crew position.
* Dying units will let go of the assigned role after a few seconds - seems the delay is independent of being in the vehicle or not.
* An unit will hold on to its assigned role after exiting the vehicle.
* One has to use [[unassignVehicle]] (and stop an AI GL to assign vehicle positions again) or [[leaveVehicle]] to remove the assignment - or assigned to another vehicle.
* A vehicle position/role can only be assigned to one unit at a time. So even when not (visually) occupied, the "seat" may be blocked/reserved by another unit.
* A player can still get into the vehicle position already assigned if not already taken, or switch seats with AI (if [[leader]] or [[effectiveCommander]] for those AI).
|DESCRIPTION=
____________________________________________________________________________________________


| '''assignedVehicleRole''' unitName |SYNTAX=
|descr= Returns the role a unit is assigned to within its assigned vehicle.
{{Feature|informative|See [[AI Group Vehicle Management]] for more information.}}


|p1=  unitName: [[Object]] |PARAMETER1=
|mp= On a client the command will return empty arrays for every unit that is not local. On the server the command correctly returns the role, regardless of the units locality.


| [[Array]] - The array which is returned contains:<br>
|s1= [[assignedVehicleRole]] unitName
* [] - Not assigned to any vehicle
* ["Driver"] - Assigned as driver
* ["Cargo"] (or ["Cargo", [turret path]] since Arma 3 1.31.127272) - Assigned as cargo
* ["Turret", [turret path]] - Assigned to a turret|RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code>_RoleArray = [[assignedVehicleRole]] [[player]];</code> |EXAMPLE1=
|x2= Get weapons available to player at player occupied turret:<code>_weaponsTurret = [[vehicle]] [[player]] [[weaponsTurret]] ([[assignedVehicleRole]] [[player]] [[select]] 1);</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[addVehicle]], [[assignedVehicle]], [[unassignVehicle]], [[leaveVehicle]], [[assignAsCargo]], [[assignAsCommander]], [[assignAsDriver]], [[assignAsGunner]], [[assignAsTurret]], [[crew]], [[fullCrew]] |SEEALSO=
|p1= unitName: [[Object]]


}}
|r1= [[Array]] - the array which is returned contains:<br>
* [] - not assigned to any vehicle
* ["driver"] - Assigned as driver
* ["cargo"] or {{GVI|arma3|1.32|size= 0.75}} ["cargo", [turret path]] - assigned as cargo
* ["turret", turretPath] - assigned to a turret (turretPath format [[Turret Path]])


<h3 style="display:none">Notes</h3>
|x1= <sqf>_RoleArray = assignedVehicleRole player;</sqf>
<dl class="command_description">


<!-- Note Section BEGIN -->
|x2= Get weapons available to player at player occupied turret:
<sqf>_weaponsTurret = vehicle player weaponsTurret (assignedVehicleRole player select 1);</sqf>


<dd class="notedate">Posted on August 31, 2013</dd>
|seealso= [[addVehicle]] [[assignedVehicle]] [[unassignVehicle]] [[leaveVehicle]] [[assignAsCargo]] [[assignAsCommander]] [[assignAsDriver]] [[assignAsGunner]] [[assignAsTurret]] [[crew]] [[assignedVehicles]] [[assignedGroup]] [[fullCrew]]
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]</dt>
}}
<dd class="note">When player is in a group of AIs and is not the leader, [[assignedVehicleRole]] of the player could be unpredictable and absolutely not related to the position player occupies. In short, forget about this command for the player, it is unreliable and has been broken too many times in the past.
</dd>


<!-- Note Section END -->
{{Note
</dl>
|user= Killzone_Kid
 
|timestamp= 20130831161800
<h3 style="display:none">Bottom Section</h3>
|text= When player is in a group of AIs and is not the leader, [[assignedVehicleRole]] of the player could be unpredictable and absolutely not related to the position player occupies.
 
In short, forget about this command for the player, it is unreliable and has been broken too many times in the past.
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:28, 17 April 2023

Logo A1 black.png1.05Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
Hover & click on the images for description

Description

Description:
Returns the role a unit is assigned to within its assigned vehicle.
ⓘ
See AI Group Vehicle Management for more information.
Multiplayer:
On a client the command will return empty arrays for every unit that is not local. On the server the command correctly returns the role, regardless of the units locality.
Groups:
Object Manipulation

Syntax

Syntax:
assignedVehicleRole unitName
Parameters:
unitName: Object
Return Value:
Array - the array which is returned contains:
  • [] - not assigned to any vehicle
  • ["driver"] - Assigned as driver
  • ["cargo"] or Arma 3 logo black.png1.32 ["cargo", [turret path]] - assigned as cargo
  • ["turret", turretPath] - assigned to a turret (turretPath format Turret Path)

Examples

Example 1:
_RoleArray = assignedVehicleRole player;
Example 2:
Get weapons available to player at player occupied turret:
_weaponsTurret = vehicle player weaponsTurret (assignedVehicleRole player select 1);

Additional Information

See also:
addVehicle assignedVehicle unassignVehicle leaveVehicle assignAsCargo assignAsCommander assignAsDriver assignAsGunner assignAsTurret crew assignedVehicles assignedGroup fullCrew

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
Killzone_Kid - c
Posted on Aug 31, 2013 - 16:18 (UTC)
When player is in a group of AIs and is not the leader, assignedVehicleRole of the player could be unpredictable and absolutely not related to the position player occupies. In short, forget about this command for the player, it is unreliable and has been broken too many times in the past.
Retrieved from "https://community.bistudio.com/wiki?title=assignedVehicleRole&oldid=338904"