Class CLEANUP

CLEANUP Classes

Info:

  • Author: Flightcontrol

Methods

CLEANUP:New (ZoneNames, TimeInterval) Creates the main object which is handling the cleaning of the debris within the given Zone Names.
CLEANUP:_DestroyGroup (GroupObject, CleanUpGroupName) Destroys a group from the simulator, but checks first if it is still existing!
CLEANUP:_DestroyUnit (CleanUpUnit, CleanUpUnitName) Destroys a unit from the simulator, but checks first if it is still existing!
CLEANUP:_DestroyMissile (MissileObject) Destroys a missile from the simulator, but checks first if it is still existing!
CLEANUP:_EventCrash (event) Detects if an SA site was shot with an anti radiation missile.
CLEANUP:_EventShot (event) Detects if an SA site was shot with an anti radiation missile.
CLEANUP:_EventHitCleanUp (event) Detects if the Unit has an S_EVENT_HIT within the given ZoneNames.
CLEANUP:_EventAddForCleanUp (event) Detects if the Unit has an S_EVENT_ENGINE_SHUTDOWN or an S_EVENT_HIT within the given ZoneNames.
CLEANUP:_Scheduler () At the defined time interval, CleanUp the Groups within the CleanUpList.


Methods

CLEANUP:New (ZoneNames, TimeInterval)
Creates the main object which is handling the cleaning of the debris within the given Zone Names.

Parameters:

  • ZoneNames table{string,...} or string which is a table of zone names where the debris should be cleaned. Also a single string can be passed with one zone name.
  • TimeInterval optional number is the interval in seconds when the clean activity takes place. The default is 300 seconds, thus every 5 minutes.

Returns:

    CLEANUP

Usage:

     -- Clean these Zones.
     CleanUpAirports = CLEANUP:New( { 'CLEAN Tbilisi', 'CLEAN Kutaisi' }, 150 )
     or
     CleanUpTbilisi = CLEANUP:New( 'CLEAN Tbilisi', 150 )
     CleanUpKutaisi = CLEANUP:New( 'CLEAN Kutaisi', 600 )
CLEANUP:_DestroyGroup (GroupObject, CleanUpGroupName)
Destroys a group from the simulator, but checks first if it is still existing!

Parameters:

  • GroupObject
  • CleanUpGroupName

See also:

CLEANUP:_DestroyUnit (CleanUpUnit, CleanUpUnitName)
Destroys a unit from the simulator, but checks first if it is still existing!

Parameters:

  • CleanUpUnit
  • CleanUpUnitName

See also:

CLEANUP:_DestroyMissile (MissileObject)
Destroys a missile from the simulator, but checks first if it is still existing!

Parameters:

  • MissileObject

See also:

CLEANUP:_EventCrash (event)
Detects if an SA site was shot with an anti radiation missile. In this case, take evasive actions based on the skill level set within the ME.

Parameters:

  • event

See also:

CLEANUP:_EventShot (event)
Detects if an SA site was shot with an anti radiation missile. In this case, take evasive actions based on the skill level set within the ME.

Parameters:

  • event

See also:

CLEANUP:_EventHitCleanUp (event)
Detects if the Unit has an S_EVENT_HIT within the given ZoneNames. If this is the case, destroy the unit.

Parameters:

  • event
CLEANUP:_EventAddForCleanUp (event)
Detects if the Unit has an S_EVENT_ENGINE_SHUTDOWN or an S_EVENT_HIT within the given ZoneNames. If this is the case, add the Group to the CLEANUP List.

Parameters:

  • event
CLEANUP:_Scheduler ()
At the defined time interval, CleanUp the Groups within the CleanUpList.
generated by LDoc 1.4.3 Last updated 2016-03-14 10:50:59