Banner Image

Module Ops.Legion

Ops - Legion Warehouse.

Parent class of Airwings, Brigades and Fleets.


Author: funkyfranky


Global(s)

Global LEGION

Per aspera ad astra.


The LEGION Concept

The LEGION class contains all functions that are common for the AIRWING, BRIGADE and FLEET classes, which inherit the LEGION class.

#LEGION LEGION

Per aspera ad astra.


The LEGION Concept

The LEGION class contains all functions that are common for the AIRWING, BRIGADE and FLEET classes, which inherit the LEGION class.

An LEGION consists of multiple COHORTs. These cohorts "live" in a WAREHOUSE, i.e. a physical structure that can be destroyed or captured.

* The LEGION class is not meant to be used directly. Use AIRWING, BRIGADE or FLEET instead! *

Type(s)

Fields and Methods inherited from LEGION Description

LEGION:AddCohort(Cohort)

Add cohort to cohort table of this legion.

LEGION:AddMission(Mission)

Add a mission for the legion.

LEGION:AddOpsTransport(OpsTransport)

Add transport assignment to queue.

LEGION:AssignAssetsForEscort(Cohorts, Assets, NescortMin, NescortMax, MissionType, TargetTypes, EngageRange)

Recruit and assign assets performing an escort mission for a given asset list.

LEGION:AssignAssetsForTransport(Legions, CargoAssets, NcarriersMin, NcarriersMax, DeployZone, DisembarkZone, Categories, Attributes, Properties)

Recruit and assign assets performing an OPSTRANSPORT for a given asset list.

LEGION.CalculateAssetMissionScore(asset, MissionType, TargetVec2, IncludePayload)

Calculate the mission score of an asset.

LEGION:CheckMissionQueue()

Check mission queue and assign ONE mission.

LEGION:CheckTransportQueue()

Check transport queue and assign ONE transport.

LEGION.ClassName

Name of the class.

LEGION:CountAssets(InStock, MissionTypes, Attributes)

Count total number of assets of the legion.

LEGION:CountAssetsOnMission(MissionTypes, Cohort)

Count assets on mission.

LEGION:CountAssetsWithPayloadsInStock(Payloads, MissionTypes, Attributes)

Count total number of assets in LEGION warehouse stock that also have a payload.

LEGION:CountMissionsInQueue(MissionTypes)

Count missions in mission queue.

LEGION:CountPayloadsInStock(MissionTypes, UnitTypes, Payloads)

Count payloads in stock.

LEGION:DelCohort(Cohort)

Remove cohort from cohor table of this legion.

LEGION:FetchPayloadFromStock(UnitType, MissionType, Payloads)

Fetch a payload from the airwing resources for a given unit and mission type.

LEGION:GetAircraftTypes(onlyactive, cohorts)

Get the unit types of this legion.

LEGION:GetAssetCurrentMission(asset)

Get the current mission of the asset.

LEGION:GetAssetsOnMission(MissionTypes)

Count assets on mission.

LEGION:GetMissionByID(mid)

Returns the mission for a given mission ID (Autragsnummer).

LEGION:GetMissionFromRequest(Request)

Returns the mission for a given request.

LEGION:GetMissionFromRequestID(RequestID)

Returns the mission for a given request ID.

LEGION:GetName()

Get name of legion.

LEGION:GetOpsGroups(MissionTypes, Attributes)

Get OPSGROUPs that are spawned and alive.

LEGION:GetTransportByID(uid)

Returns the mission for a given ID.

LEGION:IsAirwing()

Check if the AIRWING class is calling.

LEGION:IsAssetOnMission(asset, MissionTypes)

Check if an asset is currently on a mission (STARTED or EXECUTING).

LEGION:IsBrigade()

Check if a BRIGADE class is calling.

LEGION:IsCohort(CohortName)

Check if cohort is part of this legion.

LEGION:IsFleet()

Check if the FLEET class is calling.

LEGION:LegionAssetReturned(Cohort, Asset)

Triggers the FSM event "LegionAssetReturned".

LEGION:MissionAssign(Mission, Legions)

Triggers the FSM event "MissionAssign".

LEGION:MissionCancel(Mission)

Triggers the FSM event "MissionCancel".

LEGION:MissionRequest(Mission)

Triggers the FSM event "MissionRequest".

LEGION:New(WarehouseName, LegionName)

Create a new LEGION class object.

LEGION:OnAfterLegionAssetReturned(From, Event, To, Cohort, Asset)

On after "LegionAssetReturned" event.

LEGION:OnAfterMissionAssign(From, Event, To, Mission, Legions)

On after "MissionAssign" event.

LEGION:OnAfterMissionCancel(From, Event, To, Mission)

On after "MissionCancel" event.

LEGION:OnAfterMissionRequest(From, Event, To, Mission)

On after "MissionRequest" event.

LEGION:OnAfterOpsOnMission(From, Event, To, OpsGroup, Mission)

On after "OpsOnMission" event.

LEGION:OnAfterTransportAssign(From, Event, To, Transport, Legions)

On after "TransportAssign" event.

LEGION:OnAfterTransportCancel(From, Event, To, Transport)

On after "TransportCancel" event.

LEGION:OnAfterTransportRequest(From, Event, To, Transport)

On after "TransportRequest" event.

LEGION:OpsOnMission(OpsGroup, Mission)

Triggers the FSM event "OpsOnMission".

LEGION:RecruitAssetsForEscort(Mission, Assets)

Recruit assets performing an escort mission for a given asset.

LEGION:RecruitAssetsForMission(Mission)

Recruit assets for a given mission.

LEGION:RecruitAssetsForTransport(Transport)

Recruit assets for a given OPS transport.

LEGION.RecruitCohortAssets(Cohorts, MissionTypeRecruit, MissionTypeOpt, NreqMin, NreqMax, TargetVec2, Payloads, RangeMax, RefuelSystem, CargoWeight, TotalWeight, Categories, Attributes, Properties, WeaponTypes)

Recruit assets from Cohorts for the given parameters.

LEGION:RelocateCohort(Cohort, Legion, Delay, NcarriersMin, NcarriersMax, TransportLegions)

Relocate a cohort to another legion.

LEGION:RemoveMission(Mission)

Remove mission from queue.

LEGION:ReturnPayloadFromAsset(asset)

Return payload from asset back to stock.

LEGION:SetVerbosity(VerbosityLevel)

Set verbosity level.

LEGION:Start()

Triggers the FSM event "Start".

LEGION:TransportAssign(Transport, Legions)

Triggers the FSM event "TransportAssign".

LEGION:TransportCancel(Transport)

Triggers the FSM event "TransportCancel".

LEGION:TransportRequest(Transport)

Triggers the FSM event "TransportRequest".

LEGION.UnRecruitAssets(Assets, Mission)

Unrecruit assets.

LEGION:_CountPayloads(MissionType, Cohorts, Payloads)

Count payloads of all cohorts for all unit types.

LEGION:_CreateFlightGroup(asset)

Create a new flight group after an asset was spawned.

LEGION:_GetCohort(CohortName)

Get cohort by name.

LEGION:_GetCohortOfAsset(Asset)

Get cohort of an asset.

LEGION._OptimizeAssetSelection(assets, MissionType, TargetVec2, IncludePayload)

Optimize chosen assets for the mission at hand.

LEGION:__LegionAssetReturned(delay, Cohort, Asset)

Triggers the FSM event "LegionAssetReturned" after a delay.

LEGION:__MissionAssign(delay, Mission, Legions)

Triggers the FSM event "MissionAssign" after a delay.

LEGION:__MissionCancel(delay, Mission)

Triggers the FSM event "MissionCancel" after a delay.

LEGION:__MissionRequest(delay, Mission)

Triggers the FSM event "MissionRequest" after a delay.

LEGION:__OpsOnMission(delay, OpsGroup, Mission)

Triggers the FSM event "OpsOnMission" after a delay.

LEGION:__Start(delay)

Triggers the FSM event "Start" after a delay.

LEGION:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

LEGION:__TransportAssign(delay, Transport, Legions)

Triggers the FSM event "TransportAssign" after a delay.

LEGION:__TransportCancel(delay, Transport)

Triggers the FSM event "TransportCancel" after a delay.

LEGION:__TransportRequest(delay, Transport)

Triggers the FSM event "TransportRequest" after a delay.

LEGION.chief

Chief of this legion.

LEGION.cohorts

Cohorts of this legion.

LEGION.commander

Commander of this legion.

LEGION.homebase

LEGION.homezone

LEGION.lid

Class id string for output to DCS log file.

LEGION.missionqueue

Mission queue table.

LEGION:onafterAssetDead(From, Event, To, asset, request)

On after "AssetDead" event triggered when an asset group died.

LEGION:onafterAssetSpawned(From, Event, To, group, asset, request)

On after "AssetSpawned" event triggered when an asset group is spawned into the cruel world.

LEGION:onafterCaptured(From, Event, To, Coalition, Country)

On after "Captured" event.

LEGION:onafterDestroyed(From, Event, To)

On after "Destroyed" event.

LEGION:onafterLegionAssetReturned(From, Event, To, Cohort, Asset)

On after "LegionAssetReturned" event.

LEGION:onafterMissionAssign(From, Event, To, Mission, Legions)

On after "MissionAssign" event.

LEGION:onafterMissionCancel(From, Event, To, Mission)

On after "MissionCancel" event.

LEGION:onafterMissionRequest(From, Event, To, Mission)

On after "MissionRequest" event.

LEGION:onafterNewAsset(From, Event, To, asset, assignment)

On after "NewAsset" event.

LEGION:onafterOpsOnMission(From, Event, To, OpsGroup, Mission)

On after "OpsOnMission".

LEGION:onafterRequest(From, Event, To, Request)

On after "Request" event.

LEGION:onafterRequestSpawned(From, Event, To, Request, CargoGroupSet, TransportGroupSet)

On after "RequestSpawned" event.

LEGION:onafterSelfRequest(From, Event, To, groupset, request)

On after "SelfRequest" event.

LEGION:onafterStart(From, Event, To)

Start LEGION FSM.

LEGION:onafterTransportAssign(From, Event, To, Transport, Legions)

On after "TransportAssign" event.

LEGION:onafterTransportCancel(From, Event, To, Transport)

On after "TransportCancel" event.

LEGION:onafterTransportRequest(From, Event, To, Opstransport, OpsTransport)

On after "TransportRequest" event.

LEGION.transportqueue

Transport queue.

LEGION.verbose

Verbosity of output.

LEGION.version

LEGION class version.

Fields and Methods inherited from WAREHOUSE Description

LEGION:AddAsset(group, ngroups, forceattribute, forcecargobay, forceweight, loadradius, skill, liveries, assignment)

Trigger the FSM event "AddAsset".

LEGION:AddOffRoadPath(remotewarehouse, group, oneway)

Add an off-road path from this warehouse to another and back.

LEGION:AddRequest(warehouse, AssetDescriptor, AssetDescriptorValue, nAsset, TransportType, nTransport, Prio, Assignment)

Triggers the FSM event "AddRequest".

LEGION:AddShippingLane(remotewarehouse, group, oneway)

Add a shipping lane from this warehouse to another remote warehouse.

LEGION:AirbaseCaptured(Coalition)

Triggers the FSM event "AirbaseCaptured" when the airbase of the warehouse has been captured by another coalition.

LEGION:AirbaseRecaptured(Coalition)

Triggers the FSM event "AirbaseRecaptured" when the airbase of the warehouse has been re-captured from the other coalition.

LEGION:Arrived(group)

Triggers the FSM event "Arrived" when a group has arrived at the destination warehouse.

LEGION:AssetDead(asset, request)

Triggers the FSM event "AssetDead" when an asset group has died.

LEGION:AssetLowFuel(asset, request)

Triggers the FSM event "AssetLowFuel" when an asset runs low on fuel

LEGION:AssetSpawned(group, asset, request)

Triggers the FSM event "AssetSpawned" when the warehouse has spawned an asset.

LEGION:Attacked(Coalition, Country)

Triggers the FSM event "Attacked" when a warehouse is under attack by an another coalition.

LEGION.Attribute

LEGION:Captured(Coalition, Country)

Triggers the FSM event "Captured" when a warehouse has been captured by another coalition.

LEGION:ChangeCountry(Country)

Triggers the FSM event "ChangeCountry" so the warehouse is respawned with the new country.

LEGION.ClassName

Name of the class.

LEGION.Debug

If true, send debug messages to all.

LEGION:Defeated()

Triggers the FSM event "Defeated" when an attack from an enemy was defeated.

LEGION:Delivered(request)

Triggers the FSM event "Delivered".

LEGION.Descriptor

LEGION:Destroyed()

Triggers the FSM event "Destroyed" when the warehouse was destroyed.

LEGION:FilterStock(descriptor, attribute, nmax, mobile)

Filter stock assets by descriptor and attribute.

LEGION:FindAssetInDB(group)

Find an asset in the the global warehouse data base.

LEGION:FindNearestWarehouse(MinAssets, Descriptor, DescriptorValue, Coalition, RefCoordinate)

Find nearest warehouse in service, i.e.

LEGION:FindWarehouseInDB(uid)

Find a warehouse in the global warehouse data base.

LEGION:GetAirbase()

Get airbase associated to the warehouse.

LEGION:GetAirbaseCategory()

Get category of airbase associated to the warehouse.

LEGION:GetAirbaseName()

Get name airbase associated to the warehouse.

LEGION:GetAssetByID(id)

Get a warehouse asset from its unique id.

LEGION:GetAssetByName(GroupName)

Get a warehouse asset from its name.

LEGION:GetAssignment(request)

Get assignment of a request.

LEGION:GetCoalition()

Get coalition side of warehouse static.

LEGION:GetCoalitionName()

Get coalition name of warehouse static.

LEGION:GetCoordinate()

Get coordinate of warehouse static.

LEGION:GetCountry()

Get country id of warehouse static.

LEGION:GetCountryName()

Get country name of warehouse static.

LEGION:GetNumberOfAssets(Descriptor, DescriptorValue, OnlyMobile)

Get number of assets in warehouse stock.

LEGION:GetRequestByID(id)

Get a warehouse request from its unique id.

LEGION:GetRunwayRepairtime()

Check if runway is operational.

LEGION:GetSpawnZone()

Get the spawn zone.

LEGION:GetStockInfo(stock)

Returns the number of assets for each generalized attribute.

LEGION:GetVec2()

Get 2D vector of warehouse static.

LEGION:GetVec3()

Get 3D vector of warehouse static.

LEGION:GetWarehouseZone()

Get the warehouse zone.

LEGION:HasConnectionNaval(warehouse, markpath, smokepath)

Check if the warehouse has a shipping lane defined to another warehouse.

LEGION:HasConnectionOffRoad(warehouse, markpath, smokepath)

Check if the warehouse has an off road path defined to another warehouse.

LEGION:HasConnectionRail(warehouse, markpath, smokepath)

Check if the warehouse has a railroad connection to another warehouse.

LEGION:HasConnectionRoad(warehouse, markpath, smokepath)

Check if the warehouse has a road connection to another warehouse.

LEGION:IsAttacked()

Check if the warehouse is under attack by another coalition.

LEGION:IsDestroyed()

Check if the warehouse has been destroyed.

LEGION:IsLoaded()

Check if the warehouse has been loaded from disk via the "Load" event.

LEGION:IsNotReadyYet()

Check if the warehouse has not been started yet, i.e.

LEGION:IsPaused()

Check if the warehouse is paused.

LEGION:IsRunning()

Check if the warehouse is running.

LEGION:IsRunwayOperational()

Check if runway is operational.

LEGION:IsShip()

Check if warehouse physical representation is a ship.

LEGION:IsStatic()

Check if warehouse physical representation is a static (not a unit) object.

LEGION:IsStopped()

Check if the warehouse is stopped.

LEGION:IsUnit()

Check if warehouse physical representation is a unit (not a static) object.

LEGION:Load(path, filename)

Triggers the FSM event "Load" when the warehouse is loaded from a file on disk.

LEGION:New(warehouse, alias)

The WAREHOUSE constructor.

LEGION:NewAsset(asset, assignment)

Triggers the FSM delayed event "NewAsset" when a new asset has been added to the warehouse stock.

LEGION:OnAfterAirbaseCaptured(From, Event, To, Coalition)

On after "AirbaseCaptured" even user function.

LEGION:OnAfterAirbaseRecaptured(From, Event, To, Coalition)

On after "AirbaseRecaptured" event user function.

LEGION:OnAfterArrived(From, Event, To, group)

On after "Arrived" event user function.

LEGION:OnAfterAssetDead(From, Event, To, asset, request)

On after "AssetDead" event user function.

LEGION:OnAfterAssetLowFuel(From, Event, To, asset, request)

On after "AssetLowFuel" event user function.

LEGION:OnAfterAssetSpawned(From, Event, To, group, asset, request)

On after "AssetSpawned" event user function.

LEGION:OnAfterAttacked(From, Event, To, Coalition, Country)

On after "Attacked" event user function.

LEGION:OnAfterCaptured(From, Event, To, Coalition, Country)

On after "Captured" event user function.

LEGION:OnAfterChangeCountry(From, Event, To, Country)

On after "ChangeCountry" event user function.

LEGION:OnAfterDefeate(From, Event, To)

On after "Defeated" event user function.

LEGION:OnAfterDelivered(From, Event, To, request)

On after "Delivered" event user function.

LEGION:OnAfterDestroyed(From, Event, To)

On after "Destroyed" event user function.

LEGION:OnAfterLoad(From, Event, To, path, filename)

On after "Load" event user function.

LEGION:OnAfterNewAsset(From, Event, To, asset, assignment)

On after "NewAsset" event user function.

LEGION:OnAfterRequest(From, Event, To, Request)

On after "Request" user function.

LEGION:OnAfterRespawn(From, Event, To)

On after "Respawn" event user function.

LEGION:OnAfterSave(From, Event, To, path, filename)

On after "Save" event user function.

LEGION:OnAfterSelfRequest(From, Event, To, groupset, request)

On after "SelfRequest" event.

LEGION:OnBeforeRequest(From, Event, To, Request)

On before "Request" user function.

LEGION:Pause()

Triggers the FSM event "Pause".

LEGION.Quantity

LEGION.Report

If true, send status messages to coalition.

LEGION:Request(Request)

Triggers the FSM event "Request".

LEGION:Respawn()

Triggers the FSM event "Respawn".

LEGION:Restart()

Triggers the FSM event "Restart".

LEGION:Save(path, filename)

Triggers the FSM event "Save" when the warehouse assets are saved to file on disk.

LEGION:SelfRequest(groupset, request)

Triggers the FSM event "SelfRequest".

LEGION:SetAirbase(airbase)

Set the airbase belonging to this warehouse.

LEGION:SetAllowSpawnOnClientParking()

Set wether client parking spots can be used for spawning.

LEGION:SetAutoDefenceOff()

Set auto defence off.

LEGION:SetAutoDefenceOn()

Set auto defence on.

LEGION:SetDebugOff()

Set debug mode off.

LEGION:SetDebugOn()

Set debug mode on.

LEGION:SetHarborZone(zone)

Add a Harbor Zone for this warehouse where naval cargo units will spawn and be received.

LEGION:SetLowFuelThreshold(threshold)

Set low fuel threshold.

LEGION:SetMarker(switch)

Show or don't show markers on the F10 map displaying the Warehouse stock and road/rail connections.

LEGION:SetParkingIDs(ParkingIDs)

Set valid parking spot IDs.

LEGION:SetPortZone(zone)

Set the port zone for this warehouse.

LEGION:SetRailConnection(coordinate)

Set the connection of the warehouse to the railroad.

LEGION:SetReportOff()

Set report off.

LEGION:SetReportOn()

Set report on.

LEGION:SetRespawnAfterDestroyed(delay)

Set respawn after destroy.

LEGION:SetRoadConnection(coordinate)

Set the connection of the warehouse to the road.

LEGION:SetRunwayRepairtime(RepairTime)

Set the time until the runway(s) of an airdrome are repaired after it has been destroyed.

LEGION:SetSafeParkingOff()

Disable safe parking option.

LEGION:SetSafeParkingOn()

Enable safe parking option, i.e.

LEGION:SetSaveOnMissionEnd(path, filename)

Enable auto save of warehouse assets at mission end event.

LEGION:SetSpawnZone(zone, maxdist)

Set a zone where the (ground) assets of the warehouse are spawned once requested.

LEGION:SetStatusUpdate(timeinterval)

Set interval of status updates.

LEGION:SetVerbosityLevel(VerbosityLevel)

Set verbosity level.

LEGION:SetWarehouseZone(zone)

Set a warehouse zone.

LEGION:Start()

Triggers the FSM event "Start".

LEGION:Status()

Triggers the FSM event "Status".

LEGION:Stop()

Triggers the FSM event "Stop".

LEGION.TransportType

LEGION:UnPause()

Triggers the FSM event "Unpause".

LEGION:_Arrived(group)

Task function for last waypoint.

LEGION:_AssetItemInfo(asset)

Asset item characteristics.

LEGION:_CheckAirbaseOwner()

Checks if the associated airbase still belongs to the warehouse.

LEGION:_CheckAssetStatus()

Function that checks if an asset group is still okay.

LEGION:_CheckConquered()

Checks if the warehouse zone was conquered by antoher coalition.

LEGION:_CheckFuel()

Checks fuel on all pening assets.

LEGION:_CheckParkingAsset(spot, asset)

Check parking ID for an asset.

LEGION:_CheckParkingValid(spot)

Check parking ID.

LEGION:_CheckQueue()

Sorts the queue and checks if the request can be fulfilled.

LEGION:_CheckRequestConsistancy(queue)

Checks if the request can be fulfilled in general.

LEGION:_CheckRequestNow(request)

Checks if the request can be fulfilled right now.

LEGION:_CheckRequestValid(request)

Check if a request is valid in general.

LEGION:_DebugMessage(text, duration)

Debug message.

LEGION:_DeleteQueueItem(qitem, queue)

Delete item from queue.

LEGION:_DeleteQueueItemByID(qitemID, queue)

Delete item from queue.

LEGION:_DeleteStockItem(stockitem)

Delete an asset item from stock.

LEGION:_DisplayStatus()

Display status of warehouse.

LEGION:_DisplayStockItems(stock)

Display stock items of warehouse.

LEGION:_ErrorMessage(text, duration)

Error message.

LEGION:_FilterStock(stock, descriptor, attribute, nmax, mobile)

Filter stock assets by table entry.

LEGION:_FindParkingForAssets(airbase, assets)

Seach unoccupied parking spots at the airbase for a list of assets.

LEGION:_Fireworks(coord)

Fireworks!

LEGION:_GetAttribute(group)

Get the generalized attribute of a group.

LEGION:_GetFlightplan(asset, departure, destination)

Make a flight plan from a departure to a destination airport.

LEGION:_GetIDsFromGroup(group)

Get warehouse id, asset id and request id from group name (alias).

LEGION:_GetIDsFromGroupName(groupname)

Get warehouse id, asset id and request id from group name (alias).

LEGION:_GetMaxHeight(D, alphaC, alphaD, Hdep, Hdest, Deltahhold)

Calculate the maximum height an aircraft can reach for the given parameters.

LEGION:_GetNameWithOut(group)

Get group name without any spawn or cargo suffix #CARGO etc.

LEGION:_GetObjectSize(DCSobject)

Size of the bounding box of a DCS object derived from the DCS descriptor table.

LEGION:_GetRequestOfGroup(group, queue)

Get the request belonging to a group.

LEGION:_GetStockAssetsText(messagetoall)

Get text about warehouse stock.

LEGION:_GetTerminal(_attribute, _category)

Get the proper terminal type based on generalized attribute of the group.

LEGION:_GetTransportsForAssets(Chosen, request)

Get (optimized) transport carriers for the given assets to be transported.

LEGION:_GroupIsTransport(group, request)

Is the group a used as transporter for a given request?

LEGION:_HasAttribute(group, attribute)

Check if a group has a generalized attribute.

LEGION:_InfoMessage(text, duration)

Info Message.

LEGION:_JobDone()

Function that checks if a pending job is done and can be removed from queue.

LEGION:_NewLane(group, startcoord, finalcoord)

Create a new path from a template group.

LEGION:_OnEventArrived(EventData)

Arrived event if an air unit/group arrived at its destination.

LEGION:_OnEventBaseCaptured(EventData)

Warehouse event handling function.

LEGION:_OnEventBirth(EventData)

Warehouse event function, handling the birth of a unit.

LEGION:_OnEventCrashOrDead(EventData)

Warehouse event handling function.

LEGION:_OnEventEngineShutdown(EventData)

Function handling the event when a (warehouse) unit shuts down its engines.

LEGION:_OnEventEngineStartup(EventData)

Function handling the event when a (warehouse) unit starts its engines.

LEGION:_OnEventLanding(EventData)

Function handling the event when a (warehouse) unit lands.

LEGION:_OnEventMissionEnd(EventData)

Warehouse event handling function.

LEGION:_OnEventTakeOff(EventData)

Function handling the event when a (warehouse) unit takes off.

LEGION:_PassingWaypoint(group, n, N)

Task function for when passing a waypoint.

LEGION:_PrintQueue(queue, name)

Prints the queue to DCS.log file.

LEGION:_QuantityRel2Abs(relative, ntot)

Relative to absolute quantity.

LEGION:_RegisterAsset(group, ngroups, forceattribute, forcecargobay, forceweight, loadradius, liveries, skill, assignment)

Register new asset in globase warehouse data base.

LEGION:_RouteAir(aircraft)

Route the airplane from one airbase another.

LEGION:_RouteGround(group, request)

Route ground units to destination.

LEGION:_RouteNaval(group, request)

Route naval units along user defined shipping lanes to destination warehouse.

LEGION:_RouteTrain(Group, Coordinate, Speed)

Route trains to their destination - or at least to the closest point on rail of the desired final destination.

LEGION:_SimpleTaskFunction(Function, group)

Simple task function.

LEGION:_SimpleTaskFunctionWP(Function, group, n, N)

Simple task function.

LEGION:_SortQueue()

Sort requests queue wrt prio and request uid.

LEGION:_SpawnAssetAircraft(alias, asset, request, parking, uncontrolled, lateactivated)

Spawn an aircraft asset (plane or helo) at the airbase associated with the warehouse.

LEGION:_SpawnAssetGroundNaval(alias, asset, request, spawnzone, lateactivated)

Spawn a ground or naval asset in the corresponding spawn zone of the warehouse.

LEGION:_SpawnAssetPrepareTemplate(asset, alias)

Prepare a spawn template for the asset.

LEGION:_SpawnAssetRequest(Request)

Spawns requested assets at warehouse or associated airbase.

LEGION:_UnitDead(deadunit, deadgroup, request)

A unit of a group just died.

LEGION:_UpdateWarehouseMarkText()

Create or update mark text at warehouse, which is displayed in F10 map showing how many assets of each type are in stock.

LEGION:__AddAsset(delay, group, ngroups, forceattribute, forcecargobay, forceweight, loadradius, skill, liveries, assignment)

Trigger the FSM event "AddAsset" with a delay.

LEGION:__AddRequest(delay, warehouse, AssetDescriptor, AssetDescriptorValue, nAsset, TransportType, nTransport, Prio, Assignment)

Triggers the FSM event "AddRequest" with a delay.

LEGION:__AirbaseCaptured(delay, Coalition)

Triggers the FSM event "AirbaseCaptured" with a delay when the airbase of the warehouse has been captured by another coalition.

LEGION:__AirbaseRecaptured(delay, Coalition)

Triggers the FSM event "AirbaseRecaptured" with a delay when the airbase of the warehouse has been re-captured from the other coalition.

LEGION:__Arrived(delay, group)

Triggers the FSM event "Arrived" after a delay when a group has arrived at the destination.

LEGION:__AssetDead(delay, asset, request)

Triggers the delayed FSM event "AssetDead" when an asset group has died.

LEGION:__AssetLowFuel(delay, asset, request)

Triggers the FSM event "AssetLowFuel" with a delay when an asset runs low on fuel.

LEGION:__AssetSpawned(delay, group, asset, request)

Triggers the FSM event "AssetSpawned" with a delay when the warehouse has spawned an asset.

LEGION:__Attacked(delay, Coalition, Country)

Triggers the FSM event "Attacked" with a delay when a warehouse is under attack by an another coalition.

LEGION:__Captured(delay, Coalition, Country)

Triggers the FSM event "Captured" with a delay when a warehouse has been captured by another coalition.

LEGION:__ChangeCountry(delay, Country)

Triggers the FSM event "ChangeCountry" after a delay so the warehouse is respawned with the new country.

LEGION:__Defeated(delay)

Triggers the FSM event "Defeated" with a delay when an attack from an enemy was defeated.

LEGION:__Delivered(delay, request)

Triggers the FSM event "Delivered" after a delay.

LEGION:__Destroyed(delay)

Triggers the FSM event "Destroyed" with a delay when the warehouse was destroyed.

LEGION:__Load(delay, path, filename)

Triggers the FSM event "Load" with a delay when the warehouse assets are loaded from disk.

LEGION:__NewAsset(delay, asset, assignment)

Triggers the FSM delayed event "NewAsset" when a new asset has been added to the warehouse stock.

LEGION:__Pause(delay)

Triggers the FSM event "Pause" after a delay.

LEGION:__Request(Delay, Request)

Triggers the FSM event "Request" after a delay.

LEGION:__Respawn(delay)

Triggers the FSM event "Respawn" after a delay.

LEGION:__Restart(delay)

Triggers the FSM event "Restart" after a delay.

LEGION:__Save(delay, path, filename)

Triggers the FSM event "Save" with a delay when the warehouse assets are saved to a file.

LEGION:__SelfRequest(delay, groupset, request)

Triggers the FSM event "SelfRequest" with a delay.

LEGION:__Start(delay)

Triggers the FSM event "Start" after a delay.

LEGION:__Status(delay)

Triggers the FSM event "Status" after a delay.

LEGION:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

LEGION:__Unpause(delay)

Triggers the FSM event "Unpause" after a delay.

LEGION.airbase

Airbase the warehouse belongs to.

LEGION.airbasename

Name of the airbase associated to the warehouse.

LEGION.alias

Alias of the warehouse. Name its called when sending messages.

LEGION.allowSpawnOnClientSpots

LEGION.autodefence

When the warehouse is under attack, automatically spawn assets to defend the warehouse.

LEGION.autosave

Automatically save assets to file when mission ends.

LEGION.autosavefile

File name of the auto asset save file. Default is auto generated from warehouse id and name.

LEGION.autosavepath

Path where the asset file is saved on auto save.

LEGION.clientcoords

LEGION.coalition

LEGION.countryid

LEGION.dTstatus

Time interval in seconds of updating the warehouse status and processing new events. Default 30 seconds.

LEGION.defending

Table holding all defending requests, i.e. self requests that were if the warehouse is under attack. Table elements are of type WAREHOUSE.Pendingitem.

LEGION.delivered

Table holding all delivered requests. Table elements are #boolean. If true, all cargo has been delivered.

LEGION.flightcontrol

Flight control of this warehouse.

LEGION.harborzone

LEGION.isShip

If true, warehouse is represented by a ship unit.

LEGION.isUnit

If true, warehouse is represented by a unit instead of a static.

LEGION.lid

LEGION.lowfuelthresh

Low fuel threshold. Triggers the event AssetLowFuel if for any unit fuel goes below this number.

LEGION.markerOn

If true, markers are displayed on the F10 map.

LEGION.markerRail

Rail road connection.

LEGION.markerRoad

Road connection.

LEGION.markerWarehouse

Marker warehouse.

LEGION.markerid

ID of the warehouse marker at the airbase.

LEGION.markrail

LEGION.markroad

LEGION.offroadpaths

Table holding user defined paths from one warehouse to another.

LEGION:onafterAddAsset(From, Event, To, group, ngroups, forceattribute, forcecargobay, forceweight, loadradius, skill, liveries, assignment, other)

On after "AddAsset" event.

LEGION:onafterAddRequest(From, Event, To, warehouse, AssetDescriptor, AssetDescriptorValue, nAsset, TransportType, nTransport, Prio, Assignment)

On after "AddRequest" event.

LEGION:onafterAirbaseCaptured(From, Event, To, Coalition)

On after "AirbaseCaptured" event.

LEGION:onafterAirbaseRecaptured(From, Event, To, Coalition)

On after "AirbaseRecaptured" event.

LEGION:onafterArrived(From, Event, To, group)

On after "Arrived" event.

LEGION:onafterAssetDead(From, Event, To, asset, request)

On after "AssetDead" event triggered when an asset group died.

LEGION:onafterAssetSpawned(From, Event, To, group, asset, request)

On after "AssetSpawned" event triggered when an asset group is spawned into the cruel world.

LEGION:onafterAttacked(From, Event, To, Coalition, Country)

On after "Attacked" event.

LEGION:onafterCaptured(From, Event, To, Coalition, Country)

On after "Captured" event.

LEGION:onafterChangeCountry(From, Event, To, Country)

On after "ChangeCountry" event.

LEGION:onafterDefeated(From, Event, To)

On after "Defeated" event.

LEGION:onafterDelivered(From, Event, To, request)

On after "Delivered" event.

LEGION:onafterDestroyed(From, Event, To)

On after "Destroyed" event.

LEGION:onafterLoad(From, Event, To, path, filename)

On after "Load" event.

LEGION:onafterNewAsset(From, Event, To, asset, assignment)

On after "NewAsset" event.

LEGION:onafterPause(From, Event, To)

On after "Pause" event.

LEGION:onafterRequest(From, Event, To, Request)

On after "Request" event.

LEGION:onafterRequestSpawned(From, Event, To, Request, CargoGroupSet, TransportGroupSet)

On after "RequestSpawned" event.

LEGION:onafterRespawn(From, Event, To)

Respawn warehouse.

LEGION:onafterRestart(From, Event, To)

On after "Restart" event.

LEGION:onafterRunwayDestroyed(From, Event, To)

On after "RunwayDestroyed" event.

LEGION:onafterRunwayRepaired(From, Event, To)

On after "RunwayRepaired" event.

LEGION:onafterSave(From, Event, To, path, filename)

On after "Save" event.

LEGION:onafterSelfRequest(From, Event, To, groupset, request)

On after "SelfRequest" event.

LEGION:onafterStart(From, Event, To)

On after Start event.

LEGION:onafterStatus(From, Event, To)

On after Status event.

LEGION:onafterStop(From, Event, To)

On after "Stop" event.

LEGION:onafterUnloaded(From, Event, To, group)

On after "Unloaded" event.

LEGION:onafterUnpause(From, Event, To)

On after "Unpause" event.

LEGION:onbeforeAddRequest(From, Event, To, warehouse, AssetDescriptor, AssetDescriptorValue, nAsset, TransportType, nTransport, Prio, Assignment)

On before "AddRequest" event.

LEGION:onbeforeArrived(From, Event, To, group)

On before "Arrived" event.

LEGION:onbeforeCaptured(From, Event, To, Coalition, Country)

On before "Captured" event.

LEGION:onbeforeChangeCountry(From, Event, To, Country)

On before "ChangeCountry" event.

LEGION:onbeforeLoad(From, Event, To, path, filename)

On before "Load" event.

LEGION:onbeforeRequest(From, Event, To, Request)

On before "Request" event.

LEGION.parkingIDs

LEGION.pending

Table holding all pending requests, i.e. those that are currently in progress. Table elements are of type WAREHOUSE.Pendingitem.

LEGION.portzone

Zone defining the port of a warehouse. This is where naval assets are spawned.

LEGION.queue

Table holding all queued requests. Table entries are of type WAREHOUSE.Queueitem.

LEGION.queueid

Unit id of each request in the queue. Essentially a running number starting at one and incremented when a new request is added.

LEGION.rail

Closest point to warehouse on rail.

LEGION.respawnafterdestroyed

If true, warehouse is respawned after it was destroyed. Assets are kept.

LEGION.respawndelay

Delay before respawn in seconds.

LEGION.road

Closest point to warehouse on road.

LEGION.runwaydestroyed

Time stamp timer.getAbsTime() when the runway was destroyed.

LEGION.runwayrepairtime

Time in seconds until runway will be repaired after it was destroyed. Default is 3600 sec (one hour).

LEGION.safeparking

If true, parking spots for aircraft are considered as occupied if e.g. a client aircraft is parked there. Default false.

LEGION.shippinglanes

Table holding the user defined shipping between warehouses.

LEGION.spawnzone

Zone in which assets are spawned.

LEGION.spawnzonemaxdist

Max distance between warehouse and spawn zone. Default 5000 meters.

LEGION.stock

Table holding all assets in stock. Table entries are of type WAREHOUSE.Assetitem.

LEGION.transporting

Table holding assets currently transporting cargo assets.

LEGION.uid

Unique ID of the warehouse.

LEGION.verbosity

Verbosity level.

LEGION.version

Warehouse class version.

LEGION.warehouse

The phyical warehouse structure.

LEGION.wid

Identifier of the warehouse printed before other output to DCS.log file.

LEGION.zone

Zone around the warehouse. If this zone is captured, the warehouse and all its assets goes to the capturing coalition.

Fields and Methods inherited from FSM Description

LEGION:AddEndState(State)

Adds an End state.

LEGION:AddProcess(From, Event, Process, ReturnEvents)

Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

LEGION:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

LEGION:AddScoreProcess(From, Event, State, ScoreText, Score)

Adds a score for the FSM_PROCESS to be achieved.

LEGION:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

LEGION.CallScheduler

Call scheduler.

LEGION.ClassName

Name of the class.

LEGION.Events

LEGION:GetCurrentState()

Get current state.

LEGION:GetEndStates()

Returns the End states.

LEGION:GetProcess(From, Event)

LEGION:GetProcesses()

Returns a table of the SubFSM rules defined within the FSM.

LEGION:GetScores()

Returns a table with the scores defined.

LEGION:GetStartState()

Returns the start state of the FSM.

LEGION:GetState()

Get current state.

LEGION:GetSubs()

Returns a table with the Subs defined.

LEGION:GetTransitions()

Returns a table of the transition rules defined within the FSM.

LEGION:Is(State)

Check if FSM is in state.

LEGION:LoadCallBacks(CallBackTable)

Load call backs.

LEGION:New()

Creates a new FSM object.

LEGION.Scores

Scores.

LEGION:SetProcess(From, Event, Fsm)

LEGION:SetStartState(State)

Sets the start state of the FSM.

LEGION._EndStates

LEGION._EventSchedules

LEGION._Processes

LEGION._Scores

LEGION._StartState

LEGION._Transitions

LEGION:_add_to_map(Map, Event)

Add to map.

LEGION:_call_handler(step, trigger, params, EventName)

Call handler.

LEGION:_create_transition(EventName)

Create transition.

LEGION:_delayed_transition(EventName)

Delayed transition.

LEGION:_eventmap(Events, EventStructure)

Event map.

LEGION:_gosub(ParentFrom, ParentEvent)

Go sub.

LEGION:_handler(EventName, ...)

Handler.

LEGION:_isendstate(Current)

Is end state.

LEGION:_submap(subs, sub, name)

Sub maps.

LEGION:can(e)

Check if can do an event.

LEGION:cannot(e)

Check if cannot do an event.

LEGION.current

Current state name.

LEGION.endstates

LEGION:is(State, state)

Check if FSM is in state.

LEGION.options

Options.

LEGION.subs

Subs.

Fields and Methods inherited from BASE Description

LEGION.ClassID

The ID number of the class.

LEGION.ClassName

The name of the class.

LEGION.ClassNameAndID

The name of the class concatenated with the ID number of the class.

LEGION:ClearState(Object, StateName)

Clear the state of an object.

LEGION:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

Creation of a Birth Event.

LEGION:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

LEGION:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

LEGION:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

LEGION:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

LEGION:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

LEGION:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

LEGION:E(Arguments)

Log an exception which will be traced always.

LEGION:EventDispatcher()

Returns the event dispatcher

LEGION:EventRemoveAll()

Remove all subscribed events

LEGION:F(Arguments)

Trace a function call.

LEGION:F2(Arguments)

Trace a function call level 2.

LEGION:F3(Arguments)

Trace a function call level 3.

LEGION:GetClassID()

Get the ClassID of the class instance.

LEGION:GetClassName()

Get the ClassName of the class instance.

LEGION:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

LEGION:GetEventPriority()

Get the Class Core.Event processing Priority.

LEGION:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

LEGION:GetState(Object, Key)

Get a Value given a Key from the Object.

LEGION:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

LEGION:I(Arguments)

Log an information which will be traced always.

LEGION:Inherit(Child, Parent)

This is the worker method to inherit from a parent class.

LEGION:IsInstanceOf(ClassName)

This is the worker method to check if an object is an (sub)instance of a class.

LEGION:IsTrace()

Enquires if tracing is on (for the class).

LEGION:New()

BASE constructor.

LEGION:OnEvent(EventData)

Occurs when an Event for an object is triggered.

LEGION:OnEventBDA(EventData)

BDA.

LEGION:OnEventBaseCaptured(EventData)

Occurs when a ground unit captures either an airbase or a farp.

LEGION:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

LEGION:OnEventCrash(EventData)

Occurs when any aircraft crashes into the ground and is completely destroyed.

LEGION:OnEventDead(EventData)

Occurs when an object is dead.

LEGION:OnEventDetailedFailure(EventData)

Unknown precisely what creates this event, likely tied into newer damage model.

LEGION:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

LEGION:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

LEGION:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

LEGION:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

LEGION:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

LEGION:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

LEGION:OnEventKill(EventData)

Occurs on the death of a unit.

LEGION:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.

LEGION:OnEventLandingAfterEjection(EventData)

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

LEGION:OnEventLandingQualityMark(EventData)

Landing quality mark.

LEGION:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

LEGION:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

LEGION:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

LEGION:OnEventMissionEnd(EventData)

Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.

LEGION:OnEventMissionStart(EventData)

Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.

LEGION:OnEventParatrooperLanding(EventData)

Weapon add.

LEGION:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

LEGION:OnEventPlayerEnterAircraft(EventData)

Occurs when a player enters a slot and takes control of an aircraft.

LEGION:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

LEGION:OnEventPlayerLeaveUnit(EventData)

Occurs when any player relieves control of a unit to the AI.

LEGION:OnEventRefueling(EventData)

Occurs when an aircraft connects with a tanker and begins taking on fuel.

LEGION:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

LEGION:OnEventScore(EventData)

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

LEGION:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

LEGION:OnEventShootingStart(EventData)

Occurs when any unit begins firing a weapon that has a high rate of fire.

LEGION:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

LEGION:OnEventTakeoff(EventData)

Occurs when an aircraft takes off from an airbase, farp, or ship.

LEGION:OnEventTriggerZone(EventData)

Trigger zone.

LEGION:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

LEGION:ScheduleOnce(Start, SchedulerFunction, ...)

Schedule a new time event.

LEGION:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

Schedule a new time event.

LEGION:ScheduleStop(SchedulerID)

Stops the Schedule.

LEGION.Scheduler

LEGION:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

LEGION:SetState(Object, Key, Value)

Set a state or property of the Object given a Key and a Value.

LEGION:T(Arguments)

Trace a function logic level 1.

LEGION:T2(Arguments)

Trace a function logic level 2.

LEGION:T3(Arguments)

Trace a function logic level 3.

LEGION:TraceAll(TraceAll)

Trace all methods in MOOSE

LEGION:TraceClass(Class)

Set tracing for a class

LEGION:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

LEGION:TraceLevel(Level)

Set trace level

LEGION:TraceOff()

Set trace off.

LEGION:TraceOn()

Set trace on.

LEGION:TraceOnOff(TraceOnOff)

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

LEGION:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

LEGION._

LEGION:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

LEGION:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

LEGION.__

LEGION:onEvent(event)

The main event handling function...

LEGION class.

Field(s)

#string LEGION.ClassName

Name of the class.

Ops.Chief#CHIEF LEGION.chief

Chief of this legion.

#table LEGION.cohorts

Cohorts of this legion.

Ops.Commander#COMMANDER LEGION.commander

Commander of this legion.

LEGION.homebase

Set home base.

LEGION.homezone

Set home zone.

#string LEGION.lid

Class id string for output to DCS log file.

#table LEGION.missionqueue

Mission queue table.

#table LEGION.transportqueue

Transport queue.

#number LEGION.verbose

Verbosity of output.

#string LEGION.version

LEGION class version.

Function(s)

Add cohort to cohort table of this legion.

Defined in:

LEGION

Parameter:

The cohort to be added.

Return value:

self

Add a mission for the legion.

It will pick the best available assets for the mission and lauch it when ready.

Defined in:

LEGION

Parameter:

Mission for this legion.

Return value:

self

Add transport assignment to queue.

Defined in:

LEGION

Parameter:

Transport assignment.

Return value:

self

Recruit and assign assets performing an escort mission for a given asset list.

Note that each asset gets an escort.

Defined in:

LEGION

Parameters:

#table Cohorts

Cohorts for escorting assets.

#table Assets

Table of assets to be escorted.

#number NescortMin

Min number of escort groups required per escorted asset.

#number NescortMax

Max number of escort groups required per escorted asset.

#string MissionType

Mission type.

#string TargetTypes

Types of targets that are engaged.

#number EngageRange

EngageRange in Nautical Miles.

Return value:

#boolean:

If true, enough assets could be recruited or no escort was required in the first place.

Recruit and assign assets performing an OPSTRANSPORT for a given asset list.

Defined in:

LEGION

Parameters:

#table Legions

Transport legions.

#table CargoAssets

Weight of the heaviest cargo group to be transported.

#number NcarriersMin

Min number of carrier assets.

#number NcarriersMax

Max number of carrier assets.

Core.Zone#ZONE DeployZone

Deploy zone.

Core.Zone#ZONE DisembarkZone

(Optional) Disembark zone.

#table Categories

Group categories.

#table Attributes

Generalizes group attributes.

#table Properties

DCS attributes.

Return values:

#boolean:

If true, enough assets could be recruited and an OPSTRANSPORT object was created.

Transport The transport.

Calculate the mission score of an asset.

Defined in:

LEGION

Parameters:

#string MissionType

Mission type for which the best assets are desired.

DCS#Vec2 TargetVec2

Target 2D vector.

#boolean IncludePayload

If true, include the payload in the calulation if the asset has one attached.

Return value:

#number:

Mission score.

Check mission queue and assign ONE mission.

Defined in:

LEGION

Return value:

#boolean:

If true, a mission was found and requested.

Check transport queue and assign ONE transport.

Defined in:

LEGION

Return value:

#boolean:

If true, a transport was found and requested.

Count total number of assets of the legion.

Defined in:

LEGION

Parameters:

#boolean InStock

If true, only assets that are in the warehouse stock/inventory are counted.

#table MissionTypes

(Optional) Count only assest that can perform certain mission type(s). Default is all types.

#table Attributes

(Optional) Count only assest that have a certain attribute(s), e.g. WAREHOUSE.Attribute.AIR_BOMBER.

Return value:

#number:

Amount of asset groups in stock.

Count assets on mission.

Defined in:

LEGION

Parameters:

#table MissionTypes

Types on mission to be checked. Default all.

Only count assets of this cohort. Default count assets of all cohorts.

Return values:

#number:

Number of pending and queued assets.

#number:

Number of pending assets.

#number:

Number of queued assets.

Count total number of assets in LEGION warehouse stock that also have a payload.

Defined in:

LEGION

Parameters:

#boolean Payloads

(Optional) Specifc payloads to consider. Default all.

#table MissionTypes

(Optional) Count only assest that can perform certain mission type(s). Default is all types.

#table Attributes

(Optional) Count only assest that have a certain attribute(s), e.g. WAREHOUSE.Attribute.AIR_BOMBER.

Return value:

#number:

Amount of asset groups in stock.

Count missions in mission queue.

Defined in:

LEGION

Parameter:

#table MissionTypes

Types on mission to be checked. Default all possible types AUFTRAG.Type.

Return value:

#number:

Number of missions that are not over yet.

Count payloads in stock.

Defined in:

LEGION

Parameters:

#table MissionTypes

Types on mission to be checked. Default all possible types AUFTRAG.Type.

#table UnitTypes

Types of units.

#table Payloads

Specific payloads to be counted only.

Return value:

#number:

Count of available payloads in stock.

Remove cohort from cohor table of this legion.

Defined in:

LEGION

Parameter:

The cohort to be added.

Return value:

self

Fetch a payload from the airwing resources for a given unit and mission type.

The payload with the highest priority is preferred.

Defined in:

LEGION

Parameters:

#string UnitType

The type of the unit.

#string MissionType

The mission type.

#table Payloads

Specific payloads only to be considered.

Return value:

Payload table or nil.

Get the unit types of this legion.

These are the unit types of all assigned cohorts.

Defined in:

LEGION

Parameters:

#boolean onlyactive

Count only the active ones.

#table cohorts

Table of cohorts. Default all.

Return value:

#table:

Table of unit types.

Get the current mission of the asset.

Defined in:

LEGION

Parameter:

Return value:

Current mission or nil.

Count assets on mission.

Defined in:

LEGION

Parameter:

#table MissionTypes

Types on mission to be checked. Default all.

Return value:

#table:

Assets on pending requests.

Returns the mission for a given mission ID (Autragsnummer).

Defined in:

LEGION

Parameter:

#number mid

Mission ID (Auftragsnummer).

Return value:

Mission table.

Returns the mission for a given request.

Defined in:

LEGION

Parameter:

The warehouse request.

Return value:

Mission table or nil.

Returns the mission for a given request ID.

Defined in:

LEGION

Parameter:

#number RequestID

Unique ID of the request.

Return value:

Mission table or nil.

Get name of legion.

This is the alias of the warehouse.

Defined in:

LEGION

Return value:

#string:

Name of legion.

Get OPSGROUPs that are spawned and alive.

Defined in:

LEGION

Parameters:

#table MissionTypes

(Optional) Get only assest that can perform certain mission type(s). Default is all types.

#table Attributes

(Optional) Get only assest that have a certain attribute(s), e.g. WAREHOUSE.Attribute.AIR_BOMBER.

Return value:

The set of OPSGROUPs. Can be empty if no groups are spawned or alive!

Returns the mission for a given ID.

Defined in:

LEGION

Parameter:

#number uid

Transport UID.

Return value:

Transport assignment.

Check if the AIRWING class is calling.

Defined in:

LEGION

Return value:

#boolean:

If true, this is an AIRWING.

Check if an asset is currently on a mission (STARTED or EXECUTING).

Defined in:

LEGION

Parameters:

#table MissionTypes

Types on mission to be checked. Default all.

Return value:

#boolean:

If true, asset has at least one mission of that type in the queue.

Check if a BRIGADE class is calling.

Defined in:

LEGION

Return value:

#boolean:

If true, this is a BRIGADE.

Check if cohort is part of this legion.

Defined in:

LEGION

Parameter:

#string CohortName

Name of the platoon.

Return value:

#boolean:

If true, cohort is part of this legion.

Check if the FLEET class is calling.

Defined in:

LEGION

Return value:

#boolean:

If true, this is a FLEET.

Triggers the FSM event "LegionAssetReturned".

Defined in:

LEGION

Parameters:

The cohort the asset belongs to.

The asset that returned.

Triggers the FSM event "MissionAssign".

Defined in:

LEGION

Parameters:

The mission.

#table Legions

The legion(s) from which the mission assets are requested.

Triggers the FSM event "MissionCancel".

Defined in:

LEGION

Parameter:

The mission.

Triggers the FSM event "MissionRequest".

Defined in:

LEGION

Parameter:

The mission.

Create a new LEGION class object.

Defined in:

LEGION

Parameters:

#string WarehouseName

Name of the warehouse STATIC or UNIT object representing the warehouse.

#string LegionName

Name of the legion. Must be unique!

Return value:

self

On after "LegionAssetReturned" event.

Triggered when an asset group returned to its Legion.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The cohort the asset belongs to.

The asset that returned.

On after "MissionAssign" event.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

#table Legions

The legion(s) from which the mission assets are requested.

On after "MissionCancel" event.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

On after "MissionRequest" event.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

On after "OpsOnMission" event.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The OPS group on mission.

The mission.

On after "TransportAssign" event.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The transport.

#table Legions

The legion(s) to which this transport is assigned.

On after "TransportCancel" event.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The transport.

On after "TransportRequest" event.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The transport.

Triggers the FSM event "OpsOnMission".

Defined in:

LEGION

Parameters:

The OPS group on mission.

The mission.

Recruit assets performing an escort mission for a given asset.

Defined in:

LEGION

Parameters:

The mission.

#table Assets

Table of assets.

Return value:

#boolean:

If true, enough assets could be recruited or no escort was required in the first place.

Recruit assets for a given mission.

Defined in:

LEGION

Parameter:

The mission.

Return values:

#boolean:

If true enough assets could be recruited.

#table:

Recruited assets.

#table:

Legions of recruited assets.

Recruit assets for a given OPS transport.

Defined in:

LEGION

Parameter:

The OPS transport.

Return values:

#boolean:

If true, enough assets could be recruited.

#table:

assets Recruited assets.

#table:

legions Legions of recruited assets.

Recruit assets from Cohorts for the given parameters.

NOTE that we set the asset.isReserved=true flag so it cant be recruited by anyone else.

Defined in:

LEGION

Parameters:

#table Cohorts

Cohorts included.

#string MissionTypeRecruit

Mission type for recruiting the cohort assets.

#string MissionTypeOpt

Mission type for which the assets are optimized. Default is the same as MissionTypeRecruit.

#number NreqMin

Minimum number of required assets.

#number NreqMax

Maximum number of required assets.

DCS#Vec2 TargetVec2

Target position as 2D vector.

#table Payloads

Special payloads.

#number RangeMax

Max range in meters.

#number RefuelSystem

Refuelsystem.

#number CargoWeight

Cargo weight for recruiting transport carriers.

#number TotalWeight

Total cargo weight in kg.

#table Categories

Group categories.

#table Attributes

Group attributes. See GROUP.Attribute.

#table Properties

DCS attributes.

#table WeaponTypes

Bit of weapon types.

Return values:

#boolean:

If true enough assets could be recruited.

#table:

Recruited assets. NOTE that we set the asset.isReserved=true flag so it cant be recruited by anyone else.

#table:

Legions of recruited assets.

Relocate a cohort to another legion.

Assets in stock are spawned and routed to the new legion. If assets are spawned, running missions will be cancelled. Cohort assets will not be available until relocation is finished.

Defined in:

LEGION

Parameters:

The cohort to be relocated.

The legion where the cohort is relocated to.

#number Delay

Delay in seconds before relocation takes place. Default nil, i.e. ASAP.

#number NcarriersMin

Min number of transport carriers in case the troops should be transported. Default nil for no transport.

#number NcarriersMax

Max number of transport carriers.

#table TransportLegions

Legion(s) assigned for transportation. Default is that transport assets can only be recruited from this legion.

Return value:

self

Remove mission from queue.

Defined in:

LEGION

Parameter:

Mission to be removed.

Return value:

self

Return payload from asset back to stock.

Defined in:

LEGION

Parameter:

The squadron asset.

Set verbosity level.

Defined in:

LEGION

Parameter:

#number VerbosityLevel

Level of output (higher=more). Default 0.

Return value:

self

Triggers the FSM event "Start".

Starts the LEGION. Initializes parameters and starts event handlers.

Defined in:

LEGION

Triggers the FSM event "TransportAssign".

Defined in:

LEGION

Parameters:

The transport.

#table Legions

The legion(s) to which this transport is assigned.

Triggers the FSM event "TransportCancel".

Defined in:

LEGION

Parameter:

The transport.

Triggers the FSM event "TransportRequest".

Defined in:

LEGION

Parameter:

The transport.

Unrecruit assets.

Set isReserved to false, return payload to airwing and (optionally) remove from assigned mission.

Defined in:

LEGION

Parameters:

#table Assets

List of assets.

(Optional) The mission from which the assets will be deleted.

Count payloads of all cohorts for all unit types.

Defined in:

LEGION

Parameters:

#string MissionType

Mission type.

#table Cohorts

Cohorts included.

#table Payloads

(Optional) Special payloads.

Return value:

#table:

Table of payloads for each unit type.

Create a new flight group after an asset was spawned.

Defined in:

LEGION

Parameter:

Return value:

The created flightgroup object.

Get cohort by name.

Defined in:

LEGION

Parameter:

#string CohortName

Name of the platoon.

Return value:

The Cohort object.

Get cohort of an asset.

Defined in:

LEGION

Parameter:

Return value:

The Cohort object.

Optimize chosen assets for the mission at hand.

Defined in:

LEGION

Parameters:

#table assets

Table of (unoptimized) assets.

#string MissionType

Mission type.

DCS#Vec2 TargetVec2

Target position as 2D vector.

#boolean IncludePayload

If true, include the payload in the calulation if the asset has one attached.

Triggers the FSM event "LegionAssetReturned" after a delay.

Defined in:

LEGION

Parameters:

#number delay

Delay in seconds.

The cohort the asset belongs to.

The asset that returned.

Triggers the FSM event "MissionAssign" after a delay.

Defined in:

LEGION

Parameters:

#number delay

Delay in seconds.

The mission.

#table Legions

The legion(s) from which the mission assets are requested.

Triggers the FSM event "MissionCancel" after a delay.

Defined in:

LEGION

Parameters:

#number delay

Delay in seconds.

The mission.

Triggers the FSM event "MissionRequest" after a delay.

Defined in:

LEGION

Parameters:

#number delay

Delay in seconds.

The mission.

Triggers the FSM event "OpsOnMission" after a delay.

Defined in:

LEGION

Parameters:

#number delay

Delay in seconds.

The OPS group on mission.

The mission.

Triggers the FSM event "Start" after a delay.

Starts the LEGION. Initializes parameters and starts event handlers.

Defined in:

LEGION

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Stop" after a delay.

Stops the LEGION and all its event handlers.

Defined in:

LEGION

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "TransportAssign" after a delay.

Defined in:

LEGION

Parameters:

#number delay

Delay in seconds.

The transport.

#table Legions

The legion(s) to which this transport is assigned.

Triggers the FSM event "TransportCancel" after a delay.

Defined in:

LEGION

Parameters:

#number delay

Delay in seconds.

The transport.

Triggers the FSM event "TransportRequest" after a delay.

Defined in:

LEGION

Parameters:

#number delay

Delay in seconds.

The transport.

On after "AssetDead" event triggered when an asset group died.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The asset that is dead.

The request of the dead asset.

On after "AssetSpawned" event triggered when an asset group is spawned into the cruel world.

Creates a new flightgroup element and adds the mission to the flightgroup queue.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The group spawned.

The asset that was spawned.

The request of the dead asset.

On after "Captured" event.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

DCS#coalition.side Coalition

which captured the warehouse.

DCS#country.id Country

which has captured the warehouse.

On after "Destroyed" event.

Remove assets from cohorts. Stop cohorts.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "LegionAssetReturned" event.

Triggered when an asset group returned to its legion.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The cohort the asset belongs to.

The asset that returned.

On after "MissionAssign" event.

Mission is added to a LEGION mission queue and already requested. Needs assets to be added to the mission already.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

#table Legions

The LEGIONs.

On after "MissionCancel" event.

Cancels the missions of all flightgroups. Deletes request from warehouse queue.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission to be cancelled.

On after "MissionRequest" event.

Performs a self request to the warehouse for the mission assets. Sets mission status to REQUESTED.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The requested mission.

On after "NewAsset" event.

Asset is added to the given cohort (asset assignment).

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The asset that has just been added.

#string assignment

The (optional) assignment for the asset.

On after "OpsOnMission".

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops group on mission

The requested mission.

On after "Request" event.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Information table of the request.

On after "RequestSpawned" event.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Information table of the request.

Core.Set#SET_GROUP CargoGroupSet

Set of cargo groups.

Core.Set#SET_GROUP TransportGroupSet

Set of transport groups if any.

On after "SelfRequest" event.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The set of asset groups that was delivered to the warehouse itself.

Pending self request.

Start LEGION FSM.

Defined in:

LEGION

Parameters:

From

Event

To

On after "TransportAssign" event.

Transport is added to a LEGION transport queue and assets are requested from the LEGION warehouse.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The transport.

#table Legions

The legion(s) to which the transport is assigned.

On after "TransportCancel" event.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The transport to be cancelled.

On after "TransportRequest" event.

Performs a self request to the warehouse for the transport assets. Sets transport status to REQUESTED.

Defined in:

LEGION

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The requested mission.

OpsTransport

Field(s)

#string LEGION.ClassName

Name of the class.

Ops.Chief#CHIEF LEGION.chief

Chief of this legion.

#table LEGION.cohorts

Cohorts of this legion.

Ops.Commander#COMMANDER LEGION.commander

Commander of this legion.

LEGION.homebase

Set home base.

LEGION.homezone

Set home zone.

#string LEGION.lid

Class id string for output to DCS log file.

#table LEGION.missionqueue

Mission queue table.

#table LEGION.transportqueue

Transport queue.

#number LEGION.verbose

Verbosity of output.

#string LEGION.version

LEGION class version.

Function(s)

Trigger the FSM event "AddAsset".

Add a group to the warehouse stock.

Defined in:

Parameters:

Group to be added as new asset.

#number ngroups

(Optional) Number of groups to add to the warehouse stock. Default is 1.

#WAREHOUSE.Attribute forceattribute

(Optional) Explicitly force a generalized attribute for the asset. This has to be an WAREHOUSE.Attribute.

#number forcecargobay

(Optional) Explicitly force cargobay weight limit in kg for cargo carriers. This is for each unit of the group.

#number forceweight

(Optional) Explicitly force weight in kg of each unit in the group.

#number loadradius

(Optional) The distance in meters when the cargo is loaded into the carrier. Default is the bounding box size of the carrier.

DCS#AI.Skill skill

Skill of the asset.

#table liveries

Table of livery names. When the asset is spawned one livery is chosen randomly.

#string assignment

A free to choose string specifying an assignment for the asset. This can be used with the WAREHOUSE.OnAfterNewAsset function.

Add an off-road path from this warehouse to another and back.

The start and end points are automatically set to one random point in the respective spawn zones of the two warehouses. By default, the reverse path is also added as path from the remote warehouse to this warehouse.

Defined in:

Parameters:

#WAREHOUSE remotewarehouse

The remote warehouse to which the path leads.

Waypoints of this group will define the path between to warehouses.

#boolean oneway

(Optional) If true, the path can only be used from this warehouse to the other but not other way around. Default false.

Return value:

self

Triggers the FSM event "AddRequest".

Add a request to the warehouse queue, which is processed when possible.

Defined in:

Parameters:

#WAREHOUSE warehouse

The warehouse requesting supply.

#WAREHOUSE.Descriptor AssetDescriptor

Descriptor describing the asset that is requested.

AssetDescriptorValue

Value of the asset descriptor. Type depends on descriptor, i.e. could be a string, etc.

#number nAsset

Number of groups requested that match the asset specification.

#WAREHOUSE.TransportType TransportType

Type of transport.

#number nTransport

Number of transport units requested.

#number Prio

Priority of the request. Number ranging from 1=high to 100=low.

#string Assignment

A keyword or text that later be used to identify this request and postprocess the assets.

Add a shipping lane from this warehouse to another remote warehouse.

Note that both warehouses must have a port zone defined before a shipping lane can be added! Shipping lane is taken from the waypoints of a (late activated) template group. So set up a group, e.g. a ship or a helicopter, and place its waypoints along the shipping lane you want to add.

Defined in:

Parameters:

#WAREHOUSE remotewarehouse

The remote warehouse to where the shipping lane is added

Waypoints of this group will define the shipping lane between to warehouses.

#boolean oneway

(Optional) If true, the lane can only be used from this warehouse to the other but not other way around. Default false.

Return value:

self

Triggers the FSM event "AirbaseCaptured" when the airbase of the warehouse has been captured by another coalition.

Defined in:

Parameter:

DCS#coalition.side Coalition

Coalition side which captured the airbase, i.e. a number of DCS#coalition.side enumerator.

Triggers the FSM event "AirbaseRecaptured" when the airbase of the warehouse has been re-captured from the other coalition.

Defined in:

Parameter:

DCS#coalition.side Coalition

Coalition which re-captured the airbase, i.e. the same as the current warehouse owner coalition.

Triggers the FSM event "Arrived" when a group has arrived at the destination warehouse.

This function should always be called from the sending and not the receiving warehouse. If the group is a cargo asset, it is added to the receiving warehouse. If the group is a transporter it is added to the sending warehouse since carriers are supposed to return to their home warehouse once all cargo was delivered.

Defined in:

Parameter:

Group that has arrived.

Triggers the FSM event "AssetDead" when an asset group has died.

Defined in:

Parameters:

The asset that is dead.

The request of the dead asset.

Triggers the FSM event "AssetLowFuel" when an asset runs low on fuel

Defined in:

Parameters:

The asset that is low on fuel.

The request of the asset that is low on fuel.

Triggers the FSM event "AssetSpawned" when the warehouse has spawned an asset.

Defined in:

Parameters:

the group that was spawned.

The asset that was spawned.

The request of the spawned asset.

Triggers the FSM event "Attacked" when a warehouse is under attack by an another coalition.

Defined in:

Parameters:

DCS#coalition.side Coalition

Coalition side which is attacking the warehouse, i.e. a number of DCS#coalition.side enumerator.

DCS#country.id Country

Country ID, which is attacking the warehouse, i.e. a number DCS#country.id enumerator.

Triggers the FSM event "Captured" when a warehouse has been captured by another coalition.

Defined in:

Parameters:

DCS#coalition.side Coalition

Coalition side which captured the warehouse.

DCS#country.id Country

Country id which has captured the warehouse.

Triggers the FSM event "ChangeCountry" so the warehouse is respawned with the new country.

Defined in:

Parameter:

DCS#country.id Country

New country id of the warehouse.

Triggers the FSM event "Defeated" when an attack from an enemy was defeated.

Triggers the FSM event "Delivered".

All (cargo) assets of a request have been delivered to the receiving warehouse.

Defined in:

Parameter:

Pending request that was now delivered.

Triggers the FSM event "Destroyed" when the warehouse was destroyed.

Services are stopped.

Filter stock assets by descriptor and attribute.

Defined in:

Parameters:

#string descriptor

Descriptor describing the filtered assets.

attribute

Value of the descriptor.

#number nmax

(Optional) Maximum number of items that will be returned. Default nmax=nil is all matching items are returned.

#boolean mobile

(Optional) If true, filter only mobile assets.

Return values:

#table:

Filtered assets in stock with the specified descriptor value.

#number:

Total number of (requested) assets available.

#boolean:

If true, enough assets are available.

Find an asset in the the global warehouse data base.

Parameter is the MOOSE group object. Note that the group name must contain they "AID" keyword.

Defined in:

Parameter:

The group from which it is assumed that it has a registered asset.

Return value:

The asset from the data base or nil if it could not be found.

Find nearest warehouse in service, i.e.

warehouses which are not started, stopped or destroyed are not considered. Optionally, only warehouses with (specific) assets can be included in the search or warehouses of a certain coalition.

Defined in:

Parameters:

MinAssets

(Optional) Minimum number of assets the warehouse should have. Default 0.

#string Descriptor

(Optional) Descriptor describing the selected assets which should be in stock. See WAREHOUSE.Descriptor for possible values.

DescriptorValue

(Optional) Descriptor value selecting the type of assets which should be in stock.

DCS#Coalition.side Coalition

(Optional) Coalition side of the warehouse. Default is the same coalition as the present warehouse. Set to false for any coalition.

Core.Point#COORDINATE RefCoordinate

(Optional) Coordinate to which the closest warehouse is searched. Default is the warehouse calling this function.

Return values:

The the nearest warehouse object. Or nil if no warehouse is found.

#number:

The distance to the nearest warehouse in meters. Or nil if no warehouse is found.

Find a warehouse in the global warehouse data base.

Defined in:

Parameter:

#number uid

The unique ID of the warehouse.

Return value:

The warehouse object or nil if no warehouse exists.

Get airbase associated to the warehouse.

Defined in:

Return value:

Airbase object or nil if warehouse has no airbase connection.

Get category of airbase associated to the warehouse.

Defined in:

Return value:

#number:

Category of airbase or -1 if warehouse has (currently) no airbase.

Get name airbase associated to the warehouse.

Defined in:

Return value:

#string:

name of the airbase assosicated to the warehouse or "none" if the airbase has not airbase connection currently.

Get a warehouse asset from its unique id.

Defined in:

Parameter:

#number id

Asset ID.

Return value:

The warehouse asset.

Get a warehouse asset from its name.

Defined in:

Parameter:

#string GroupName

Spawn group name.

Return value:

The warehouse asset.

Get assignment of a request.

Defined in:

Parameter:

The request from which the assignment is extracted.

Return value:

#string:

The assignment text.

Get coalition side of warehouse static.

Defined in:

Return value:

#number:

Coalition side, i.e. number of DCS#coalition.side.

Get coalition name of warehouse static.

Defined in:

Return value:

#number:

Coalition side, i.e. number of DCS#coalition.side.

Get coordinate of warehouse static.

Defined in:

Return value:

The coordinate of the warehouse.

Get country id of warehouse static.

Defined in:

Return value:

#number:

Country id, i.e. number of DCS#country.id.

Get country name of warehouse static.

Defined in:

Return value:

#number:

Country id, i.e. number of DCS#coalition.side.

Get number of assets in warehouse stock.

Optionally, only specific assets can be counted.

Defined in:

Parameters:

#string Descriptor

(Optional) Descriptor return the number of a specifc asset type. See WAREHOUSE.Descriptor for possible values.

DescriptorValue

(Optional) Descriptor value selecting the type of assets.

#boolean OnlyMobile

(Optional) If true only mobile units are considered.

Return value:

#number:

Number of assets in stock.

Get a warehouse request from its unique id.

Defined in:

Parameter:

#number id

Request ID.

Return values:

The warehouse requested - either queued or pending.

#boolean:

If true, request is queued, if false, request is pending, if nil, request could not be found.

Check if runway is operational.

Defined in:

Return value:

#number:

Time in seconds until the runway is repaired. Will return 0 if runway is repaired.

Get the spawn zone.

Defined in:

Return value:

The spawn zone.

Returns the number of assets for each generalized attribute.

Defined in:

Parameter:

#table stock

The stock of the warehouse.

Return value:

#table:

Data table holding the numbers, i.e. data[attibute]=n.

Get 2D vector of warehouse static.

Defined in:

Return value:

The 2D vector of the warehouse.

Get 3D vector of warehouse static.

Defined in:

Return value:

The 3D vector of the warehouse.

Get the warehouse zone.

Defined in:

Return value:

The warehouse zone.

Check if the warehouse has a shipping lane defined to another warehouse.

Defined in:

Parameters:

#WAREHOUSE warehouse

The remote warehouse to where the connection is checked.

#boolean markpath

If true, place markers of path segments on the F10 map.

#boolean smokepath

If true, put green smoke on path segments.

Return values:

#boolean:

If true, the two warehouses are connected by road.

#number:

Path length in meters. Negative distance -1 meter indicates no connection.

Check if the warehouse has an off road path defined to another warehouse.

Defined in:

Parameters:

#WAREHOUSE warehouse

The remote warehouse to where the connection is checked.

#boolean markpath

If true, place markers of path segments on the F10 map.

#boolean smokepath

If true, put green smoke on path segments.

Return values:

#boolean:

If true, the two warehouses are connected by road.

#number:

Path length in meters. Negative distance -1 meter indicates no connection.

Check if the warehouse has a railroad connection to another warehouse.

Both warehouses need to be started!

Defined in:

Parameters:

#WAREHOUSE warehouse

The remote warehouse to where the connection is checked.

#boolean markpath

If true, place markers of path segments on the F10 map.

#boolean smokepath

If true, put green smoke on path segments.

Return values:

#boolean:

If true, the two warehouses are connected by road.

#number:

Path length in meters. Negative distance -1 meter indicates no connection.

Check if the warehouse has a road connection to another warehouse.

Both warehouses need to be started!

Defined in:

Parameters:

#WAREHOUSE warehouse

The remote warehouse to where the connection is checked.

#boolean markpath

If true, place markers of path segments on the F10 map.

#boolean smokepath

If true, put green smoke on path segments.

Return values:

#boolean:

If true, the two warehouses are connected by road.

#number:

Path length in meters. Negative distance -1 meter indicates no connection.

Check if the warehouse is under attack by another coalition.

Defined in:

Return value:

#boolean:

If true, the warehouse is attacked.

Check if the warehouse has been destroyed.

Defined in:

Return value:

#boolean:

If true, the warehouse had been destroyed.

Check if the warehouse has been loaded from disk via the "Load" event.

Defined in:

Return value:

#boolean:

If true, the warehouse was loaded from disk.

Check if the warehouse has not been started yet, i.e.

is in the state "NotReadyYet".

Defined in:

Return value:

#boolean:

If true, the warehouse object has been created but the warehouse has not been started yet.

Check if the warehouse is paused.

In this state, requests are not processed.

Defined in:

Return value:

#boolean:

If true, the warehouse is paused.

Check if the warehouse is running.

Defined in:

Return value:

#boolean:

If true, the warehouse is running and requests are processed.

Check if runway is operational.

Defined in:

Return value:

#boolean:

If true, runway is operational.

Check if warehouse physical representation is a ship.

Defined in:

Return value:

#boolean:

If true, warehouse object is a ship.

Check if warehouse physical representation is a static (not a unit) object.

Defined in:

Return value:

#boolean:

If true, warehouse object is a static.

Check if the warehouse is stopped.

Defined in:

Return value:

#boolean:

If true, the warehouse is stopped.

Check if warehouse physical representation is a unit (not a static) object.

Defined in:

Return value:

#boolean:

If true, warehouse object is a unit.

Triggers the FSM event "Load" when the warehouse is loaded from a file on disk.

Defined in:

Parameters:

#string path

Path where the file is located. Default is the DCS installation root directory.

#string filename

(Optional) File name. Default is WAREHOUSE-_.txt.

The WAREHOUSE constructor.

Creates a new WAREHOUSE object from a static object. Parameters like the coalition and country are taken from the static object structure.

Defined in:

Parameters:

The physical structure representing the warehouse. Can also be a Wrapper.Unit#UNIT.

#string alias

(Optional) Alias of the warehouse, i.e. the name it will be called when sending messages etc. Default is the name of the static/unit representing the warehouse.

Return value:

self

Triggers the FSM delayed event "NewAsset" when a new asset has been added to the warehouse stock.

Defined in:

Parameters:

The new asset.

#string assignment

(Optional) Assignment text for the asset.

On after "AirbaseCaptured" even user function.

Called when the airbase of the warehouse has been captured by another coalition.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

DCS#coalition.side Coalition

Coalition side which captured the airbase, i.e. a number of DCS#coalition.side enumerator.

On after "AirbaseRecaptured" event user function.

Called when the airbase of the warehouse has been re-captured from the other coalition.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

DCS#coalition.side Coalition

Coalition which re-captured the airbase, i.e. the same as the current warehouse owner coalition.

On after "Arrived" event user function.

Called when a group has arrived at its destination.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Group that has arrived.

On after "AssetDead" event user function.

Called when an asset group died.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The asset that is dead.

The request of the dead asset.

On after "AssetLowFuel" event user function.

Called when the an asset is low on fuel.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The asset that is low on fuel.

The request of the asset that is low on fuel.

On after "AssetSpawned" event user function.

Called when the warehouse has spawned an asset.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

the group that was spawned.

The asset that was spawned.

The request of the spawned asset.

On after "Attacked" event user function.

Called when a warehouse (zone) is under attack by an enemy.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

DCS#coalition.side Coalition

Coalition side which is attacking the warehouse, i.e. a number of DCS#coalition.side enumerator.

DCS#country.id Country

Country ID, which is attacking the warehouse, i.e. a number DCS#country.id enumerator.

On after "Captured" event user function.

Called when the warehouse has been captured by an enemy coalition.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

DCS#coalition.side Coalition

Coalition side which captured the warehouse, i.e. a number of DCS#coalition.side enumerator.

DCS#country.id Country

Country id which has captured the warehouse, i.e. a number DCS#country.id enumerator.

On after "ChangeCountry" event user function.

Called when the warehouse has changed its country.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

DCS#country.id Country

New country id of the warehouse, i.e. a number DCS#country.id enumerator.

On after "Defeated" event user function.

Called when an enemy attack was defeated.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Delivered" event user function.

Called when a group has been delivered from the warehouse to another warehouse.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Pending request that was now delivered.

On after "Destroyed" event user function.

Called when the warehouse was destroyed. Services are stopped.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Load" event user function.

Called when the warehouse assets are loaded from disk.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#string path

Path where the file is located. Default is the DCS installation root directory.

#string filename

(Optional) File name. Default is WAREHOUSE-_.txt.

On after "NewAsset" event user function.

A new asset has been added to the warehouse stock.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The asset that has just been added.

#string assignment

(Optional) Assignment text for the asset.

On after "Request" user function.

The necessary cargo and transport assets were spawned.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Information table of the request.

On after "Respawn" event user function.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Save" event user function.

Called when the warehouse assets are saved to disk.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#string path

Path where the file is saved. Default is the DCS installation root directory.

#string filename

(Optional) File name. Default is WAREHOUSE-_.txt.

On after "SelfRequest" event.

Request was initiated from the warehouse to itself. Groups are simply spawned at the warehouse or the associated airbase. All requested assets are passed as a Core.Set#SET_GROUP and can be used for further tasks or in other MOOSE classes. Note that airborne assets are spawned in uncontrolled state so they do not simply "fly away" after spawning.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The set of (cargo) groups that was delivered to the warehouse itself.

Pending self request.

Usage:

--- Self request event. Triggered once the assets are spawned in the spawn zone or at the airbase.
function mywarehouse:OnAfterSelfRequest(From, Event, To, groupset, request)
  local groupset=groupset --Core.Set#SET_GROUP

  -- Loop over all groups spawned from that request.
  for _,group in pairs(groupset:GetSetObjects()) do
    local group=group --Wrapper.Group#GROUP

    -- Gree smoke on spawned group.
    group:SmokeGreen()

    -- Activate uncontrolled airborne group if necessary.
    group:StartUncontrolled()
  end
end

On before "Request" user function.

The necessary cargo and transport assets will be spawned. Time to set some additional asset parameters.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Information table of the request.

Triggers the FSM event "Pause".

Pauses the warehouse. Assets can still be added and requests be made. However, requests are not processed.

Triggers the FSM event "Request".

Executes a request from the queue if possible.

Defined in:

Parameter:

Information table of the request.

Triggers the FSM event "Respawn".

Triggers the FSM event "Restart".

Restarts the warehouse from stopped state by reactivating the event handlers only.

Triggers the FSM event "Save" when the warehouse assets are saved to file on disk.

Defined in:

Parameters:

#string path

Path where the file is saved. Default is the DCS installation root directory.

#string filename

(Optional) File name. Default is WAREHOUSE-_.txt.

Triggers the FSM event "SelfRequest".

Request was initiated from the warehouse to itself. Groups are just spawned at the warehouse or the associated airbase. If the warehouse is currently under attack when the self request is made, the self request is added to the defending table. One the attack is defeated, this request is used to put the groups back into the warehouse stock.

Defined in:

Parameters:

The set of cargo groups that was delivered to the warehouse itself.

Pending self request.

Set the airbase belonging to this warehouse.

Note that it has to be of the same coalition as the warehouse. Also, be reasonable and do not put it too far from the phyiscal warehouse structure because you troops might have a long way to get to their transports.

Defined in:

Parameter:

The airbase object associated to this warehouse.

Return value:

self

Set wether client parking spots can be used for spawning.

Defined in:

Return value:

self

Set auto defence off.

This is the default.

Defined in:

Return value:

self

Set auto defence on.

When the warehouse is under attack, all ground assets are spawned automatically and will defend the warehouse zone.

Defined in:

Return value:

self

Set debug mode off.

This is the default

Defined in:

Return value:

self

Set debug mode on.

Error messages will be displayed on screen, units will be smoked at some events.

Defined in:

Return value:

self

Add a Harbor Zone for this warehouse where naval cargo units will spawn and be received.

Both warehouses must have the harbor zone defined for units to properly spawn on both the sending and receiving side. The harbor zone should be within 3km of the port zone used for warehouse in order to facilitate the boarding process.

Defined in:

Parameter:

The zone defining the naval embarcation/debarcation point for cargo units

Return value:

self

Set low fuel threshold.

If one unit of an asset has less fuel than this number, the event AssetLowFuel will be fired.

Defined in:

Parameter:

#number threshold

Relative low fuel threshold, i.e. a number in [0,1]. Default 0.15 (15%).

Return value:

self

Show or don't show markers on the F10 map displaying the Warehouse stock and road/rail connections.

Defined in:

Parameter:

#boolean switch

If true (or nil), markers are on. If false, markers are not displayed.

Return value:

self

Set valid parking spot IDs.

Defined in:

Parameter:

#table ParkingIDs

Table of numbers.

Return value:

self

Set the port zone for this warehouse.

The port zone is the zone, where all naval assets of the warehouse are spawned.

Defined in:

Parameter:

The zone defining the naval port of the warehouse.

Return value:

self

Set the connection of the warehouse to the railroad.

This is the place where train assets or transports will be spawned.

Defined in:

Parameter:

The railroad connection. Technically, the closest point on rails from this coordinate is determined by DCS API function. So this point must not be exactly on the a railroad connection.

Return value:

self

Set report off.

Warehouse does not report about its status and at certain events.

Defined in:

Return value:

self

Set report on.

Messages at events will be displayed on screen to the coalition owning the warehouse.

Defined in:

Return value:

self

Set respawn after destroy.

Defined in:

Parameter:

delay

Return value:

self

Set the connection of the warehouse to the road.

Ground assets spawned in the warehouse spawn zone will first go to this point and from there travel on road to the requesting warehouse. Note that by default the road connection is set to the closest point on road from the center of the spawn zone if it is withing 3000 meters. Also note, that if the parameter "coordinate" is passed as nil, any road connection is disabled and ground assets cannot travel of be transportet on the ground.

Defined in:

Parameter:

The road connection. Technically, the closest point on road from this coordinate is determined by DCS API function. So this point must not be exactly on the road.

Return value:

self

Set the time until the runway(s) of an airdrome are repaired after it has been destroyed.

Note that this is the time, the DCS engine uses not something we can control on a user level or we could get via scripting. You need to input the value. On the DCS forum it was stated that this is currently one hour. Hence this is the default value.

Defined in:

Parameter:

#number RepairTime

Time in seconds until the runway is repaired. Default 3600 sec (one hour).

Return value:

self

Disable safe parking option.

Note that is the default setting.

Defined in:

Return value:

self

Enable safe parking option, i.e.

parking spots at an airbase will be considered as occupied when a client aircraft is parked there (even if the client slot is not taken by a player yet). Note that also incoming aircraft can reserve/occupie parking spaces.

Defined in:

Return value:

self

Enable auto save of warehouse assets at mission end event.

Defined in:

Parameters:

#string path

Path where to save the asset data file.

#string filename

File name. Default is generated automatically from warehouse id.

Return value:

self

Set a zone where the (ground) assets of the warehouse are spawned once requested.

Defined in:

Parameters:

The spawn zone.

#number maxdist

(Optional) Maximum distance in meters between spawn zone and warehouse. Units are not spawned if distance is larger. Default is 5000 m.

Return value:

self

Set interval of status updates.

Note that normally only one request can be processed per time interval.

Defined in:

Parameter:

#number timeinterval

Time interval in seconds.

Return value:

self

Set verbosity level.

Defined in:

Parameter:

#number VerbosityLevel

Level of output (higher=more). Default 0.

Return value:

self

Set a warehouse zone.

If this zone is captured, the warehouse and all its assets fall into the hands of the enemy.

Defined in:

Parameter:

The warehouse zone. Note that this cannot be a polygon zone!

Return value:

self

Triggers the FSM event "Start".

Starts the warehouse. Initializes parameters and starts event handlers.

Triggers the FSM event "Status".

Queue is updated and requests are executed.

Triggers the FSM event "Stop".

Stops the warehouse and all its event handlers. All waiting and pending queue items are deleted as well and all assets are removed from stock.

Triggers the FSM event "Unpause".

Unpauses the warehouse. Processing of queued requests is resumed.

Task function for last waypoint.

Triggering the "Arrived" event.

Defined in:

Parameter:

The group that arrived.

Asset item characteristics.

Defined in:

Parameter:

The asset for which info in printed in trace mode.

Checks if the associated airbase still belongs to the warehouse.

Function that checks if an asset group is still okay.

Checks if the warehouse zone was conquered by antoher coalition.

Checks fuel on all pening assets.

Check parking ID for an asset.

Defined in:

Parameters:

asset

Return value:

#boolean:

If true, parking is valid.

Check parking ID.

Defined in:

Parameter:

Return value:

#boolean:

If true, parking is valid.

Sorts the queue and checks if the request can be fulfilled.

Defined in:

Return value:

Chosen request.

Checks if the request can be fulfilled in general.

If not, it is removed from the queue. Check if departure and destination bases are of the right type.

Defined in:

Parameter:

#table queue

The queue which is holding the requests to check.

Return value:

#boolean:

If true, request can be executed. If false, something is not right.

Checks if the request can be fulfilled right now.

Check for current parking situation, number of assets and transports currently in stock.

Defined in:

Parameter:

The request to be checked.

Return value:

#boolean:

If true, request can be executed. If false, something is not right.

Check if a request is valid in general.

If not, it will be removed from the queue. This routine needs to have at least one asset in stock that matches the request descriptor in order to determine whether the request category of troops. If no asset is in stock, the request will remain in the queue but cannot be executed.

Defined in:

Parameter:

The request to be checked.

Return value:

#boolean:

If true, request can be executed. If false, something is not right.

Debug message.

Message send to all if debug mode is activated (and duration > 0). Text self:T(text) added to DCS.log file.

Defined in:

Parameters:

#string text

The text of the error message.

#number duration

Message display duration in seconds. Default 20 sec. If duration is zero, no message is displayed.

Delete item from queue.

Defined in:

Parameters:

Item of queue to be removed.

#table queue

The queue from which the item should be deleted.

Delete item from queue.

Defined in:

Parameters:

#number qitemID

ID of queue item to be removed.

#table queue

The queue from which the item should be deleted.

Delete an asset item from stock.

Defined in:

Parameter:

Asset item to delete from stock table.

Display status of warehouse.

Display stock items of warehouse.

Defined in:

Parameter:

#table stock

Table holding all assets in stock of the warehouse. Each entry is of type WAREHOUSE.Assetitem.

Error message.

Message send to all (if duration > 0). Text self:E(text) added to DCS.log file.

Defined in:

Parameters:

#string text

The text of the error message.

#number duration

Message display duration in seconds. Default 20 sec. If duration is zero, no message is displayed.

Filter stock assets by table entry.

Defined in:

Parameters:

#table stock

Table holding all assets in stock of the warehouse. Each entry is of type WAREHOUSE.Assetitem.

#string descriptor

Descriptor describing the filtered assets.

attribute

Value of the descriptor.

#number nmax

(Optional) Maximum number of items that will be returned. Default nmax=nil is all matching items are returned.

#boolean mobile

(Optional) If true, filter only mobile assets.

Return values:

#table:

Filtered stock items table.

#number:

Total number of (requested) assets available.

#boolean:

If true, enough assets are available.

Seach unoccupied parking spots at the airbase for a list of assets.

For each asset group a list of parking spots is returned. During the search also the not yet spawned asset aircraft are considered. If not enough spots for all asset units could be found, the routine returns nil!

Defined in:

Parameters:

The airbase where we search for parking spots.

#table assets

A table of assets for which the parking spots are needed.

Return value:

#table:

Table of coordinates and terminal IDs of free parking spots. Each table entry has the elements .Coordinate and .TerminalID.

Get the generalized attribute of a group.

Note that for a heterogenious group, the attribute is determined from the attribute of the first unit!

Defined in:

Parameter:

MOOSE group object.

Return value:

Generalized attribute of the group.

Make a flight plan from a departure to a destination airport.

Defined in:

Parameters:

Departure airbase.

Destination airbase.

Return values:

#table:

Table of flightplan waypoints.

#table:

Table of flightplan coordinates.

Get warehouse id, asset id and request id from group name (alias).

Defined in:

Parameter:

The group from which the info is gathered.

Return values:

#number:

Warehouse ID.

#number:

Asset ID.

#number:

Request ID.

Get warehouse id, asset id and request id from group name (alias).

Defined in:

Parameter:

#string groupname

Name of the group from which the info is gathered.

Return values:

#number:

Warehouse ID.

#number:

Asset ID.

#number:

Request ID.

Calculate the maximum height an aircraft can reach for the given parameters.

Defined in:

Parameters:

#number D

Total distance in meters from Departure to holding point at destination.

#number alphaC

Climb angle in rad.

#number alphaD

Descent angle in rad.

#number Hdep

AGL altitude of departure point.

#number Hdest

AGL altitude of destination point.

#number Deltahhold

Relative altitude of holding point above destination.

Return value:

#number:

Maximum height the aircraft can reach.

Get group name without any spawn or cargo suffix #CARGO etc.

Defined in:

Parameter:

The group from which the info is gathered.

Return value:

#string:

Name of the object without trailing #...

Size of the bounding box of a DCS object derived from the DCS descriptor table.

If boundinb box is nil, a size of zero is returned.

Defined in:

Parameter:

DCS#Object DCSobject

The DCS object for which the size is needed.

Return values:

#number:

Max size of object in meters (length (x) or width (z) components not including height (y)).

#number:

Length (x component) of size.

#number:

Height (y component) of size.

#number:

Width (z component) of size.

Get the request belonging to a group.

Defined in:

Parameters:

The group from which the info is gathered.

#table queue

Queue holding all requests.

Return value:

The request belonging to this group.

Get text about warehouse stock.

Defined in:

Parameter:

#boolean messagetoall

If true, send message to all.

Return value:

#string:

Text about warehouse stock

Get the proper terminal type based on generalized attribute of the group.

Defined in:

Parameters:

Generlized attibute of unit.

#number _category

Airbase category.

Return value:

Terminal type for this group.

Get (optimized) transport carriers for the given assets to be transported.

Defined in:

Parameters:

request.

request

Is the group a used as transporter for a given request?

Defined in:

Parameters:

The group from which the info is gathered.

Request.

Return value:

#boolean:

True if group is transport, false if group is cargo and nil otherwise.

Check if a group has a generalized attribute.

Defined in:

Parameters:

MOOSE group object.

Attribute to check.

Return value:

#boolean:

True if group has the specified attribute.

Info Message.

Message send to coalition if reports or debug mode activated (and duration > 0). Text self:I(text) added to DCS.log file.

Defined in:

Parameters:

#string text

The text of the error message.

#number duration

Message display duration in seconds. Default 20 sec. If duration is zero, no message is displayed.

Function that checks if a pending job is done and can be removed from queue.

Create a new path from a template group.

Defined in:

Parameters:

Group used for extracting the waypoints.

First coordinate.

Final coordinate.

Return value:

#table:

Table with route points.

Arrived event if an air unit/group arrived at its destination.

This can be an engine shutdown or a landing event.

Defined in:

Parameter:

Event data table.

Warehouse event handling function.

Handles the case when the airbase associated with the warehous is captured.

Defined in:

Parameter:

Event data.

Warehouse event function, handling the birth of a unit.

Defined in:

Parameter:

Event data.

Warehouse event handling function.

Defined in:

Parameter:

Event data.

Function handling the event when a (warehouse) unit shuts down its engines.

Defined in:

Parameter:

Event data.

Function handling the event when a (warehouse) unit starts its engines.

Defined in:

Parameter:

Event data.

Function handling the event when a (warehouse) unit lands.

Defined in:

Parameter:

Event data.

Warehouse event handling function.

Handles the case when the mission is ended.

Defined in:

Parameter:

Event data.

Function handling the event when a (warehouse) unit takes off.

Defined in:

Parameter:

Event data.

Task function for when passing a waypoint.

Defined in:

Parameters:

The group that arrived.

#number n

Waypoint passed.

#number N

Final waypoint.

Prints the queue to DCS.log file.

Defined in:

Parameters:

#table queue

Queue to print.

#string name

Name of the queue for info reasons.

Relative to absolute quantity.

Defined in:

Parameters:

#string relative

Relative number in terms of WAREHOUSE.Quantity.

#number ntot

Total number.

Return value:

#number:

Absolute number.

Register new asset in globase warehouse data base.

Defined in:

Parameters:

The group that will be added to the warehouse stock.

#number ngroups

Number of groups to be added.

#string forceattribute

Forced generalized attribute.

#number forcecargobay

Cargo bay weight limit in kg.

#number forceweight

Weight of units in kg.

#number loadradius

Radius in meters when cargo is loaded into the carrier.

#table liveries

Table of liveries.

DCS#AI.Skill skill

Skill of AI.

#string assignment

Assignment attached to the asset item.

Return value:

#table:

A table containing all registered assets.

Route the airplane from one airbase another.

Activates uncontrolled aircraft and sets ROE/ROT for ferry flights. ROE is set to return fire and ROT to passive defence.

Defined in:

Parameter:

Airplane group to be routed.

Route ground units to destination.

ROE is set to return fire and alarm state to green.

Defined in:

Parameters:

The ground group to be routed

The request for this group.

Route naval units along user defined shipping lanes to destination warehouse.

ROE is set to return fire.

Defined in:

Parameters:

The naval group to be routed

The request for this group.

Route trains to their destination - or at least to the closest point on rail of the desired final destination.

Defined in:

Parameters:

The train group.

of the destination. Tail will be routed to the closest point

#number Speed

Speed in km/h to drive to the destination coordinate. Default is 60% of max possible speed the unit can go.

Simple task function.

Can be used to call a function which has the warehouse and the executing group as parameters.

Defined in:

Parameters:

#string Function

The name of the function to call passed as string.

The group which is meant.

Simple task function.

Can be used to call a function which has the warehouse and the executing group as parameters.

Defined in:

Parameters:

#string Function

The name of the function to call passed as string.

The group which is meant.

#number n

Waypoint passed.

#number N

Final waypoint number.

Sort requests queue wrt prio and request uid.

Spawn an aircraft asset (plane or helo) at the airbase associated with the warehouse.

Defined in:

Parameters:

#string alias

Alias name of the asset group.

Ground asset that will be spawned.

Request belonging to this asset. Needed for the name/alias.

#table parking

Parking data for this asset.

#boolean uncontrolled

Spawn aircraft in uncontrolled state.

#boolean lateactivated

If true, groups are spawned late activated.

Return value:

The spawned group or nil if the group could not be spawned.

Spawn a ground or naval asset in the corresponding spawn zone of the warehouse.

Defined in:

Parameters:

#string alias

Alias name of the asset group.

Ground asset that will be spawned.

Request belonging to this asset. Needed for the name/alias.

Core.Zone#ZONE spawnzone

Zone where the assets should be spawned.

#boolean lateactivated

If true, groups are spawned late activated.

Return value:

The spawned group or nil if the group could not be spawned.

Prepare a spawn template for the asset.

Deep copy of asset template, adjusting template and unit names, nillifying group and unit ids.

Defined in:

Parameters:

Ground asset that will be spawned.

#string alias

Alias name of the group.

Return value:

#table:

Prepared new spawn template.

Spawns requested assets at warehouse or associated airbase.

Defined in:

Parameter:

Information table of the request.

A unit of a group just died.

Update group sets in request. This is important in order to determine if a job is done and can be removed from the (pending) queue.

Defined in:

Parameters:

Unit that died.

Group of unit that died.

Request that needs to be updated.

Create or update mark text at warehouse, which is displayed in F10 map showing how many assets of each type are in stock.

Only the coalition of the warehouse owner is able to see it.

Defined in:

Return value:

#string:

Text about warehouse stock

Trigger the FSM event "AddAsset" with a delay.

Add a group to the warehouse stock.

Defined in:

Parameters:

#number delay

Delay in seconds.

Group to be added as new asset.

#number ngroups

(Optional) Number of groups to add to the warehouse stock. Default is 1.

#WAREHOUSE.Attribute forceattribute

(Optional) Explicitly force a generalized attribute for the asset. This has to be an WAREHOUSE.Attribute.

#number forcecargobay

(Optional) Explicitly force cargobay weight limit in kg for cargo carriers. This is for each unit of the group.

#number forceweight

(Optional) Explicitly force weight in kg of each unit in the group.

#number loadradius

(Optional) The distance in meters when the cargo is loaded into the carrier. Default is the bounding box size of the carrier.

DCS#AI.Skill skill

Skill of the asset.

#table liveries

Table of livery names. When the asset is spawned one livery is chosen randomly.

#string assignment

A free to choose string specifying an assignment for the asset. This can be used with the WAREHOUSE.OnAfterNewAsset function.

Triggers the FSM event "AddRequest" with a delay.

Add a request to the warehouse queue, which is processed when possible.

Defined in:

Parameters:

#number delay

Delay in seconds.

#WAREHOUSE warehouse

The warehouse requesting supply.

#WAREHOUSE.Descriptor AssetDescriptor

Descriptor describing the asset that is requested.

AssetDescriptorValue

Value of the asset descriptor. Type depends on descriptor, i.e. could be a string, etc.

#number nAsset

Number of groups requested that match the asset specification.

#WAREHOUSE.TransportType TransportType

Type of transport.

#number nTransport

Number of transport units requested.

#number Prio

Priority of the request. Number ranging from 1=high to 100=low.

#string Assignment

A keyword or text that later be used to identify this request and postprocess the assets.

Triggers the FSM event "AirbaseCaptured" with a delay when the airbase of the warehouse has been captured by another coalition.

Defined in:

Parameters:

#number delay

Delay in seconds.

DCS#coalition.side Coalition

Coalition side which captured the airbase, i.e. a number of DCS#coalition.side enumerator.

Triggers the FSM event "AirbaseRecaptured" with a delay when the airbase of the warehouse has been re-captured from the other coalition.

Defined in:

Parameters:

#number delay

Delay in seconds.

DCS#coalition.side Coalition

Coalition which re-captured the airbase, i.e. the same as the current warehouse owner coalition.

Triggers the FSM event "Arrived" after a delay when a group has arrived at the destination.

This function should always be called from the sending and not the receiving warehouse. If the group is a cargo asset, it is added to the receiving warehouse. If the group is a transporter it is added to the sending warehouse since carriers are supposed to return to their home warehouse once

Defined in:

Parameters:

#number delay

Delay in seconds.

Group that has arrived.

Triggers the delayed FSM event "AssetDead" when an asset group has died.

Defined in:

Parameters:

#number delay

Delay in seconds.

The asset that is dead.

The request of the dead asset.

Triggers the FSM event "AssetLowFuel" with a delay when an asset runs low on fuel.

Defined in:

Parameters:

#number delay

Delay in seconds.

The asset that is low on fuel.

The request of the asset that is low on fuel.

Triggers the FSM event "AssetSpawned" with a delay when the warehouse has spawned an asset.

Defined in:

Parameters:

#number delay

Delay in seconds.

the group that was spawned.

The asset that was spawned.

The request of the spawned asset.

Triggers the FSM event "Attacked" with a delay when a warehouse is under attack by an another coalition.

Defined in:

Parameters:

#number delay

Delay in seconds.

DCS#coalition.side Coalition

Coalition side which is attacking the warehouse, i.e. a number of DCS#coalition.side enumerator.

DCS#country.id Country

Country ID, which is attacking the warehouse, i.e. a number DCS#country.id enumerator.

Triggers the FSM event "Captured" with a delay when a warehouse has been captured by another coalition.

Defined in:

Parameters:

#number delay

Delay in seconds.

DCS#coalition.side Coalition

Coalition side which captured the warehouse.

DCS#country.id Country

Country id which has captured the warehouse.

Triggers the FSM event "ChangeCountry" after a delay so the warehouse is respawned with the new country.

Defined in:

Parameters:

#number delay

Delay in seconds.

DCS#country.id Country

Country id which has captured the warehouse.

Triggers the FSM event "Defeated" with a delay when an attack from an enemy was defeated.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Delivered" after a delay.

A group has been delivered from the warehouse to another warehouse.

Defined in:

Parameters:

#number delay

Delay in seconds.

Pending request that was now delivered.

Triggers the FSM event "Destroyed" with a delay when the warehouse was destroyed.

Services are stopped.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Load" with a delay when the warehouse assets are loaded from disk.

Defined in:

Parameters:

#number delay

Delay in seconds.

#string path

Path where the file is located. Default is the DCS installation root directory.

#string filename

(Optional) File name. Default is WAREHOUSE-_.txt.

Triggers the FSM delayed event "NewAsset" when a new asset has been added to the warehouse stock.

Defined in:

Parameters:

#number delay

Delay in seconds.

The new asset.

#string assignment

(Optional) Assignment text for the asset.

Triggers the FSM event "Pause" after a delay.

Pauses the warehouse. Assets can still be added and requests be made. However, requests are not processed.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Request" after a delay.

Executes a request from the queue if possible.

Defined in:

Parameters:

#number Delay

Delay in seconds.

Information table of the request.

Triggers the FSM event "Respawn" after a delay.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Restart" after a delay.

Restarts the warehouse from stopped state by reactivating the event handlers only.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Save" with a delay when the warehouse assets are saved to a file.

Defined in:

Parameters:

#number delay

Delay in seconds.

#string path

Path where the file is saved. Default is the DCS installation root directory.

#string filename

(Optional) File name. Default is WAREHOUSE-_.txt.

Triggers the FSM event "SelfRequest" with a delay.

Request was initiated from the warehouse to itself. Groups are just spawned at the warehouse or the associated airbase. If the warehouse is currently under attack when the self request is made, the self request is added to the defending table. One the attack is defeated, this request is used to put the groups back into the warehouse stock.

Defined in:

Parameters:

#number delay

Delay in seconds.

The set of cargo groups that was delivered to the warehouse itself.

Pending self request.

Triggers the FSM event "Start" after a delay.

Starts the warehouse. Initializes parameters and starts event handlers.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Status" after a delay.

Queue is updated and requests are executed.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Stop" after a delay.

Stops the warehouse and all its event handlers. All waiting and pending queue items are deleted as well and all assets are removed from stock.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Unpause" after a delay.

Unpauses the warehouse. Processing of queued requests is resumed.

Defined in:

Parameter:

#number delay

Delay in seconds.

On after "AddAsset" event.

Add a group to the warehouse stock. If the group is alive, it is destroyed.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Group or template group to be added to the warehouse stock.

#number ngroups

Number of groups to add to the warehouse stock. Default is 1.

#WAREHOUSE.Attribute forceattribute

(Optional) Explicitly force a generalized attribute for the asset. This has to be an WAREHOUSE.Attribute.

#number forcecargobay

(Optional) Explicitly force cargobay weight limit in kg for cargo carriers. This is for each unit of the group.

#number forceweight

(Optional) Explicitly force weight in kg of each unit in the group.

#number loadradius

(Optional) Radius in meters when the cargo is loaded into the carrier.

DCS#AI.Skill skill

Skill of the asset.

#table liveries

Table of livery names. When the asset is spawned one livery is chosen randomly.

#string assignment

A free to choose string specifying an assignment for the asset. This can be used with the WAREHOUSE.OnAfterNewAsset function.

#table other

(Optional) Table of other useful data. Can be collected via WAREHOUSE.OnAfterNewAsset() function for example

On after "AddRequest" event.

Add a request to the warehouse queue, which is processed when possible.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#WAREHOUSE warehouse

The warehouse requesting supply.

#WAREHOUSE.Descriptor AssetDescriptor

Descriptor describing the asset that is requested.

AssetDescriptorValue

Value of the asset descriptor. Type depends on descriptor, i.e. could be a string, etc.

#number nAsset

Number of groups requested that match the asset specification.

#WAREHOUSE.TransportType TransportType

Type of transport.

#number nTransport

Number of transport units requested.

#number Prio

Priority of the request. Number ranging from 1=high to 100=low.

#string Assignment

A keyword or text that can later be used to identify this request and postprocess the assets.

On after "AirbaseCaptured" event.

Airbase of warehouse has been captured by another coalition.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

DCS#coalition.side Coalition

which captured the warehouse.

On after "AirbaseRecaptured" event.

Airbase of warehouse has been re-captured from other coalition.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

DCS#coalition.side Coalition

Coalition side which originally captured the warehouse.

On after "Arrived" event.

Triggered when a group has arrived at its destination warehouse. The routine should be called by the warehouse sending this asset and not by the receiving warehouse. It is checked if this asset is cargo (or self propelled) or transport. If it is cargo it is put into the stock of receiving warehouse. If it is a transporter it is put back into the sending warehouse since transports are supposed to return their home warehouse.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The group that was delivered.

On after "AssetDead" event triggered when an asset group died.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The asset that is dead.

The request of the dead asset.

On after "AssetSpawned" event triggered when an asset group is spawned into the cruel world.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The group spawned.

The asset that is dead.

The request of the dead asset.

On after "Attacked" event.

Warehouse is under attack by an another coalition.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

DCS#coalition.side Coalition

which is attacking the warehouse.

DCS#country.id Country

which is attacking the warehouse.

On after "Captured" event.

Warehouse has been captured by another coalition.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

DCS#coalition.side Coalition

which captured the warehouse.

DCS#country.id Country

which has captured the warehouse.

On after "ChangeCountry" event.

Warehouse is respawned with the specified country. All queued requests are deleted and the owned airbase is reset if the coalition is changed by changing the country.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

DCS#country.id Country

Country which has captured the warehouse.

On after "Defeated" event.

Warehouse defeated an attack by another coalition. Defender assets are added back to warehouse stock.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Delivered" event.

Triggered when all asset groups have reached their destination. Corresponding request is deleted from the pending queue.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The pending request that is finished and deleted from the pending queue.

On after "Destroyed" event.

Warehouse was destroyed. All services are stopped. Warehouse is going to "Stopped" state in one minute.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Load" event.

Warehouse assets are loaded from file on disk.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#string path

Path where the file is loaded from.

#string filename

(Optional) Name of the file containing the asset data.

On after "NewAsset" event.

A new asset has been added to the warehouse stock.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The asset that has just been added.

#string assignment

The (optional) assignment for the asset.

On after "Pause" event.

Pauses the warehouse, i.e. no requests are processed. However, new requests and new assets can be added in this state.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Request" event.

Spawns the necessary cargo and transport assets.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Information table of the request.

On after "RequestSpawned" event.

Initiates the transport of the assets to the requesting warehouse.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Information table of the request.

Core.Set#SET_GROUP CargoGroupSet

Set of cargo groups.

Core.Set#SET_GROUP TransportGroupSet

Set of transport groups if any.

Respawn warehouse.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Restart" event.

Restarts the warehouse when it was in stopped state by reactivating the event handlers only.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "RunwayDestroyed" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "RunwayRepaired" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Save" event.

Warehouse assets are saved to file on disk.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#string path

Path where the file is saved. If nil, file is saved in the DCS root installtion directory.

#string filename

(Optional) Name of the file containing the asset data.

On after "SelfRequest" event.

Request was initiated to the warehouse itself. Groups are just spawned at the warehouse or the associated airbase. If the warehouse is currently under attack when the self request is made, the self request is added to the defending table. One the attack is defeated, this request is used to put the groups back into the warehouse stock.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The set of asset groups that was delivered to the warehouse itself.

Pending self request.

On after Start event.

Starts the warehouse. Addes event handlers and schedules status updates of reqests and queue.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after Status event.

Checks the queue and handles requests.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Stop" event.

Stops the warehouse, unhandles all events.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Unloaded" event.

Triggered when a group was unloaded from the carrier.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The group that was delivered.

On after "Unpause" event.

Unpauses the warehouse, i.e. requests in queue are processed again.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On before "AddRequest" event.

Checks some basic properties of the given parameters.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#WAREHOUSE warehouse

The warehouse requesting supply.

#WAREHOUSE.Descriptor AssetDescriptor

Descriptor describing the asset that is requested.

AssetDescriptorValue

Value of the asset descriptor. Type depends on descriptor, i.e. could be a string, etc.

#number nAsset

Number of groups requested that match the asset specification.

#WAREHOUSE.TransportType TransportType

Type of transport.

#number nTransport

Number of transport units requested.

#number Prio

Priority of the request. Number ranging from 1=high to 100=low.

#string Assignment

A keyword or text that later be used to identify this request and postprocess the assets.

Return value:

#boolean:

If true, request is okay at first glance.

On before "Arrived" event.

Triggered when a group has arrived at its destination warehouse.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The group that was delivered.

On before "Captured" event.

Warehouse has been captured by another coalition.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

DCS#coalition.side Coalition

which captured the warehouse.

DCS#country.id Country

which has captured the warehouse.

On before "ChangeCountry" event.

Checks whether a change of country is necessary by comparing the actual country to the the requested one.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

DCS#country.id Country

which has captured the warehouse.

On before "Load" event.

Checks if the file the warehouse data should be loaded from exists.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#string path

Path where the file is loaded from.

#string filename

(Optional) Name of the file containing the asset data.

On before "Request" event.

Checks if the request can be fulfilled.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Information table of the request.

Return value:

#boolean:

If true, request is granted.

Field(s)

#string LEGION.ClassName

Name of the class.

Ops.Chief#CHIEF LEGION.chief

Chief of this legion.

#table LEGION.cohorts

Cohorts of this legion.

Ops.Commander#COMMANDER LEGION.commander

Commander of this legion.

LEGION.homebase

Set home base.

LEGION.homezone

Set home zone.

#string LEGION.lid

Class id string for output to DCS log file.

#table LEGION.missionqueue

Mission queue table.

#table LEGION.transportqueue

Transport queue.

#number LEGION.verbose

Verbosity of output.

#string LEGION.version

LEGION class version.

Function(s)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

An sub-process FSM.

#table ReturnEvents

A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.

Return value:

The SubFSM.

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Add a new transition rule to the FSM.

A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

#string To

The To state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns the End states.

Defined in:

Return value:

#table:

End states.

Defined in:

Parameters:

From

Event

Returns a table of the SubFSM rules defined within the FSM.

Defined in:

Return value:

#table:

Sub processes.

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

Returns a table of the transition rules defined within the FSM.

Defined in:

Return value:

#table:

Transitions.

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

Creates a new FSM object.

Defined in:

Return value:

#FSM:

Defined in:

Parameters:

From

Event

Fsm

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

Call handler.

Defined in:

Parameters:

#string step

Step "onafter", "onbefore", "onenter", "onleave".

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

Value.

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

#string LEGION.ClassName

Name of the class.

Ops.Chief#CHIEF LEGION.chief

Chief of this legion.

#table LEGION.cohorts

Cohorts of this legion.

Ops.Commander#COMMANDER LEGION.commander

Commander of this legion.

LEGION.homebase

Set home base.

LEGION.homezone

Set home zone.

#string LEGION.lid

Class id string for output to DCS log file.

#table LEGION.missionqueue

Mission queue table.

#table LEGION.transportqueue

Transport queue.

#number LEGION.verbose

Verbosity of output.

#string LEGION.version

LEGION class version.

Function(s)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

IniObjectCategory

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

IniObjectCategory

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

The ClassName + ClassID is formatted as '%s#%09d'.

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Core.Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Return value:

#number:

The Core.Event processing Priority.

This is the worker method to retrieve the Parent class.

Note that the Parent class must be passed to call the parent class method.

self:GetParent(self):ParentMethod()

Defined in:

Parameters:

#BASE Child

This is the Child class from which the Parent class needs to be retrieved.

#BASE FromClass

(Optional) The class from which to get the parent.

Return value:

Get a Value given a Key from the Object.

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

Return value:

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

Subscribe to a DCS Event.

Defined in:

Parameters:

Event ID.

#function EventFunction

(optional) The function to be called when the event occurs for the unit.

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

This is the worker method to inherit from a parent class.

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

This is the worker method to check if an object is an (sub)instance of a class.

Examples:

  • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

Defined in:

Parameter:

ClassName

is the name of the class or the class itself to run the check against

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

function EVENT:New()
  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
  return self
end

Defined in:

Return value:

Occurs when an Event for an object is triggered.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.

Defined in:

Parameter:

The EventData structure.

BDA.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a ground unit captures either an airbase or a farp.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft crashes into the ground and is completely destroyed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

Unknown precisely what creates this event, likely tied into newer damage model.

Will update this page when new information become available.

  • initiator: The unit that had the failure.

Defined in:

Parameter:

The EventData structure.

Discard chair after ejection.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator : The unit that has ejected

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

Occurs on the death of a unit.

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. Have a look at the class Core.Event#EVENT as these are just the prototypes.

  • initiator: The unit that killed the target
  • target: Target Object
  • weapon: Weapon Object

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator : The unit that has landed place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. Have a look at the class Core.Event#EVENT as these are just the prototypes.

  • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
  • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
  • subplace: is always 0 for unknown reasons.

Defined in:

Parameter:

The EventData structure.

Landing quality mark.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Weapon add.

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

The EventData structure.

Occurs when a player enters a slot and takes control of an aircraft.

Have a look at the class Core.Event#EVENT as these are just the prototypes. NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

Occurs when any player relieves control of a unit to the AI.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft connects with a tanker and begins taking on fuel.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit begins firing a weapon that has a high rate of fire.

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft takes off from an airbase, farp, or ship.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

Trigger zone.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

  • initiator: The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#string:

The Schedule ID of the planned schedule.

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#number Repeat

Specifies the interval in seconds when the scheduler will call the event function.

#number RandomizeFactor

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

#number Stop

Specifies the amount of seconds when the scheduler will be stopped.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#string:

The Schedule ID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

Set the Class Core.Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Parameter:

#number EventPriority

The Core.Event processing Priority.

Return value:

self

Set a state or property of the Object given a Key and a Value.

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that will hold the Value set by the Key.

Key

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Class name.

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

Method.

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:


  -- Switch the tracing On
  BASE:TraceOnOff( true )

  -- Switch the tracing Off
  BASE:TraceOnOff( false )

UnSubscribe to a DCS event.

Defined in:

Parameter:

Event ID.

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

The main event handling function...

This function captures all events generated for the class.

Defined in:

Parameter:

DCS#Event event