moveInCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *PARAMETER[0-9]{1,3} *= * " to " ")
m (Text replacement - "{{Feature|Important|" to "{{Feature|important|")
 
(41 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp
|version1= 1.00


|1.00
|game2= ofpe
|version2= 1.00
 
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50


|arg= local
|arg= local
Line 11: Line 28:
|gr1= Unit Control
|gr1= Unit Control


| Move soldier into vehicle cargo position (Immediate, no animation).
|descr= Moves a unit into a vehicle cargo position (immediately and without animation).
{{Feature|informative|See [[AI Group Vehicle Management]] for more information.}}
{{Feature|important|If the unit is already in a vehicle, nothing will happen. You should use [[moveOut]] to move the unit out of his vehicle before trying to move him into a new (or same) vehicle.}}
|mp= {{Feature|informative|The command should execute where the '''unit''' (not '''vehicle''') is local.}}


| unitName [[moveInCargo]] vehicle
|s1= unit [[moveInCargo]] vehicle


|p1= unitName: [[Object]]
|p1= unit: [[Object]]


|p2= vehicle: [[Object]]
|p2= vehicle: [[Object]]


| [[Nothing]]
|r1= [[Nothing]]
|s2= unitName [[moveInCargo]] [vehicle, CargoIndex]
 
|s2= unit [[moveInCargo]] [vehicle, cargoIndex, canReassign]


|p21= unitName: [[Object]]
|p21= unit: [[Object]]


|p22= vehicle: [[Object]]
|p22= vehicle: [[Object]]


|p23= CargoIndex: [[Number]]
|p23= cargoIndex: [[Number]]
 
|p24= canReassign: [[Boolean]] - (Optional, default [[true]]) try to move ''unit'' into the first free ''vehicle'' cargo seat if ''cargoIndex'' is already occupied
|p24since= arma3 2.08


|r2= [[Nothing]]
|r2= [[Nothing]]
 
|x1= <code>_soldierOne [[moveInCargo]] _jeepOne;</code>


|x2= <code>_soldierOne [[moveInCargo]] [_jeepOne, 1];</code>
|x1= <sqf>_soldierOne moveInCargo _jeepOne;</sqf>


| [[moveInAny]], [[moveInCommander]], [[moveInDriver]], [[moveInGunner]], [[moveInTurret]], [[assignAsCargo]], [[assignAsCommander]], [[assignAsDriver]], [[assignAsGunner]], [[getCargoIndex]]
|x2= <sqf>_soldierOne moveInCargo [_jeepOne, 1];</sqf>
 
|seealso= [[moveInAny]] [[moveInCommander]] [[moveInDriver]] [[moveInGunner]] [[moveInTurret]] [[assignAsCargo]] [[assignAsCommander]] [[assignAsDriver]] [[assignAsGunner]] [[getCargoIndex]]
}}
}}


<dl class="command_description">
{{Note
<!-- Note Section BEGIN -->
|user= Hardrock
|timestamp= 20060804144200
|text= ''Notes from before the conversion''<br>
If you place a soldier in a vehicle with the moveInCargo command, he wont "know" he's in the vehicle, and thus he won't disembark properly when the vehicle reaches a Transport Unload waypoint.
Therefore you have to use the [[assignAsCargo]] command, in order for the AI to catch on. Something like this:
<sqf>_soldier moveInCargo helo1; _soldier assignAsCargo helo1;</sqf>
}}


<dd class="notedate">Posted on August 4, 2006 - 14:42
{{Note
<dt class="note">[[User:Hardrock|hardrock]]
|user= Ceeeb
<dd class="note">''Notes from before the conversion''<br>
|timestamp= 20070202070000
If you place a soldier in a vehicle with the moveInCargo command, he wont "know" he's in the vehicle, and thus he won't disembark properly when the vehicle reaches a Transport Unload waypoint. Therefore you have to use the [[assignAsCargo]] command, in order for the AI to catch on. Something like this: <code>_soldier [[moveInCargo]] helo1; _soldier [[assignAsCargo]] helo1;</code>
|text= In '''OFP v1.96''', the moveIn commands will not trigger an associated getIn [[Operation_Flashpoint:_EventHandlers_List|event]]. To ensure the getIn event is fired, use the "getIn Cargo" [[Operation_Flashpoint:_Actions_List|action]] command.
 
}}
<dd class="notedate">
<dt class="note">[[User:Ceeeb|Ceeeb]]
<dd class="note">
In '''OFP v1.96''', the moveIn commands will not trigger an associated getIn [[Operation_Flashpoint:_EventHandlers_List|event]]. To ensure the getIn event is fired, use the "getIn Cargo" [[Operation_Flashpoint:_Actions_List|action]] command.


<dd class="notedate">
{{Note
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]
|user= Killzone_Kid
<dd class="note">
|timestamp= 20140318190800
In Arma 3 when using the alternative syntax of [[moveInCargo]], it is necessary to call [[assignAsCargoIndex]] because it is not called automatically.
|text= In {{arma3}} when using the alternative syntax of [[moveInCargo]], it is necessary to call [[assignAsCargoIndex]] because it is not called automatically.
<code>unit1 [[moveInCargo]] [heli, 3];
<sqf>
unit1 [[assignAsCargoIndex]] [heli, 3];</code>
unit1 moveInCargo [heli, 3];
unit1 assignAsCargoIndex [heli, 3];
</sqf>
Alternatively avoid this broken syntax all together and use:
Alternatively avoid this broken syntax all together and use:
<code>unit1 [[assignAsCargoIndex]] [heli, 3];
<sqf>
unit1 [[moveInCargo]] heli;
unit1 assignAsCargoIndex [heli, 3];
</code>
unit1 moveInCargo heli;
 
</sqf>
<!-- Note Section END -->
}}
</dl>
 
 
[[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}}}}]]
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 00:23, 2 February 2024

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

Description

Description:
Moves a unit into a vehicle cargo position (immediately and without animation).
ⓘ
See AI Group Vehicle Management for more information.
⚠
If the unit is already in a vehicle, nothing will happen. You should use moveOut to move the unit out of his vehicle before trying to move him into a new (or same) vehicle.
Multiplayer:
ⓘ
The command should execute where the unit (not vehicle) is local.
Groups:
Unit Control

Syntax

Syntax:
unit moveInCargo vehicle
Parameters:
unit: Object
vehicle: Object
Return Value:
Nothing

Alternative Syntax

Syntax:
unit moveInCargo [vehicle, cargoIndex, canReassign]
Parameters:
unit: Object
vehicle: Object
cargoIndex: Number
since Arma 3 logo black.png2.08
canReassign: Boolean - (Optional, default true) try to move unit into the first free vehicle cargo seat if cargoIndex is already occupied
Return Value:
Nothing

Examples

Example 1:
_soldierOne moveInCargo _jeepOne;
Example 2:
_soldierOne moveInCargo [_jeepOne, 1];

Additional Information

See also:
moveInAny moveInCommander moveInDriver moveInGunner moveInTurret assignAsCargo assignAsCommander assignAsDriver assignAsGunner getCargoIndex

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
Hardrock - c
Posted on Aug 04, 2006 - 14:42 (UTC)
Notes from before the conversion
If you place a soldier in a vehicle with the moveInCargo command, he wont "know" he's in the vehicle, and thus he won't disembark properly when the vehicle reaches a Transport Unload waypoint. Therefore you have to use the assignAsCargo command, in order for the AI to catch on. Something like this:
_soldier moveInCargo helo1; _soldier assignAsCargo helo1;
Ceeeb - c
Posted on Feb 02, 2007 - 07:00 (UTC)
In OFP v1.96, the moveIn commands will not trigger an associated getIn event. To ensure the getIn event is fired, use the "getIn Cargo" action command.
Killzone_Kid - c
Posted on Mar 18, 2014 - 19:08 (UTC)
In Arma 3 when using the alternative syntax of moveInCargo, it is necessary to call assignAsCargoIndex because it is not called automatically.
unit1 moveInCargo [heli, 3]; unit1 assignAsCargoIndex [heli, 3];
Alternatively avoid this broken syntax all together and use:
unit1 assignAsCargoIndex [heli, 3]; unit1 moveInCargo heli;
Retrieved from "https://community.bistudio.com/wiki?title=moveInCargo&oldid=351994"