Banner Image

Module AI.AI_Air_Squadron

AI - Models squadrons for airplanes and helicopters.

This is a class used in the AI.AI_Air_Dispatcher and derived dispatcher classes.


Author: FlightControl


Global(s)

Global AI_AIR_SQUADRON

Implements the core functions modeling squadrons for airplanes and helicopters.

#AI_AIR_SQUADRON AI_AIR_SQUADRON

Implements the core functions modeling squadrons for airplanes and helicopters.

Developer Note

Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE Therefore, this class is considered to be deprecated


Type(s)

Fields and Methods inherited from AI_AIR_SQUADRON Description

AI_AIR_SQUADRON:AddResources(Resources)

Add Resources to the Squadron.

AI_AIR_SQUADRON.Airbase

AI_AIR_SQUADRON.AirbaseName

AI_AIR_SQUADRON.Captured

AI_AIR_SQUADRON.EngageProbability

AI_AIR_SQUADRON.FuelThreshold

AI_AIR_SQUADRON:GetEngageProbability()

Get the EngageProbability of the Squadron.

AI_AIR_SQUADRON:GetFuelThreshold()

Get the FuelThreshold of the Squadron.

AI_AIR_SQUADRON:GetGrouping()

Get the Grouping of the Squadron.

AI_AIR_SQUADRON:GetLanding()

Get the Landing of the Squadron.

AI_AIR_SQUADRON:GetName()

Get the Name of the Squadron.

AI_AIR_SQUADRON:GetOverhead()

Get the Overhead of the Squadron.

AI_AIR_SQUADRON:GetResourceCount()

Get the ResourceCount of the Squadron.

AI_AIR_SQUADRON:GetTakeoff()

Get the Takeoff of the Squadron.

AI_AIR_SQUADRON:GetTankerName()

Get the Tanker Name of the Squadron.

AI_AIR_SQUADRON.Grouping

AI_AIR_SQUADRON.Landing

AI_AIR_SQUADRON.Name

AI_AIR_SQUADRON:New(SquadronName, AirbaseName, TemplatePrefixes, ResourceCount)

Creates a new AI_AIR_SQUADRON object

AI_AIR_SQUADRON.Overhead

AI_AIR_SQUADRON.RadioFrequency

AI_AIR_SQUADRON.RadioModulation

AI_AIR_SQUADRON.RadioPower

AI_AIR_SQUADRON.RadioSpeech

AI_AIR_SQUADRON:RemoveResources(Resources)

Remove Resources to the Squadron.

AI_AIR_SQUADRON.ResourceCount

AI_AIR_SQUADRON:SetEngageProbability(EngageProbability)

Set the EngageProbability of the Squadron.

AI_AIR_SQUADRON:SetFuelThreshold(FuelThreshold)

Set the FuelThreshold of the Squadron.

AI_AIR_SQUADRON:SetGrouping(Grouping)

Set the Grouping of the Squadron.

AI_AIR_SQUADRON:SetLanding(Landing)

Set the Landing of the Squadron.

AI_AIR_SQUADRON:SetName(Name)

Set the Name of the Squadron.

AI_AIR_SQUADRON:SetOverhead(Overhead)

Set the Overhead of the Squadron.

AI_AIR_SQUADRON:SetRadio(RadioFrequency, RadioModulation, RadioPower, Language)

Set the Radio of the Squadron.

AI_AIR_SQUADRON:SetResourceCount(ResourceCount)

Set the ResourceCount of the Squadron.

AI_AIR_SQUADRON:SetTakeoff(Takeoff)

Set the Takeoff of the Squadron.

AI_AIR_SQUADRON:SetTankerName(TankerName)

Set the TankerName of the Squadron.

AI_AIR_SQUADRON.Spawn

AI_AIR_SQUADRON.Takeoff

AI_AIR_SQUADRON.TankerName

AI_AIR_SQUADRON.TemplatePrefixes

Field(s)

#boolean AI_AIR_SQUADRON.Captured

Not captured. This flag will be set to true, when the airbase where the squadron is located, is captured.

Function(s)

Add Resources to the Squadron.

Defined in:

AI_AIR_SQUADRON

Parameter:

#number Resources

The Resources to be added.

Return value:

The Squadron.

Get the EngageProbability of the Squadron.

Defined in:

AI_AIR_SQUADRON

Return value:

#number:

The Squadron EngageProbability.

Get the FuelThreshold of the Squadron.

Defined in:

AI_AIR_SQUADRON

Return value:

#number:

The Squadron FuelThreshold.

Get the Grouping of the Squadron.

Defined in:

AI_AIR_SQUADRON

Return value:

#number:

The Squadron Grouping.

Get the Landing of the Squadron.

Defined in:

AI_AIR_SQUADRON

Return value:

#number:

The Squadron Landing.

Get the Name of the Squadron.

Defined in:

AI_AIR_SQUADRON

Return value:

#string:

The Squadron Name.

Get the Overhead of the Squadron.

Defined in:

AI_AIR_SQUADRON

Return value:

#number:

The Squadron Overhead.

Get the ResourceCount of the Squadron.

Defined in:

AI_AIR_SQUADRON

Return value:

#number:

The Squadron ResourceCount.

Get the Takeoff of the Squadron.

Defined in:

AI_AIR_SQUADRON

Return value:

#number:

The Squadron Takeoff.

Get the Tanker Name of the Squadron.

Defined in:

AI_AIR_SQUADRON

Return value:

#string:

The Squadron Tanker Name.

Creates a new AI_AIR_SQUADRON object

Defined in:

AI_AIR_SQUADRON

Parameters:

SquadronName

AirbaseName

TemplatePrefixes

ResourceCount

Return value:

Remove Resources to the Squadron.

Defined in:

AI_AIR_SQUADRON

Parameter:

#number Resources

The Resources to be removed.

Return value:

The Squadron.

Set the EngageProbability of the Squadron.

Defined in:

AI_AIR_SQUADRON

Parameter:

#number EngageProbability

The Squadron EngageProbability.

Return value:

The Squadron.

Set the FuelThreshold of the Squadron.

Defined in:

AI_AIR_SQUADRON

Parameter:

#number FuelThreshold

The Squadron FuelThreshold.

Return value:

The Squadron.

Set the Grouping of the Squadron.

Defined in:

AI_AIR_SQUADRON

Parameter:

#number Grouping

The Squadron Grouping.

Return value:

The Squadron.

Set the Landing of the Squadron.

Defined in:

AI_AIR_SQUADRON

Parameter:

#number Landing

The Squadron Landing.

Return value:

The Squadron.

Set the Name of the Squadron.

Defined in:

AI_AIR_SQUADRON

Parameter:

#string Name

The Squadron Name.

Return value:

The Squadron.

Set the Overhead of the Squadron.

Defined in:

AI_AIR_SQUADRON

Parameter:

#number Overhead

The Squadron Overhead.

Return value:

The Squadron.

Set the Radio of the Squadron.

Defined in:

AI_AIR_SQUADRON

Parameters:

#number RadioFrequency

The frequency of communication.

#number RadioModulation

The modulation of communication.

#number RadioPower

The power in Watts of communication.

#string Language

The language of the radio speech.

Return value:

The Squadron.

Set the ResourceCount of the Squadron.

Defined in:

AI_AIR_SQUADRON

Parameter:

#number ResourceCount

The Squadron ResourceCount.

Return value:

The Squadron.

Set the Takeoff of the Squadron.

Defined in:

AI_AIR_SQUADRON

Parameter:

#number Takeoff

The Squadron Takeoff.

Return value:

The Squadron.

Set the TankerName of the Squadron.

Defined in:

AI_AIR_SQUADRON

Parameter:

#string TankerName

The Squadron Tanker Name.

Return value:

The Squadron.