Difference between revisions of "DCS func setUnitInternalCargo"

From DCS World Wiki - Hoggitworld.com
(Created page with "{{Template:dcs_funcs |fName= setUnitInternalCargo |vNum= 2.5.6 |par1= trigger.action |par2= |par3= |par4= |desc= Sets the internal cargo for...")
 
 
(2 intermediate revisions by 2 users not shown)
Line 13: Line 13:
 
|par4=
 
|par4=
  
|desc= Sets the internal cargo for the specified unit at the specified mass. Can be used in conjunction with troop transport to simulate cargo being added to the aircraft. Can be used on any unit object, however it only will impact airplanes and helicopters. Mass is defined in kilograms.  
+
|desc= Sets the internal cargo for the specified unit at the specified mass. Overrides any previously set value. Can be used in conjunction with troop transport to simulate cargo being added to the aircraft. Can be used on any unit object, however it only will impact airplanes and helicopters. Mass is defined in kilograms.  
  
 
|rtnType= function
 
|rtnType= function
Line 41: Line 41:
 
|optType2=
 
|optType2=
  
|examples= trigger.action.setUnitInternalCargo('Jek Porkins', 1000)
+
|examples= The following simulates what would happen if your momma was a passenger in the aircraft.
 +
 
 +
  local yoMomma= 5000
 +
  trigger.action.setUnitInternalCargo('Jek Porkins', yoMomma)
 +
 
 
|related=  
 
|related=  
 
[[DCS_singleton_trigger|'''Trigger Functions:''']] {{ListOfTriggerFuncs}}
 
[[DCS_singleton_trigger|'''Trigger Functions:''']] {{ListOfTriggerFuncs}}
 
|notes=  
 
|notes=  
 +
 
}}
 
}}
 
[[Category:Singleton Functions|addOtherCommandForGroup]]
 
[[Category:Singleton Functions|addOtherCommandForGroup]]
 +
[[Category:Game Patch 2.5.6|setUnitInternalCargo]]

Latest revision as of 08:02, 3 October 2022

Scripting Root

Envrioment: Mission Scripting
Function: setUnitInternalCargo Added with: 2.5.6
Member Of: trigger.action
Syntax: function trigger.action.setUnitInternalCargo(string unitName , number mass )
Description: Sets the internal cargo for the specified unit at the specified mass. Overrides any previously set value. Can be used in conjunction with troop transport to simulate cargo being added to the aircraft. Can be used on any unit object, however it only will impact airplanes and helicopters. Mass is defined in kilograms.


Return Value: function
Return Example: none
Examples: The following simulates what would happen if your momma was a passenger in the aircraft.
  local yoMomma= 5000
  trigger.action.setUnitInternalCargo('Jek Porkins', yoMomma)
Related Functions: Trigger Functions: ctfColorTag, getUserFlag, setUserFlag, getZone, explosion, smoke, effectSmokeBig, effectSmokeStop, illuminationBomb, signalFlare, radioTransmission, stopRadioTransmission, setUnitInternalCargo

outSound, outSoundForCoalition, outSoundForCountry, outSoundForGroup, outSoundForUnit, outText, outTextForCoalition, outTextForCountry, outTextForGroup, outTextForUnit

addOtherCommand, removeOtherCommand, addOtherCommandForCoalition, removeOtherCommandForCoalition, addOtherCommandForGroup, removeOtherCommandForGroup

markToAll, markToCoalition, markToGroup, removeMark, markupToAll, lineToAll, circleToAll, rectToAll, quadToAll, textToAll, arrowToAll, setMarkupRadius, setMarkupText, setMarkupFontSize, setMarkupColor, setMarkupColorFill, setMarkupTypeLine, setMarkupPositionEnd, setMarkupPositionStart

setAITask, pushAITask, activateGroup, deactivateGroup, setGroupAIOn, setGroupAIOff, groupStopMoving, groupContinueMoving

Notes: