Banner Image

Module AI.AI_Escort_Dispatcher

AI - Models the automatic assignment of AI escorts to player flights.

Features:

--
* Provides the facilities to trigger escorts when players join flight slots. *


Author: FlightControl


Global(s)

Global AI_ESCORT_DISPATCHER

Models the automatic assignment of AI escorts to player flights.

#AI_ESCORT_DISPATCHER AI_ESCORT_DISPATCHER

Models the automatic assignment of AI escorts to player flights.

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)

Field(s)

#table AI_ESCORT_DISPATCHER.AI_Escorts

@field #list

Function(s)

Creates a new AI_ESCORT_DISPATCHER object.

Defined in:

AI_ESCORT_DISPATCHER

Parameters:

Core.Set#SET_GROUP CarrierSet

The set of Wrapper.Group#GROUP objects of carriers for which escorts are spawned in.

Core.Spawn#SPAWN EscortSpawn

The spawn object that will spawn in the Escorts.

Wrapper.Airbase#AIRBASE EscortAirbase

The airbase where the escorts are spawned.

#string EscortName

Name of the escort, which will also be the name of the escort menu.

#string EscortBriefing

A text showing the briefing to the player. Note that if no EscortBriefing is provided, the default briefing will be shown.

Return value:

Usage:


-- Create a new escort when a player joins an SU-25T plane.
Create a carrier set, which contains the player slots that can be joined by the players, for which escorts will be defined.
local Red_SU25T_CarrierSet = SET_GROUP:New():FilterPrefixes( "Red A2G Player Su-25T" ):FilterStart()

-- Create a spawn object that will spawn in the escorts, once the player has joined the player slot.
local Red_SU25T_EscortSpawn = SPAWN:NewWithAlias( "Red A2G Su-25 Escort", "Red AI A2G SU-25 Escort" ):InitLimit( 10, 10 )

-- Create an airbase object, where the escorts will be spawned.
local Red_SU25T_Airbase = AIRBASE:FindByName( AIRBASE.Caucasus.Maykop_Khanskaya )

-- Park the airplanes at the airbase, visible before start.
Red_SU25T_EscortSpawn:ParkAtAirbase( Red_SU25T_Airbase, AIRBASE.TerminalType.OpenMedOrBig )

-- New create the escort dispatcher, using the carrier set, the escort spawn object at the escort airbase.
-- Provide a name of the escort, which will be also the name appearing on the radio menu for the group.
-- And a briefing to appear when the player joins the player slot.
Red_SU25T_EscortDispatcher = AI_ESCORT_DISPATCHER:New( Red_SU25T_CarrierSet, Red_SU25T_EscortSpawn, Red_SU25T_Airbase, "Escort Su-25", "You Su-25T is escorted by one Su-25. Use the radio menu to control the escorts." )

-- The dispatcher needs to be started using the :Start() method.
Red_SU25T_EscortDispatcher:Start()

@param #AI_ESCORT_DISPATCHER self @param Core.Event#EVENTDATA EventData

Defined in:

AI_ESCORT_DISPATCHER

Parameter:

EventData

@param #AI_ESCORT_DISPATCHER self @param Core.Event#EVENTDATA EventData

Defined in:

AI_ESCORT_DISPATCHER

Parameter:

EventData

Start Trigger for AI_ESCORT_DISPATCHER

Defined in:

AI_ESCORT_DISPATCHER

Stop Trigger for AI_ESCORT_DISPATCHER

Defined in:

AI_ESCORT_DISPATCHER

Start Asynchronous Trigger for AI_ESCORT_DISPATCHER

Defined in:

AI_ESCORT_DISPATCHER

Parameter:

#number Delay

Stop Asynchronous Trigger for AI_ESCORT_DISPATCHER

Defined in:

AI_ESCORT_DISPATCHER

Parameter:

#number Delay

Defined in:

AI_ESCORT_DISPATCHER

Parameters:

From

Event

To