DCS func ctfColorTag

From DCS World Wiki - Hoggitworld.com

Scripting Root

Envrioment: Mission Scripting
Function: ctfColorTag Added with: 2.5.6
Member Of: trigger.action
Syntax: function trigger.action.ctfColorTag(string unitName , enum smokeColor , number altitude)
Description: Creates a smoke plume behind a specified aircraft. When passed 0 for smoke type the plume will be disabled. When triggering the on the same unit with a different color the plume will simply change color.

Optional value for altitude can be set. This value is in meters and defines the altitude at which the aircraft must be for the smoke to dispense. If the aircraft goes below that altitude the smoke will stop. As long as the smoke is enabled the toggling on/off by changing altitude is automated.

  Disable 0
  Green   1
  Red     2
  White   3
  Orange  4
  Blue    5

Return Value: function
Return Example: none
Examples: The following creates a blue smoke plume on an aircraft named "IWishEDWouldDocumentFeaturesMore" that will be enabled as long as the aircraft is above 1000 meters.
   trigger.action.ctfColorTag('IWishEDWouldDocumentFeaturesMore', 5, 1000)
Related Functions: Trigger Functions: ctfColorTag, getUserFlag, setUserFlag, getZone, explosion, smoke, effectSmokeBig, illuminationBomb, signalFlare, radioTransmission, setUnitInternalCargo

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

addOtherCommand, removeOtherCommand, addOtherCommandForCoalition, removeOtherCommandForCoalition, addOtherCommandForGroup, removeOtherCommandForGroup

markToAll, markToCoalition, markToGroup, removeMark, markupToAll, lineToAll, circleToAll, rectToAll, quadToAll, textToAll, arrowToAll

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

Notes: The color matches the smokeColor enumerator, but the values are offset up by 1.