Difference between revisions of "DCS func setUnitInternalCargo"

Revision as of 07:28, 19 November 2020

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:	trigger.action.setUnitInternalCargo('Jek Porkins', 1000)
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:

@@ Line 13: / Line 13: @@
 |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
@@ Line 45: / Line 45: @@
 [[DCS_singleton_trigger|'''Trigger Functions:''']] {{ListOfTriggerFuncs}}
 |notes=
 }}
 [[Category:Singleton Functions|addOtherCommandForGroup]]