moveInCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (add moveInAny to see also)
m (Text replacement - "{{Feature|Important|" to "{{Feature|important|")
 
(64 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.00


|1.00|= Game version
|game2= ofpe
|version2= 1.00


|arg= local |= Arguments in MP
|game3= arma1
|version3= 1.00


|eff= global |= Effects in MP
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Move soldier into vehicle cargo position (Immediate, no animation). |DESCRIPTION=
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| unitName '''moveInCargo''' vehicle |SYNTAX=
|game6= tkoh
|version6= 1.00


|p1= unitName: [[Object]] |PARAMETER1=
|game7= arma3
|p2= vehicle: [[Object]] |PARAMETER2=
|version7= 0.50


| [[Nothing]] |RETURNVALUE=
|arg= local
____________________________________________________________________________________________
|s2= unitName '''moveInCargo''' [vehicle, CargoIndex] |SYNTAX=


|p21= unitName: [[Object]] |PARAMETER1=
|eff= global
|p22= vehicle: [[Object]] |PARAMETER2=
|p23= CargoIndex: [[Number]] |PARAMETER3=


|r2= [[Nothing]]  |RETURNVALUE=
|gr1= Unit Control
____________________________________________________________________________________________
 
|x1= <code>_soldierOne [[moveInCargo]] _jeepOne;</code> |EXAMPLE1=
|x2= <code>_soldierOne [[moveInCargo]] [_jeepOne, 1];</code>|EXAMPLE2=
____________________________________________________________________________________________


| [[moveInAny]], [[moveInCommander]], [[moveInDriver]], [[moveInGunner]], [[moveInTurret]], [[assignAsCargo]], [[assignAsCommander]], [[assignAsDriver]], [[assignAsGunner]], [[getCargoIndex]]  |SEEALSO=
|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.}}


}}
|s1= unit [[moveInCargo]] vehicle
 
|p1= unit: [[Object]]
 
|p2= vehicle: [[Object]]
 
|r1= [[Nothing]]
 
|s2= unit [[moveInCargo]] [vehicle, cargoIndex, canReassign]
 
|p21= unit: [[Object]]


<h3 style="display:none">Notes</h3>
|p22= vehicle: [[Object]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on August 4, 2006 - 14:42
|p23= cargoIndex: [[Number]]
<dt class="note">'''[[User:Hardrock|hardrock]]'''<dd class="note">''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: moveInCargo helo1 this [[assignAsCargo]] helo1
|p24= canReassign: [[Boolean]] - (Optional, default [[true]]) try to move ''unit'' into the first free ''vehicle'' cargo seat if ''cargoIndex'' is already occupied
MP Note Functions MoveInCargo can only be called for local soldiers. They will be ignored for remote soldiers. (see [[Locality in Multiplayer]])
|p24since= arma3 2.08


|r2= [[Nothing]]


<dt class="note">'''[[User:Ceeeb|Ceeeb]]'''
|x1= <sqf>_soldierOne moveInCargo _jeepOne;</sqf>
<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.


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


<dt class="note">'''[[User:Killzone_Kid|Killzone_Kid]]'''
|seealso= [[moveInAny]] [[moveInCommander]] [[moveInDriver]] [[moveInGunner]] [[moveInTurret]] [[assignAsCargo]] [[assignAsCommander]] [[assignAsDriver]] [[assignAsGunner]] [[getCargoIndex]]
<dd class="note">
}}
In Arma 3 when using the alternative syntax of [[moveInCargo]], it is necessary to call [[assignAsCargoIndex]] because it is not called automatically.
<code>unit1 [[moveInCargo]] [heli, 3];
unit1 [[assignAsCargoIndex]] [heli, 3];</code>
Alternatively avoid this broken syntax all together and use:
<code>unit1 [[assignAsCargoIndex]] [heli, 3];
unit1 [[moveInCargo]] heli;
</code>
<br><br>


<!-- Note Section END -->
{{Note
</dl>
|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>
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
|user= Ceeeb
|timestamp= 20070202070000
|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.
}}


[[Category:Scripting Commands|MOVEINCARGO]]
{{Note
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
|user= Killzone_Kid
[[Category:Scripting Commands OFP 1.96|MOVEINCARGO]]
|timestamp= 20140318190800
[[Category:Scripting Commands OFP 1.46|MOVEINCARGO]]
|text=  In {{arma3}} when using the alternative syntax of [[moveInCargo]], it is necessary to call [[assignAsCargoIndex]] because it is not called automatically.
[[Category:Scripting Commands ArmA|MOVEINCARGO]]
<sqf>
[[Category:Command_Group:_Vehicle_Assignment|{{uc:{{PAGENAME}}}}]]
unit1 moveInCargo [heli, 3];
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
unit1 assignAsCargoIndex [heli, 3];
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
</sqf>
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
Alternatively avoid this broken syntax all together and use:
<sqf>
unit1 assignAsCargoIndex [heli, 3];
unit1 moveInCargo heli;
</sqf>
}}

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"