From 4d9bcbe6b7a46c82ecfcbe8230125e1549662849 Mon Sep 17 00:00:00 2001 From: svenvandevelde Date: Sun, 25 Oct 2015 10:41:34 +0100 Subject: [PATCH] Documentation --- doc/classes/CARGO.html | 211 ++++++ doc/classes/CLEANUP.html | 207 ++++++ doc/classes/CLIENT.html | 556 ++++++++++++++ doc/classes/DATABASE.html | 419 +++++++++++ doc/classes/DEPLOYTASK.html | 167 +++++ doc/classes/DESTROYBASETASK.html | 216 ++++++ doc/classes/DESTROYGROUPSTASK.html | 241 +++++++ doc/classes/DESTROYRADARSTASK.html | 184 +++++ doc/classes/DESTROYUNITTYPESTASK.html | 205 ++++++ doc/classes/GOHOMETASK.html | 146 ++++ doc/classes/MENU.html | 102 +++ doc/classes/MESSAGE.html | 351 +++++++++ doc/classes/MISSION.html | 973 +++++++++++++++++++++++++ doc/classes/MOVEMENT.html | 263 +++++++ doc/classes/NOTASK.html | 163 +++++ doc/classes/PICKUPTASK.html | 146 ++++ doc/classes/ROUTETASK.html | 189 +++++ doc/classes/SEAD.html | 189 +++++ doc/classes/SLINGLOADHOOKTASK.html | 150 ++++ doc/classes/SLINGLOADUNHOOKTASK.html | 142 ++++ doc/classes/SPAWN.html | 995 ++++++++++++++++++++++++++ doc/classes/STAGE.html | 104 +++ doc/classes/TASK.html | 952 ++++++++++++++++++++++++ doc/index.html | 214 ++++++ doc/ldoc.css | 307 ++++++++ doc/modules/cleanup.html | 307 ++++++++ doc/modules/routines.html | 210 ++++++ doc/modules/trace.html | 106 +++ doc/scripts/eStatHandler.html | 102 +++ doc/topics/manual.md.html | 178 +++++ 30 files changed, 8695 insertions(+) create mode 100644 doc/classes/CARGO.html create mode 100644 doc/classes/CLEANUP.html create mode 100644 doc/classes/CLIENT.html create mode 100644 doc/classes/DATABASE.html create mode 100644 doc/classes/DEPLOYTASK.html create mode 100644 doc/classes/DESTROYBASETASK.html create mode 100644 doc/classes/DESTROYGROUPSTASK.html create mode 100644 doc/classes/DESTROYRADARSTASK.html create mode 100644 doc/classes/DESTROYUNITTYPESTASK.html create mode 100644 doc/classes/GOHOMETASK.html create mode 100644 doc/classes/MENU.html create mode 100644 doc/classes/MESSAGE.html create mode 100644 doc/classes/MISSION.html create mode 100644 doc/classes/MOVEMENT.html create mode 100644 doc/classes/NOTASK.html create mode 100644 doc/classes/PICKUPTASK.html create mode 100644 doc/classes/ROUTETASK.html create mode 100644 doc/classes/SEAD.html create mode 100644 doc/classes/SLINGLOADHOOKTASK.html create mode 100644 doc/classes/SLINGLOADUNHOOKTASK.html create mode 100644 doc/classes/SPAWN.html create mode 100644 doc/classes/STAGE.html create mode 100644 doc/classes/TASK.html create mode 100644 doc/index.html create mode 100644 doc/ldoc.css create mode 100644 doc/modules/cleanup.html create mode 100644 doc/modules/routines.html create mode 100644 doc/modules/trace.html create mode 100644 doc/scripts/eStatHandler.html create mode 100644 doc/topics/manual.md.html diff --git a/doc/classes/CARGO.html b/doc/classes/CARGO.html new file mode 100644 index 000000000..c1382cc4e --- /dev/null +++ b/doc/classes/CARGO.html @@ -0,0 +1,211 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class CARGO

+

CARGO

+

+ +

+ + +

Structures

+ + + + + + + + + +
CARGO.CARGO_TRANSPORTInternal Table to understand the form of the CARGO.
CARGO.CARGO_TYPECARGO_TYPE Defines the different types of transports, which has an impact on the menu commands shown in F10.
+ +
+
+ + +

Structures

+ + +
+
+ + CARGO.CARGO_TRANSPORT +
+
+ Internal Table to understand the form of the CARGO. + + +

Fields:

+
    +
  • UNIT + + + +
    • +
  • SLING + + + +
    • +
  • STATIC + + + +
    • +
  • INVISIBLE + + + +
    • +
+ + + + + +
+
+ + CARGO.CARGO_TYPE +
+
+ CARGO_TYPE Defines the different types of transports, which has an impact on the menu commands shown in F10. + + +

Fields:

+
    +
  • TROOPS + + + +
    • +
  • GOODS + + + +
    • +
  • VEHICLES + + + +
    • +
  • INFANTRY + + + +
    • +
  • ENGINEERS + + + +
    • +
  • PACKAGE + + + +
    • +
  • CARGO + + + +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/CLEANUP.html b/doc/classes/CLEANUP.html new file mode 100644 index 000000000..94922ab04 --- /dev/null +++ b/doc/classes/CLEANUP.html @@ -0,0 +1,207 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class CLEANUP

+

CLEANUP Classes

+

+ +

+

Info:

+
    +
  • Author: Flightcontrol
    • +
+ + +

Methods

+ + + + + + + + + + + + + +
CLEANUP:New (ZoneNames, TimeInterval)Creates the main object which is handling the cleaning of the debris within the given Zone Names.
CLEANUP:_EventAddForCleanUp (event)Detects if the Unit has an SEVENTENGINESHUTDOWN or an SEVENT_HIT within the given ZoneNames.
CLEANUP:_Scheduler ()At the defined time interval, CleanUp the Groups within the CleanUpList.
+ +
+
+ + +

Methods

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

Parameters:

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

Returns:

+
    + + CLEANUP + + + +
+ + + +

Usage:

+
    + 
    + -- Clean these Zones.
+ CleanUpAirports = CLEANUP:New( { 'CLEAN Tbilisi', 'CLEAN Kutaisi' }, 150 )
+ or
+ CleanUpTbilisi = CLEANUP:New( 'CLEAN Tbilisi', 150 )
+ CleanUpKutaisi = CLEANUP:New( 'CLEAN Kutaisi', 600 )
    +
+ +
+
+ + CLEANUP:_EventAddForCleanUp (event) +
+
+ Detects if the Unit has an SEVENTENGINESHUTDOWN or an SEVENT_HIT within the given ZoneNames. If this is the case, add the Group to the CLEANUP List. + + +

Parameters:

+
    +
  • event + + + +
    • +
+ + + + + +
+
+ + CLEANUP:_Scheduler () +
+
+ At the defined time interval, CleanUp the Groups within the CleanUpList. + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/CLIENT.html b/doc/classes/CLIENT.html new file mode 100644 index 000000000..8f8f54988 --- /dev/null +++ b/doc/classes/CLIENT.html @@ -0,0 +1,556 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class CLIENT

+

CLIENT Classes

+

+ +

+ + +

Tables

+ + + + + +
CLIENT.CLIENTClients are those Groups defined within the Mission Editor that have the skillset defined as "Client" or "Player".
+

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CLIENT:New (ClientName, ClientBriefing)Use this method to register new Clients within the MOF.
CLIENT:Reset (ClientName)Resets a CLIENT.
CLIENT:ClientGroup ()ClientGroup returns the Group of a Client.
CLIENT:Transport ()Transport defines that the Client is a Transport.
CLIENT:AddBriefing (ClientBriefing)AddBriefing adds a briefing to a Client when a Player joins a Mission.
CLIENT:IsTransport ()IsTransport returns if a Client is a transport.
CLIENT:FindCargo (CargoName)FindCargo finds loaded Cargo within a CLIENT instance.
CLIENT:ShowCargo ()ShowCargo shows the CARGO within the CLIENT to the Player.
CLIENT:AddCargo (CargoName, CargoGroupName, CargoType, CargoWeight, CargoGroupTemplate)AddCargo allows to add CARGO on the CLIENT.
CLIENT:RemoveCargo (CargoName)RemoveCargo removes CARGO from the CLIENT.
CLIENT:SwitchMessages (PrmTable)SwitchMessages is a local function called by the DCS World Menu system to switch off messages.
CLIENT:Message (Message, MessageDuration, MessageId, MessageCategory, MessageInterval)Message is the key Message driver for the CLIENT class.
+ +
+
+ + +

Tables

+ +
+
+ + CLIENT.CLIENT +
+
+ Clients are those Groups defined within the Mission Editor that have the skillset defined as "Client" or "Player". + These clients are defined within the Mission Orchestration Framework (MOF) + + +

Fields:

+
    +
  • ONBOARDSIDE + + + +
    • +
  • LEFT + + + +
    • +
  • RIGHT + + + +
    • +
  • BACK + + + +
    • +
  • FRONT + + + +
    • +
+ + + + + +
+
+

Methods

+ +
+
+ + CLIENT:New (ClientName, ClientBriefing) +
+
+ Use this method to register new Clients within the MOF. + + +

Parameters:

+
    +
  • ClientName + string + Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client. +
    • +
  • ClientBriefing + string + Text that describes the briefing of the mission when a Player logs into the Client. +
    • +
+ +

Returns:

+
    + + CLIENT + + + +
+ + + +

Usage:

+
    + 
    + -- Create new Clients.
+	local Mission = MISSIONSCHEDULER.AddMission( 'Russia Transport Troops SA-6', 'Operational', 'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.', 'Russia' )
+	Mission:AddGoal( DeploySA6TroopsGoal )
+
+	Mission:AddClient( CLIENT:New( 'RU MI-8MTV2*HOT-Deploy Troops 1' ):Transport() )
+	Mission:AddClient( CLIENT:New( 'RU MI-8MTV2*RAMP-Deploy Troops 3' ):Transport() )
+	Mission:AddClient( CLIENT:New( 'RU MI-8MTV2*HOT-Deploy Troops 2' ):Transport() )
+	Mission:AddClient( CLIENT:New( 'RU MI-8MTV2*RAMP-Deploy Troops 4' ):Transport() )
    +
+ +
+
+ + CLIENT:Reset (ClientName) +
+
+ Resets a CLIENT. + + +

Parameters:

+
    +
  • ClientName + string + Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client. +
    • +
+ + + + + +
+
+ + CLIENT:ClientGroup () +
+
+ ClientGroup returns the Group of a Client. + + + +

Returns:

+
    + + Group + + + +
+ + + + +
+
+ + CLIENT:Transport () +
+
+ Transport defines that the Client is a Transport. + + + +

Returns:

+
    + + CLIENT + + + +
+ + + + +
+
+ + CLIENT:AddBriefing (ClientBriefing) +
+
+ AddBriefing adds a briefing to a Client when a Player joins a Mission. + + +

Parameters:

+
    +
  • ClientBriefing + string + is the text defining the Mission briefing. +
    • +
+ +

Returns:

+
    + + CLIENT + + + +
+ + + + +
+
+ + CLIENT:IsTransport () +
+
+ IsTransport returns if a Client is a transport. + + + +

Returns:

+
    + + bool + + + +
+ + + + +
+
+ + CLIENT:FindCargo (CargoName) +
+
+ FindCargo finds loaded Cargo within a CLIENT instance. + Cargo is loaded when certain PICK-UP or DEPLOY Tasks are properly executed. + + +

Parameters:

+
    +
  • CargoName + string + is the name of the cargo. +
    • +
+ +

Returns:

+
    + + CARGO_TYPE + + + +
+ + + + +
+
+ + CLIENT:ShowCargo () +
+
+ ShowCargo shows the CARGO within the CLIENT to the Player. + The CARGO is shown throught the MESSAGE system of DCS World. + + + + + + + +
+
+ + CLIENT:AddCargo (CargoName, CargoGroupName, CargoType, CargoWeight, CargoGroupTemplate) +
+
+ AddCargo allows to add CARGO on the CLIENT. + + +

Parameters:

+
    +
  • CargoName + string + is the name of the CARGO. +
    • +
  • CargoGroupName + string + is the name of an active Group defined within the Mission Editor or Dynamically Spawned. Note that this is only applicable for Unit CARGO Types. +
    • +
  • CargoType + CARGO_TYPE + is the Type of the CARGO. +
    • +
  • CargoWeight + number + is the weight of the cargo in Kg. +
    • +
  • CargoGroupTemplate + string + is the name of an active Group defined within the Mission Editor with "Late Activation". +
    • +
+ +

Returns:

+
    + + CLIENT + + + +
+ + + + +
+
+ + CLIENT:RemoveCargo (CargoName) +
+
+ RemoveCargo removes CARGO from the CLIENT. + + +

Parameters:

+ + +

Returns:

+
    + + Cargo + + + +
+ + + + +
+
+ + CLIENT:SwitchMessages (PrmTable) +
+
+ SwitchMessages is a local function called by the DCS World Menu system to switch off messages. + + +

Parameters:

+
    +
  • PrmTable + + + +
    • +
+ + + + + +
+
+ + CLIENT:Message (Message, MessageDuration, MessageId, MessageCategory, MessageInterval) +
+
+ Message is the key Message driver for the CLIENT class. + This function displays various messages to the Player logged into the CLIENT through the DCS World Messaging system. + + +

Parameters:

+
    +
  • Message + string + is the text describing the message. +
    • +
  • MessageDuration + number + is the duration in seconds that the Message should be displayed. +
    • +
  • MessageId + string + is a text identifying the Message in the MessageQueue. The Message system overwrites Messages with the same MessageId +
    • +
  • MessageCategory + string + is the category of the message (the title). +
    • +
  • MessageInterval + number + is the interval in seconds between the display of the Message when the CLIENT is in the air. +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/DATABASE.html b/doc/classes/DATABASE.html new file mode 100644 index 000000000..b1e6000da --- /dev/null +++ b/doc/classes/DATABASE.html @@ -0,0 +1,419 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class DATABASE

+

Administers the Initial Sets of the Mission Templates as defined within the Mission Editor.

+

Administers the Spawning of new Groups within the DCSRTE and administers these new Groups within the DATABASE object(s).

+ + +

Methods

+ + + + + + + + + + + + + + + + + +
DATABASE:New ()Creates a new DATABASE Object to administer the Groups defined and alive within the DCSRTE.
DATABASE:Spawn (SpawnTemplate)Instantiate new Groups within the DCSRTE.
DATABASE:SetStatusGroup (GroupName, Status)Set a status to a Group within the Database, this to check crossing events for example.
DATABASE:GetStatusGroup (GroupName)Get a status to a Group within the Database, this to check crossing events for example.
+

Private

+ + + + + + + + + + + + + + + + + +
DATABASE:_RegisterGroup (GroupTemplate)Registers new Group Templates within the DATABASE Object.
DATABASE:_AddPlayerFromUnit (UnitData)Add a new player entering a Unit.
DATABASE:_AddMissionTaskScore (PlayerUnit, MissionName, Score)Registers Scores the players completing a Mission Task.
DATABASE:_AddMissionScore (MissionName, Score)Registers Mission Scores for possible multiple players that contributed in the Mission.
+

Events

+ + + + + +
DATABASE:OnDeadOrCrash (event)Track DCSRTE DEAD or CRASH events for the internal scoring.
+

Scheduled

+ + + + + +
DATABASE:_FollowPlayers ()Follows new players entering Clients within the DCSRTE.
+ +
+
+ + +

Methods

+ +
+
+ + DATABASE:New () +
+
+ Creates a new DATABASE Object to administer the Groups defined and alive within the DCSRTE. + + + +

Returns:

+
    + + DATABASE + + + +
+ + + +

Usage:

+
    + 
    + -- Define a new DATABASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
+ DBObject = DATABASE:New()
    +
+ +
+
+ + DATABASE:Spawn (SpawnTemplate) +
+
+ Instantiate new Groups within the DCSRTE. + This method expects EXACTLY the same structure as a structure within the ME, and needs 2 additional fields defined: + SpawnCountryID, SpawnCategoryID + This method is used by the SPAWN class. + + +

Parameters:

+
    +
  • SpawnTemplate + + + +
    • +
+ + + + + +
+
+ + DATABASE:SetStatusGroup (GroupName, Status) +
+
+ Set a status to a Group within the Database, this to check crossing events for example. + + +

Parameters:

+
    +
  • GroupName + + + +
    • +
  • Status + + + +
    • +
+ + + + + +
+
+ + DATABASE:GetStatusGroup (GroupName) +
+
+ Get a status to a Group within the Database, this to check crossing events for example. + + +

Parameters:

+
    +
  • GroupName + + + +
    • +
+ + + + + +
+
+

Private

+ + +
+
+ + DATABASE:_RegisterGroup (GroupTemplate) +
+
+ Registers new Group Templates within the DATABASE Object. + + +

Parameters:

+
    +
  • GroupTemplate + + + +
    • +
+ + + + + +
+
+ + DATABASE:_AddPlayerFromUnit (UnitData) +
+
+ Add a new player entering a Unit. + + +

Parameters:

+
    +
  • UnitData + + + +
    • +
+ + + + + +
+
+ + DATABASE:_AddMissionTaskScore (PlayerUnit, MissionName, Score) +
+
+ Registers Scores the players completing a Mission Task. + + +

Parameters:

+
    +
  • PlayerUnit + + + +
    • +
  • MissionName + + + +
    • +
  • Score + + + +
    • +
+ + + + + +
+
+ + DATABASE:_AddMissionScore (MissionName, Score) +
+
+ Registers Mission Scores for possible multiple players that contributed in the Mission. + + +

Parameters:

+
    +
  • MissionName + + + +
    • +
  • Score + + + +
    • +
+ + + + + +
+
+

Events

+ + +
+
+ + DATABASE:OnDeadOrCrash (event) +
+
+ Track DCSRTE DEAD or CRASH events for the internal scoring. + + +

Parameters:

+
    +
  • event + + + +
    • +
+ + + + + +
+
+

Scheduled

+ + +
+
+ + DATABASE:_FollowPlayers () +
+
+ Follows new players entering Clients within the DCSRTE. + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/DEPLOYTASK.html b/doc/classes/DEPLOYTASK.html new file mode 100644 index 000000000..2fef954a7 --- /dev/null +++ b/doc/classes/DEPLOYTASK.html @@ -0,0 +1,167 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class DEPLOYTASK

+

A DEPLOYTASK orchestrates the deployment of CARGO within a specific landing zone.

+

+ +

+ + +

Methods

+ + + + + + + + + +
DEPLOYTASK:New (LandingZones, CargoType)Creates a new DEPLOYTASK object, which models the sequence of STAGEs to unload a cargo.
DEPLOYTASK:SetCargoTargetZoneName (TargetZoneName)When the cargo is unloaded, it will move to the target zone name.
+ +
+
+ + +

Methods

+ +
+
+ + DEPLOYTASK:New (LandingZones, CargoType) +
+
+ Creates a new DEPLOYTASK object, which models the sequence of STAGEs to unload a cargo. + + +

Parameters:

+ + + + + + +
+
+ + DEPLOYTASK:SetCargoTargetZoneName (TargetZoneName) +
+
+ When the cargo is unloaded, it will move to the target zone name. + + +

Parameters:

+
    +
  • TargetZoneName + string + Name of the Zone to where the Cargo should move after unloading. +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/DESTROYBASETASK.html b/doc/classes/DESTROYBASETASK.html new file mode 100644 index 000000000..11d3ef4cc --- /dev/null +++ b/doc/classes/DESTROYBASETASK.html @@ -0,0 +1,216 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class DESTROYBASETASK

+

A DESTROYBASETASK will monitor the destruction of Groups and Units.

+

This is a BASE class, other classes are derived from this class.

+ + +

Methods

+ + + + + + + + + + + + + +
DESTROYBASETASK:New (DestroyGroupType, DestroyUnitType, DestroyGroupPrefixes, DestroyPercentage)Creates a new DESTROYBASETASK.
DESTROYBASETASK:EventDead (event)Handle the SEVENTDEAD events to validate the destruction of units for the task monitoring.
DESTROYBASETASK:ReportGoalProgress (DestroyGroup, DestroyUnit)Validate task completeness of DESTROYBASETASK.
+ +
+
+ + +

Methods

+ +
+
+ + DESTROYBASETASK:New (DestroyGroupType, DestroyUnitType, DestroyGroupPrefixes, DestroyPercentage) +
+
+ Creates a new DESTROYBASETASK. + + +

Parameters:

+
    +
  • DestroyGroupType + string + Text describing the group to be destroyed. f.e. "Radar Installations", "Ships", "Vehicles", "Command Centers". +
    • +
  • DestroyUnitType + string + Text describing the unit types to be destroyed. f.e. "SA-6", "Row Boats", "Tanks", "Tents". +
    • +
  • DestroyGroupPrefixes + table{string,...} + Table of Prefixes of the Groups to be destroyed before task is completed. +
    • +
  • DestroyPercentage + optional number + defines the %-tage that needs to be destroyed to achieve mission success. eg. If in the Group there are 10 units, then a value of 75 would require 8 units to be destroyed from the Group to complete the TASK. +
    • +
+ +

Returns:

+
    + + DESTROYBASETASK + + + +
+ + + + +
+
+ + DESTROYBASETASK:EventDead (event) +
+
+ Handle the SEVENTDEAD events to validate the destruction of units for the task monitoring. + + +

Parameters:

+
    +
  • event + +
        Event structure of DCS world.
+
    + +
    • +
+ + + + + +
+
+ + DESTROYBASETASK:ReportGoalProgress (DestroyGroup, DestroyUnit) +
+
+ Validate task completeness of DESTROYBASETASK. + + +

Parameters:

+
    +
  • DestroyGroup + +
        Group structure describing the group to be evaluated.
+
    + +
    • +
  • DestroyUnit + +
        Unit structure describing the Unit to be evaluated.
+
    + +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/DESTROYGROUPSTASK.html b/doc/classes/DESTROYGROUPSTASK.html new file mode 100644 index 000000000..add401e20 --- /dev/null +++ b/doc/classes/DESTROYGROUPSTASK.html @@ -0,0 +1,241 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class DESTROYGROUPSTASK

+

DESTROYGROUPSTASK

+

+ +

+ + +

Tables

+ + + + + +
DESTROYGROUPSTASK.DESTROYGROUPSTASKTo monitor and score the destruction of Groups in the DCSRTE.
+

Methods

+ + + + + + + + + +
DESTROYGROUPSTASK:New (DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyPercentage)Creates a new DESTROYGROUPSTASK.
DESTROYGROUPSTASK:ReportGoalProgress (DestroyGroup, DestroyUnit)Report Goal Progress.
+ +
+
+ + +

Tables

+ +
+
+ + DESTROYGROUPSTASK.DESTROYGROUPSTASK +
+
+ To monitor and score the destruction of Groups in the DCSRTE. + + +

Fields:

+
    +
  • ClassName + + + +
    • +
  • GoalVerb + + + +
    • +
+ + + + + +
+
+

Methods

+ +
+
+ + DESTROYGROUPSTASK:New (DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyPercentage) +
+
+ Creates a new DESTROYGROUPSTASK. + + +

Parameters:

+
    +
  • DestroyGroupType + string + +
    String describing the group to be destroyed.
+
    + +
    • +
  • DestroyUnitType + string + +
    String describing the unit to be destroyed.
+
    + +
    • +
  • DestroyGroupNames + table{string,...} + +
    Table of string containing the name of the groups to be destroyed before task is completed.
+
    + +
    • +
  • DestroyPercentage + optional number + defines the %-tage that needs to be destroyed to achieve mission success. eg. If in the Group there are 10 units, then a value of 75 would require 8 units to be destroyed from the Group to complete the TASK. +
    • +
+ +

Returns:

+
    + + DESTROYGROUPSTASK + + + +
+ + + + +
+
+ + DESTROYGROUPSTASK:ReportGoalProgress (DestroyGroup, DestroyUnit) +
+
+ Report Goal Progress. + + +

Parameters:

+
    +
  • DestroyGroup + Group + +
        Group structure describing the group to be evaluated.
+
    + +
    • +
  • DestroyUnit + Unit + +
        Unit structure describing the Unit to be evaluated.
+
    + +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/DESTROYRADARSTASK.html b/doc/classes/DESTROYRADARSTASK.html new file mode 100644 index 000000000..6000e1199 --- /dev/null +++ b/doc/classes/DESTROYRADARSTASK.html @@ -0,0 +1,184 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class DESTROYRADARSTASK

+

Task class to destroy radar installations.

+

+ +

+ + +

Methods

+ + + + + + + + + +
DESTROYRADARSTASK:New (DestroyGroupNames)Creates a new DESTROYRADARSTASK.
DESTROYRADARSTASK:ReportGoalProgress (DestroyGroup, DestroyUnit)Report Goal Progress.
+ +
+
+ + +

Methods

+ +
+
+ + DESTROYRADARSTASK:New (DestroyGroupNames) +
+
+ Creates a new DESTROYRADARSTASK. + + +

Parameters:

+
    +
  • DestroyGroupNames + table{string,...} + +
    Table of string containing the group names of which the radars are be destroyed.
+
    + +
    • +
+ +

Returns:

+
    + + DESTROYRADARSTASK + + + +
+ + + + +
+
+ + DESTROYRADARSTASK:ReportGoalProgress (DestroyGroup, DestroyUnit) +
+
+ Report Goal Progress. + + +

Parameters:

+
    +
  • DestroyGroup + Group + +
        Group structure describing the group to be evaluated.
+
    + +
    • +
  • DestroyUnit + Unit + +
        Unit structure describing the Unit to be evaluated.
+
    + +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/DESTROYUNITTYPESTASK.html b/doc/classes/DESTROYUNITTYPESTASK.html new file mode 100644 index 000000000..543f21e2d --- /dev/null +++ b/doc/classes/DESTROYUNITTYPESTASK.html @@ -0,0 +1,205 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class DESTROYUNITTYPESTASK

+

Set TASK to destroy certain unit types.

+

+ +

+ + +

Methods

+ + + + + + + + + +
DESTROYUNITTYPESTASK:New (DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyUnitTypes)Creates a new DESTROYUNITTYPESTASK.
DESTROYUNITTYPESTASK:ReportGoalProgress (DestroyGroup, DestroyUnit)Report Goal Progress.
+ +
+
+ + +

Methods

+ +
+
+ + DESTROYUNITTYPESTASK:New (DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyUnitTypes) +
+
+ Creates a new DESTROYUNITTYPESTASK. + + +

Parameters:

+
    +
  • DestroyGroupType + string + +
        String describing the group to be destroyed. f.e. "Radar Installations", "Fleet", "Batallion", "Command Centers".
+
    + +
    • +
  • DestroyUnitType + string + +
        String describing the unit to be destroyed. f.e. "radars", "ships", "tanks", "centers".
+
    + +
    • +
  • DestroyGroupNames + table{string,...} + +
    Table of string containing the group names of which the radars are be destroyed.
+
    + +
    • +
  • DestroyUnitTypes + string + +
        Table of string containing the type names of the units to achieve mission success.
+
    + +
    • +
+ +

Returns:

+
    + + DESTROYUNITTYPESTASK + + + +
+ + + + +
+
+ + DESTROYUNITTYPESTASK:ReportGoalProgress (DestroyGroup, DestroyUnit) +
+
+ Report Goal Progress. + + +

Parameters:

+
    +
  • DestroyGroup + Group + +
        Group structure describing the group to be evaluated.
+
    + +
    • +
  • DestroyUnit + Unit + +
        Unit structure describing the Unit to be evaluated.
+
    + +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/GOHOMETASK.html b/doc/classes/GOHOMETASK.html new file mode 100644 index 000000000..29b6693b5 --- /dev/null +++ b/doc/classes/GOHOMETASK.html @@ -0,0 +1,146 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class GOHOMETASK

+

A GOHOMETASK orchestrates the travel back to the home base, which is a specific zone defined within the ME.

+

+ +

+ + +

Methods

+ + + + + +
GOHOMETASK:New (LandingZones)Creates a new GOHOMETASK.
+ +
+
+ + +

Methods

+ +
+
+ + GOHOMETASK:New (LandingZones) +
+
+ Creates a new GOHOMETASK. + + +

Parameters:

+ + +

Returns:

+
    + + GOHOMETASK + + + +
+ + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/MENU.html b/doc/classes/MENU.html new file mode 100644 index 000000000..5adda5de0 --- /dev/null +++ b/doc/classes/MENU.html @@ -0,0 +1,102 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class MENU

+

Encapsulation of DCS World Menu system in a set of MENU classes.

+

+ +

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/MESSAGE.html b/doc/classes/MESSAGE.html new file mode 100644 index 000000000..bb2bdb87f --- /dev/null +++ b/doc/classes/MESSAGE.html @@ -0,0 +1,351 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class MESSAGE

+

Message System to display Messages for Clients and Coalitions or All.

+

Messages are grouped on the display panel per Category to improve readability for the players. + Messages are shown on the display panel for an amount of seconds, and will then disappear. + Messages are identified by an ID. The messages with the same ID belonging to the same category will be overwritten if they were still being displayed on the display panel. + Messages are created with MESSAGE:New(). + Messages are sent to Clients with MESSAGE:ToClient(). + Messages are sent to Coalitions with MESSAGE:ToCoalition(). + Messages are sent to All Players with MESSAGE:ToAll().

+ + +

Methods

+ + + + + + + + + + + + + + + + + +
MESSAGE:New (MessageText, MessageCategory, MessageDuration, MessageID)Creates a new MESSAGE object.
MESSAGE:ToClient (Client)Sends a MESSAGE to a Client Group.
MESSAGE:ToCoalition (CoalitionSide)Sends a MESSAGE to a Coalition.
MESSAGE:ToAll ()Sends a MESSAGE to all players.
+

Class MESSAGEQUEUE

+ + + + + + + + + +
MESSAGEQUEUE:_DisplayMessages ()This function is called automatically by the MESSAGEQUEUE scheduler.
MESSAGE._MessageQueueThe _MessageQueue object is created when the MESSAGE class module is loaded.
+ +
+
+ + +

Methods

+ +
+
+ + MESSAGE:New (MessageText, MessageCategory, MessageDuration, MessageID) +
+
+ Creates a new MESSAGE object. Note that these MESSAGE objects are not yet displayed on the display panel. You must use the functions ToClient or ToCoalition or ToAll to send these Messages to the respective recipients. + + +

Parameters:

+
    +
  • MessageText + string + is the text of the Message. +
    • +
  • MessageCategory + string + is a string expressing the Category of the Message. Messages are grouped on the display panel per Category to improve readability. +
    • +
  • MessageDuration + number + is a number in seconds of how long the MESSAGE should be shown on the display panel. +
    • +
  • MessageID + string + is a string expressing the ID of the Message. +
    • +
+ +

Returns:

+
    + + MESSAGE + + + +
+ + + +

Usage:

+
    + 
    + -- Create a series of new Messages.
+ -- MessageAll is meant to be sent to all players, for 25 seconds, and is classified as "Score".
+ -- MessageRED is meant to be sent to the RED players only, for 10 seconds, and is classified as "End of Mission", with ID "Win".
+ -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
+ -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
+ MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" )
+ MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
+ MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" )
+ MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" )
    +
+ +
+
+ + MESSAGE:ToClient (Client) +
+
+ Sends a MESSAGE to a Client Group. Note that the Group needs to be defined within the ME with the skillset "Client" or "Player". + + +

Parameters:

+
    +
  • Client + CLIENT + is the Group of the Client. +
    • +
+ +

Returns:

+
    + + MESSAGE + + + +
+ + + +

Usage:

+
    + 
    + -- Send the 2 messages created with the New method to the Client Group.
+ -- Note that the Message of MessageClient2 is overwriting the Message of MessageClient1.
+ ClientGroup = Group.getByName( "ClientGroup" )
+
+ MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
+ MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
+ or
+ MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
+ MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
+ or
+ MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" )
+ MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" )
+ MessageClient1:ToClient( ClientGroup )
+ MessageClient2:ToClient( ClientGroup )
    +
+ +
+
+ + MESSAGE:ToCoalition (CoalitionSide) +
+
+ Sends a MESSAGE to a Coalition. + + +

Parameters:

+
    +
  • CoalitionSide + needs to be filled out by the defined structure of the standard scripting engine ???. +
    • +
+ +

Returns:

+
    + + MESSAGE + + + +
+ + + +

Usage:

+
    + 
    + -- Send a message created with the New method to the RED coalition.
+ MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
+ or
+ MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
+ or
+ MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
+ MessageRED:ToCoalition( coalition.side.RED )
    +
+ +
+
+ + MESSAGE:ToAll () +
+
+ Sends a MESSAGE to all players. + + + +

Returns:

+
    + + MESSAGE + + + +
+ + + +

Usage:

+
    + 
    + -- Send a message created to all players.
+ MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
+ or
+ MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
+ or
+ MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" )
+ MessageAll:ToAll()
    +
+ +
+
+

Class MESSAGEQUEUE

+ + MESSAGEQUEUE +
+
+ + MESSAGEQUEUE:_DisplayMessages () +
+
+ This function is called automatically by the MESSAGEQUEUE scheduler. + + + + + + + +
+
+ + MESSAGE._MessageQueue +
+
+ The _MessageQueue object is created when the MESSAGE class module is loaded. + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/MISSION.html b/doc/classes/MISSION.html new file mode 100644 index 000000000..724c88e11 --- /dev/null +++ b/doc/classes/MISSION.html @@ -0,0 +1,973 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class MISSION

+

A MISSION is the main owner of a Mission orchestration within MOOSE .

+

The Mission framework orchestrates CLIENTs, TASKs, STAGEs etc. + A CLIENT needs to be registered within the MISSION through the function AddClient. A TASK needs to be registered within the MISSION through the function AddTask.

+ + +

Tables

+ + + + + +
MISSION.SpawnCargoAdd Cargo to the mission...
+

Issues

+ + + + + + + + + +
MISSION.SpawnCargo-todo1check this
MISSION.SpawnCargo-todo1-todo2check this
+

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MISSION:New (MissionName, MissionPriority, MissionBriefing, MissionCoalition)This is the main MISSION declaration method.
MISSION:IsCompleted ()Returns if a Mission has completed.
MISSION:Completed ()Set a Mission to completed.
MISSION:IsOngoing ()Returns if a Mission is ongoing.
MISSION:Ongoing ()Set a Mission to ongoing.
MISSION:IsPending ()Returns if a Mission is pending.
MISSION:Pending ()Set a Mission to pending.
MISSION:IsFailed ()Returns if a Mission has failed.
MISSION:Failed ()Set a Mission to failed.
MISSION:StatusToClients ()Send the status of the MISSION to all Clients.
MISSION:ReportTrigger ()Handles the reporting.
MISSION:ReportToAll ()Report the status of all MISSIONs to all active Clients.
MISSION:AddGoalFunction (GoalFunction)Add a goal function to a MISSION.
MISSION:ShowBriefing (Client)Show the briefing of the MISSION to the CLIENT.
MISSION:AddClient (Client)Register a new CLIENT to participate within the mission.
MISSION:FindClient (ClientName)Find a CLIENT object within the MISSION by its ClientName.
MISSION:AddTask (Task, TaskNumber)Register a TASK to be completed within the MISSION.
MISSION:GetTask (TaskNumber)Get the TASK idenified by the TaskNumber from the Mission.
MISSION:GetTasks ()Get all the TASKs from the Mission.
+

Class MISSIONSCHEDULER

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MISSIONSCHEDULER.Scheduler ()This is the main MISSIONSCHEDULER Scheduler function.
MISSIONSCHEDULER.Start ()Start the MISSIONSCHEDULER.
MISSIONSCHEDULER.Stop ()Stop the MISSIONSCHEDULER.
MISSIONSCHEDULER.AddMission (Mission)This is the main MISSION declaration method.
MISSIONSCHEDULER.RemoveMission (MissionName)Remove a MISSION from the MISSIONSCHEDULER.
MISSIONSCHEDULER.FindMission (MissionName)Find a MISSION within the MISSIONSCHEDULER.
MISSIONSCHEDULER.ReportMenu ()Enables a MENU option in the communications menu under F10 to control the status of the active missions.
MISSIONSCHEDULER:TimeShow ()Show the remaining mission time.
+ +
+
+ + +

Tables

+ +
+
+ + MISSION.SpawnCargo +
+
+ Add Cargo to the mission... Cargo functionality needs to be reworked a bit, so this is still under construction. I need to make a CARGO Class... + + + + + + + +
+
+

Issues

+ +
+
+ + MISSION.SpawnCargo-todo1 +
+
+ check this + + + + + + + +
+
+ + MISSION.SpawnCargo-todo1-todo2 +
+
+ check this + + + + + + + +
+
+

Methods

+ +
+
+ + MISSION:New (MissionName, MissionPriority, MissionBriefing, MissionCoalition) +
+
+ This is the main MISSION declaration method. Each Mission is like the master or a Mission orchestration between, Clients, Tasks, Stages etc. + + +

Parameters:

+
    +
  • MissionName + string + is the name of the mission. This name will be used to reference the status of each mission by the players. +
    • +
  • MissionPriority + string + is a string indicating the "priority" of the Mission. f.e. "Primary", "Secondary" or "First", "Second". It is free format and up to the Mission designer to choose. There are no rules behind this field. +
    • +
  • MissionBriefing + string + is a string indicating the mission briefing to be shown when a player joins a CLIENT. +
    • +
  • MissionCoalition + string + is a string indicating the coalition or party to which this mission belongs to. It is free format and can be chosen freely by the mission designer. Note that this field is not to be confused with the coalition concept of the ME. Examples of a Mission Coalition could be "NATO", "CCCP", "Intruders", "Terrorists"... +
    • +
+ +

Returns:

+
    + + MISSION + + + +
+ + + +

Usage:

+
    + 
    + -- Declare a few missions.
+ local Mission = MISSIONSCHEDULER.AddMission( 'Russia Transport Troops SA-6', 'Operational', 'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.', 'Russia' )
+ local Mission = MISSIONSCHEDULER.AddMission( 'Patriots', 'Primary', 'Our intelligence reports that 3 Patriot SAM defense batteries are located near Ruisi, Kvarhiti and Gori.', 'Russia'  )
+ local Mission = MISSIONSCHEDULER.AddMission( 'Package Delivery', 'Operational', 'In order to be in full control of the situation, we need you to deliver a very important package at a secret location. Fly undetected through the NATO defenses and deliver the secret package. The secret agent is located at waypoint 4.', 'Russia'  )
+ local Mission = MISSIONSCHEDULER.AddMission( 'Rescue General', 'Tactical', 'Our intelligence has received a remote signal behind Gori. We believe it is a very important Russian General that was captured by Georgia. Go out there and rescue him! Ensure you stay out of the battle zone, keep south. Waypoint 4 is the location of our Russian General.', 'Russia'  )
+ local Mission = MISSIONSCHEDULER.AddMission( 'NATO Transport Troops', 'Operational', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.', 'NATO' )
+ local Mission = MISSIONSCHEDULER.AddMission( 'SA-6 SAMs', 'Primary', 'Our intelligence reports that 3 SA-6 SAM defense batteries are located near Didmukha, Khetagurov and Berula. Eliminate the Russian SAMs.', 'NATO'  )
+ local Mission = MISSIONSCHEDULER.AddMission( 'NATO Sling Load', 'Operational', 'Fly to the cargo pickup zone at Dzegvi or Kaspi, and sling the cargo to Soganlug airbase.', 'NATO' )
+ local Mission = MISSIONSCHEDULER.AddMission( 'Rescue secret agent', 'Tactical', 'In order to be in full control of the situation, we need you to rescue a secret agent from the woods behind enemy lines. Avoid the Russian defenses and rescue the agent. Keep south until Khasuri, and keep your eyes open for any SAM presence. The agent is located at waypoint 4 on your kneeboard.', 'NATO'  )
    +
+ +
+
+ + MISSION:IsCompleted () +
+
+ Returns if a Mission has completed. + + + +

Returns:

+
    + + bool + + + +
+ + + + +
+
+ + MISSION:Completed () +
+
+ Set a Mission to completed. + + + + + + + +
+
+ + MISSION:IsOngoing () +
+
+ Returns if a Mission is ongoing. + treturn bool + + + + + + + +
+
+ + MISSION:Ongoing () +
+
+ Set a Mission to ongoing. + + + + + + + +
+
+ + MISSION:IsPending () +
+
+ Returns if a Mission is pending. + treturn bool + + + + + + + +
+
+ + MISSION:Pending () +
+
+ Set a Mission to pending. + + + + + + + +
+
+ + MISSION:IsFailed () +
+
+ Returns if a Mission has failed. + treturn bool + + + + + + + +
+
+ + MISSION:Failed () +
+
+ Set a Mission to failed. + + + + + + + +
+
+ + MISSION:StatusToClients () +
+
+ Send the status of the MISSION to all Clients. + + + + + + + +
+
+ + MISSION:ReportTrigger () +
+
+ Handles the reporting. After certain time intervals, a MISSION report MESSAGE will be shown to All Players. + + + + + + + +
+
+ + MISSION:ReportToAll () +
+
+ Report the status of all MISSIONs to all active Clients. + + + + + + + +
+
+ + MISSION:AddGoalFunction (GoalFunction) +
+
+ Add a goal function to a MISSION. Goal functions are called when a TASK within a mission has been completed. + + +

Parameters:

+
    +
  • GoalFunction + function + is the function defined by the mission designer to evaluate whether a certain goal has been reached after a TASK finishes within the MISSION. A GoalFunction must accept 2 parameters: Mission, Client, which contains the current MISSION object and the current CLIENT object respectively. +
    • +
+ + + + +

Usage:

+
    + 
    +  PatriotActivation = {
+		{ "US SAM Patriot Zerti", false },
+		{ "US SAM Patriot Zegduleti", false },
+		{ "US SAM Patriot Gvleti", false }
+	}
+
+	function DeployPatriotTroopsGoal( Mission, Client )
+
+
+		-- Check if the cargo is all deployed for mission success.
+		for CargoID, CargoData in pairs( Mission._Cargos ) do
+			if Group.getByName( CargoData.CargoGroupName ) then
+				CargoGroup = Group.getByName( CargoData.CargoGroupName )
+				if CargoGroup then
+					-- Check if the cargo is ready to activate
+					CurrentLandingZoneID = routines.IsUnitInZones( CargoGroup:getUnits()[1], Mission:GetTask( 2 ).LandingZones ) -- The second task is the Deploytask to measure mission success upon
+					if CurrentLandingZoneID then
+						if PatriotActivation[CurrentLandingZoneID][2] == false then
+							-- Now check if this is a new Mission Task to be completed...
+							trigger.action.setGroupAIOn( Group.getByName( PatriotActivation[CurrentLandingZoneID][1] ) )
+							PatriotActivation[CurrentLandingZoneID][2] = true
+							MessageToBlue( "Mission Command: Message to all airborne units! The " .. PatriotActivation[CurrentLandingZoneID][1] .. " is armed. Our air defenses are now stronger.", 60, "BLUE/PatriotDefense" )
+							MessageToRed( "Mission Command: Our satellite systems are detecting additional NATO air defenses. To all airborne units: Take care!!!", 60, "RED/PatriotDefense" )
+							Mission:GetTask( 2 ):AddGoalCompletion( "Patriots activated", PatriotActivation[CurrentLandingZoneID][1], 1 ) -- Register Patriot activation as part of mission goal.
+						end
+					end
+				end
+			end
+		end
+	end
+
+	local Mission = MISSIONSCHEDULER.AddMission( 'NATO Transport Troops', 'Operational', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.', 'NATO' )
+	Mission:AddGoalFunction( DeployPatriotTroopsGoal )
    +
+ +
+
+ + MISSION:ShowBriefing (Client) +
+
+ Show the briefing of the MISSION to the CLIENT. + + +

Parameters:

+
    +
  • Client + CLIENT + to show briefing to. +
    • +
+ +

Returns:

+
    + + CLIENT + + + +
+ + + + +
+
+ + MISSION:AddClient (Client) +
+
+ Register a new CLIENT to participate within the mission. + + +

Parameters:

+ + +

Returns:

+
    + + CLIENT + + + +
+ + + +

Usage:

+
    + 
    + Add a number of Client objects to the Mission.
+ 	Mission:AddClient( CLIENT:New( 'US UH-1H*HOT-Deploy Troops 1', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
+	Mission:AddClient( CLIENT:New( 'US UH-1H*RAMP-Deploy Troops 3', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
+	Mission:AddClient( CLIENT:New( 'US UH-1H*HOT-Deploy Troops 2', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
+	Mission:AddClient( CLIENT:New( 'US UH-1H*RAMP-Deploy Troops 4', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
    +
+ +
+
+ + MISSION:FindClient (ClientName) +
+
+ Find a CLIENT object within the MISSION by its ClientName. + + +

Parameters:

+
    +
  • ClientName + CLIENT + is a string defining the Client Group as defined within the ME. +
    • +
+ +

Returns:

+
    + + CLIENT + + + +
+ + + +

Usage:

+
    + 
    + -- Seach for Client "Bomber" within the Mission.
+ local BomberClient = Mission:FindClient( "Bomber" )
    +
+ +
+
+ + MISSION:AddTask (Task, TaskNumber) +
+
+ Register a TASK to be completed within the MISSION. Note that there can be multiple TASKs registered to be completed. Each TASK can be set a certain Goal. The MISSION will not be completed until all Goals are reached. + + +

Parameters:

+
    +
  • Task + TASK + is the TASK object. The object must have been instantiated with TASK:New or any of its inherited TASKs. +
    • +
  • TaskNumber + number + is the sequence number of the TASK within the MISSION. This number does have to be chronological. +
    • +
+ +

Returns:

+
    + + TASK + + + +
+ + + +

Usage:

+
    + 
    + -- Define a few tasks for the Mission.
+	PickupZones = { "NATO Gold Pickup Zone", "NATO Titan Pickup Zone" }
+	PickupSignalUnits = { "NATO Gold Coordination Center", "NATO Titan Coordination Center" }
+
+	-- Assign the Pickup Task
+	local PickupTask = PICKUPTASK:New( PickupZones, CARGO_TYPE.ENGINEERS, CLIENT.ONBOARDSIDE.LEFT )
+	PickupTask:AddSmokeBlue( PickupSignalUnits  )
+	PickupTask:SetGoalTotal( 3 )
+	Mission:AddTask( PickupTask, 1 )
+
+	-- Assign the Deploy Task
+	local PatriotActivationZones = { "US Patriot Battery 1 Activation", "US Patriot Battery 2 Activation", "US Patriot Battery 3 Activation" }
+	local PatriotActivationZonesSmokeUnits = { "US SAM Patriot - Battery 1 Control", "US SAM Patriot - Battery 2 Control", "US SAM Patriot - Battery 3 Control" }
+	local DeployTask = DEPLOYTASK:New( PatriotActivationZones, CARGO_TYPE.ENGINEERS )
+	--DeployTask:SetCargoTargetZoneName( 'US Troops Attack ' .. math.random(2) )
+	DeployTask:AddSmokeBlue( PatriotActivationZonesSmokeUnits )
+	DeployTask:SetGoalTotal( 3 )
+	DeployTask:SetGoalTotal( 3, "Patriots activated" )
+	Mission:AddTask( DeployTask, 2 )
    +
+ +
+
+ + MISSION:GetTask (TaskNumber) +
+
+ Get the TASK idenified by the TaskNumber from the Mission. This function is useful in GoalFunctions. + + +

Parameters:

+
    +
  • TaskNumber + number + is the number of the TASK within the MISSION. +
    • +
+ +

Returns:

+
    + + TASK + + + +
+ + + +

Usage:

+
    + 
    + -- Get Task 2 from the Mission.
+ Task2 = Mission:GetTask( 2 )
    +
+ +
+
+ + MISSION:GetTasks () +
+
+ Get all the TASKs from the Mission. This function is useful in GoalFunctions. + + + +

Returns:

+
    + + {TASK,...} + Structure of TASKS with the TASK number as the key. +
+ + + +

Usage:

+
    + 
    + -- Get Tasks from the Mission.
+ Tasks = Mission:GetTasks()
+ env.info( "Task 2 Completion = " .. Tasks[2]:GetGoalPercentage() .. "%" )
    +
+ +
+
+

Class MISSIONSCHEDULER

+ + The MISSIONSCHEDULER is an OBJECT and is the main scheduler of ALL active MISSIONs registered within this scheduler. It's workings are considered internal and is automatically created when the Mission.lua file is included. +
+
+ + MISSIONSCHEDULER.Scheduler () +
+
+ This is the main MISSIONSCHEDULER Scheduler function. It is considered internal and is automatically created when the Mission.lua file is included. + + + + + + + +
+
+ + MISSIONSCHEDULER.Start () +
+
+ Start the MISSIONSCHEDULER. + + + + + + + +
+
+ + MISSIONSCHEDULER.Stop () +
+
+ Stop the MISSIONSCHEDULER. + + + + + + + +
+
+ + MISSIONSCHEDULER.AddMission (Mission) +
+
+ This is the main MISSION declaration method. Each Mission is like the master or a Mission orchestration between, Clients, Tasks, Stages etc. + + +

Parameters:

+
    +
  • Mission + is the MISSION object instantiated by MISSION:New. +
    • +
+ +

Returns:

+
    + + MISSION +
+ + + +

Usage:

+
    + 
    + -- Declare a mission.
+ Mission = MISSION:New( 'Russia Transport Troops SA-6',
+                        'Operational',
+                        'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.',
+                        'Russia' )
+ MISSIONSCHEDULER:AddMission( Mission )
    +
+ +
+
+ + MISSIONSCHEDULER.RemoveMission (MissionName) +
+
+ Remove a MISSION from the MISSIONSCHEDULER. + + +

Parameters:

+
    +
  • MissionName + is the name of the MISSION given at declaration using AddMission. +
    • +
+ + + + +

Usage:

+
    + 
    + -- Declare a mission.
+ Mission = MISSION:New( 'Russia Transport Troops SA-6',
+                        'Operational',
+                        'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.',
+                        'Russia' )
+ MISSIONSCHEDULER:AddMission( Mission )
+
+ -- Now remove the Mission.
+ MISSIONSCHEDULER:RemoveMission( 'Russia Transport Troops SA-6' )
    +
+ +
+
+ + MISSIONSCHEDULER.FindMission (MissionName) +
+
+ Find a MISSION within the MISSIONSCHEDULER. + + +

Parameters:

+
    +
  • MissionName + is the name of the MISSION given at declaration using AddMission. +
    • +
+ +

Returns:

+
    + + MISSION +
+ + + +

Usage:

+
    + 
    + -- Declare a mission.
+ Mission = MISSION:New( 'Russia Transport Troops SA-6',
+                        'Operational',
+                        'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.',
+                        'Russia' )
+ MISSIONSCHEDULER:AddMission( Mission )
+
+ -- Now find the Mission.
+ MissionFind = MISSIONSCHEDULER:FindMission( 'Russia Transport Troops SA-6' )
    +
+ +
+
+ + MISSIONSCHEDULER.ReportMenu () +
+
+ Enables a MENU option in the communications menu under F10 to control the status of the active missions. + This function should be called only once when starting the MISSIONSCHEDULER. + + + + + + + +
+
+ + MISSIONSCHEDULER:TimeShow () +
+
+ Show the remaining mission time. + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/MOVEMENT.html b/doc/classes/MOVEMENT.html new file mode 100644 index 000000000..952edca7b --- /dev/null +++ b/doc/classes/MOVEMENT.html @@ -0,0 +1,263 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class MOVEMENT

+

Limit the simultaneous movement of Groups within a running Mission.

+

This module is defined to improve the performance in missions, and to bring additional realism for GROUND vehicles. + Performance: If in a DCSRTE there are a lot of moving GROUND units, then in a multi player mission, this WILL create lag if + the main DCS execution core of your CPU is fully utilized. So, this class will limit the amount of simultaneous moving GROUND units + on defined intervals (currently every minute).

+ + +

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + +
MOVEMENT:New (MovePrefixes, MoveMaximum)Creates the main object which is handling the GROUND forces movement.
MOVEMENT:ScheduleStart ()Call this function to start the MOVEMENT scheduling.
MOVEMENT:ScheduleStop ()Call this function to stop the MOVEMENT scheduling.
MOVEMENT:OnBirth (event)Captures the birth events when new Units were spawned.
MOVEMENT:OnDeadOrCrash (event)Captures the Dead or Crash events when Units crash or are destroyed.
MOVEMENT:_Scheduler ()This function is called automatically by the MOVEMENT scheduler.
+ +
+
+ + +

Methods

+ +
+
+ + MOVEMENT:New (MovePrefixes, MoveMaximum) +
+
+ Creates the main object which is handling the GROUND forces movement. + + +

Parameters:

+
    +
  • MovePrefixes + table{string,...} or string + is a table of the Prefixes (names) of the GROUND Groups that need to be controlled by the MOVEMENT Object. +
    • +
  • MoveMaximum + number + is a number that defines the maximum amount of GROUND Units to be moving during one minute. +
    • +
+ +

Returns:

+
    + + MOVEMENT + + + +
+ + + +

Usage:

+
    + 
    + -- Limit the amount of simultaneous moving units on the ground to prevent lag.
+ Movement_US_Platoons = MOVEMENT:New( { 'US Tank Platoon Left', 'US Tank Platoon Middle', 'US Tank Platoon Right', 'US CH-47D Troops' }, 15 )
    +
+ +
+
+ + MOVEMENT:ScheduleStart () +
+
+ Call this function to start the MOVEMENT scheduling. + + + + + + + +
+
+ + MOVEMENT:ScheduleStop () +
+
+ Call this function to stop the MOVEMENT scheduling. + + + + + + + +
+
+ + MOVEMENT:OnBirth (event) +
+
+ Captures the birth events when new Units were spawned. + + +

Parameters:

+
    +
  • event + + + +
    • +
+ + + + + +
+
+ + MOVEMENT:OnDeadOrCrash (event) +
+
+ Captures the Dead or Crash events when Units crash or are destroyed. + + +

Parameters:

+
    +
  • event + + + +
    • +
+ + + + + +
+
+ + MOVEMENT:_Scheduler () +
+
+ This function is called automatically by the MOVEMENT scheduler. A new function is scheduled when MoveScheduled is true. + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/NOTASK.html b/doc/classes/NOTASK.html new file mode 100644 index 000000000..3ed670832 --- /dev/null +++ b/doc/classes/NOTASK.html @@ -0,0 +1,163 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class NOTASK

+

A NOTASK is a dummy activity...

+

But it will show a Mission Briefing...

+ + +

Tables

+ + + + + +
NOTASK.NOTASKModeling a sequence of STAGEs to do nothing, but wait for the mission goal.
+

Methods

+ + + + + +
NOTASK:New ()Creates a new NOTASK.
+ +
+
+ + +

Tables

+ +
+
+ + NOTASK.NOTASK +
+
+ Modeling a sequence of STAGEs to do nothing, but wait for the mission goal. + + +

Fields:

+
    +
  • ClassName + + + +
    • +
+ + + + + +
+
+

Methods

+ +
+
+ + NOTASK:New () +
+
+ Creates a new NOTASK. + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/PICKUPTASK.html b/doc/classes/PICKUPTASK.html new file mode 100644 index 000000000..1a2addfe9 --- /dev/null +++ b/doc/classes/PICKUPTASK.html @@ -0,0 +1,146 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class PICKUPTASK

+

A PICKUPTASK orchestrates the loading of CARGO at a specific landing zone.

+

+ +

+ + +

Methods

+ + + + + +
PICKUPTASK:New (LandingZones, CargoType, OnBoardSide)Creates a new PICKUPTASK.
+ +
+
+ + +

Methods

+ +
+
+ + PICKUPTASK:New (LandingZones, CargoType, OnBoardSide) +
+
+ Creates a new PICKUPTASK. + + +

Parameters:

+
    +
  • LandingZones + table{string,...} or string + Table of Zone names where Cargo is to be loaded. +
    • +
  • CargoType + CARGO_TYPE + Type of the Cargo. The type must be of the following Enumeration:.. +
    • +
  • OnBoardSide + number + Reflects from which side the cargo Group will be on-boarded on the Carrier. +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/ROUTETASK.html b/doc/classes/ROUTETASK.html new file mode 100644 index 000000000..61d453c81 --- /dev/null +++ b/doc/classes/ROUTETASK.html @@ -0,0 +1,189 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class ROUTETASK

+

A ROUTETASK orchestrates the travel to a specific zone defined within the ME.

+

+ +

+ + +

Tables

+ + + + + +
ROUTETASK.ROUTETASKModeling a sequence of STAGEs to fly back to the home base specified by an Arrival Zone.
+

Methods

+ + + + + +
ROUTETASK:New (LandingZones, TaskBriefing)Creates a new ROUTETASK.
+ +
+
+ + +

Tables

+ +
+
+ + ROUTETASK.ROUTETASK +
+
+ Modeling a sequence of STAGEs to fly back to the home base specified by an Arrival Zone. + + +

Fields:

+
    +
  • ClassName + + + +
    • +
  • GoalVerb + + + +
    • +
+ + + + + +
+
+

Methods

+ +
+
+ + ROUTETASK:New (LandingZones, TaskBriefing) +
+
+ Creates a new ROUTETASK. + + +

Parameters:

+
    +
  • LandingZones + table{sring,...} or string + Table of Zone Names where the target is located. +
    • +
  • TaskBriefing + string + (optional) Defines a text describing the briefing of the task. +
    • +
+ +

Returns:

+
    + + ROUTETASK + + + +
+ + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/SEAD.html b/doc/classes/SEAD.html new file mode 100644 index 000000000..7fce32e97 --- /dev/null +++ b/doc/classes/SEAD.html @@ -0,0 +1,189 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class SEAD

+

Provides defensive behaviour to a set of SAM sites within a running Mission.

+

+ +

+

Info:

+
    +
  • Author: to be searched on the forum,(co) Flightcontrol (Modified and enriched with functionality)
    • +
+ + +

Methods

+ + + + + + + + + +
SEAD:New (SEADGroupPrefixes)Creates the main object which is handling defensive actions for SA sites or moving SA vehicles.
SEAD:EventShot (event)Detects if an SA site was shot with an anti radiation missile.
+ +
+
+ + +

Methods

+ +
+
+ + SEAD:New (SEADGroupPrefixes) +
+
+ Creates the main object which is handling defensive actions for SA sites or moving SA vehicles. + When an anti radiation missile is fired (KH-58, KH-31P, KH-31A, KH-25MPU, HARM missiles), the SA will shut down their radars and will take evasive actions... + Chances are big that the missile will miss. + + +

Parameters:

+
    +
  • SEADGroupPrefixes + table{string,...} or string + which is a table of Prefixes of the SA Groups in the DCSRTE on which evasive actions need to be taken. +
    • +
+ +

Returns:

+
    + + SEAD + + + +
+ + + +

Usage:

+
    + 
    + -- CCCP SEAD Defenses
+ -- Defends the Russian SA installations from SEAD attacks.
+ SEAD_RU_SAM_Defenses = SEAD:New( { 'RU SA-6 Kub', 'RU SA-6 Defenses', 'RU MI-26 Troops', 'RU Attack Gori' } )
    +
+ +
+
+ + SEAD:EventShot (event) +
+
+ Detects if an SA site was shot with an anti radiation missile. In this case, take evasive actions based on the skill level set within the ME. + + +

Parameters:

+
    +
  • event + + + +
    • +
+ + + +

See also:

+ + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/SLINGLOADHOOKTASK.html b/doc/classes/SLINGLOADHOOKTASK.html new file mode 100644 index 000000000..fbc1b3412 --- /dev/null +++ b/doc/classes/SLINGLOADHOOKTASK.html @@ -0,0 +1,150 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class SLINGLOADHOOKTASK

+

A SLINGLOADHOOKTASK will orchestrate the sling-load hook activity to slingload a CARGO from a specific landing zone(s).

+

+ +

+ + +

Methods

+ + + + + +
SLINGLOADHOOKTASK:New (LandingZones, CargoPrefixes)Creates a new SLINGLOADHOOKTASK.
+ +
+
+ + +

Methods

+ +
+
+ + SLINGLOADHOOKTASK:New (LandingZones, CargoPrefixes) +
+
+ Creates a new SLINGLOADHOOKTASK. + + +

Parameters:

+
    +
  • LandingZones + table{string,...} or string + Table or name of the zone(s) where Cargo is to be loaded. +
    • +
  • CargoPrefixes + table{string,...) or string + is the name or prefix of the name of the Cargo objects defined within the DCS ME. +
    • +
+ +

Returns:

+
    + + SLINGLOADHOOKTASK + + + +
+ + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/SLINGLOADUNHOOKTASK.html b/doc/classes/SLINGLOADUNHOOKTASK.html new file mode 100644 index 000000000..462863c1c --- /dev/null +++ b/doc/classes/SLINGLOADUNHOOKTASK.html @@ -0,0 +1,142 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class SLINGLOADUNHOOKTASK

+

A SLINGLOADUNHOOKTASK will orchestrate the sling-load unhook activity to (sling)load a CARGO and deploy it in a specific landing zone(s).

+

+ +

+ + +

Methods

+ + + + + +
SLINGLOADUNHOOKTASK:New (LandingZones, CargoPrefixes)Creates a new SLINGLOADUNHOOKTASK.
+ +
+
+ + +

Methods

+ +
+
+ + SLINGLOADUNHOOKTASK:New (LandingZones, CargoPrefixes) +
+
+ Creates a new SLINGLOADUNHOOKTASK. + + +

Parameters:

+
    +
  • LandingZones + table{string,...} or string + Table or name of the zone(s) where Cargo is to be loaded. +
    • +
  • CargoPrefixes + table{string,...} or string + is the name or prefix of the name of the Cargo objects defined within the DCS ME. +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/SPAWN.html b/doc/classes/SPAWN.html new file mode 100644 index 000000000..42c302735 --- /dev/null +++ b/doc/classes/SPAWN.html @@ -0,0 +1,995 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class SPAWN

+

Dynamic spawning of Groups and Units.

+

+ +

+

Info:

+
    +
  • Author: Flightcontrol
    • +
+ + +

Private

+ + + + + + + + + + + + + + + + + + + + + + + + + +
SPAWN:_GetGroupCategoryID (SpawnPrefix)Gets the CategoryID of the Group with the given SpawnPrefix
SPAWN:_GetGroupCoalitionID (SpawnPrefix)Gets the CoalitionID of the Group with the given SpawnPrefix
SPAWN:_GetGroupCountryID (SpawnPrefix)Gets the CountryID of the Group with the given SpawnPrefix
SPAWN:_GetTemplate (SpawnPrefix)Gets the Group Template from the ME environment definition.
SPAWN:_Prepare (SpawnIncrement)Prepares the new Group Template before Spawning.
SPAWN:_RandomizeRoute (SpawnTemplate)Will randomize the route of the Group Template.
+

Events

+ + + + + + + + + + + + + + + + + + + + + +
SPAWN:OnBirth (event)Obscolete
SPAWN:OnDeadOrCrash (event)Obscolete
SPAWN:OnLand (event)Will detect AIR Units landing...
SPAWN:OnTakeOff (event)Will detect AIR Units taking off...
SPAWN:OnEngineShutDown (event)Will detect AIR Units shutting down their engines ...
+

Scheduled

+ + + + + +
SPAWN:_Scheduler ()This function is called automatically by the Spawning scheduler.
+

Public

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SPAWN:New (SpawnPrefix)Creates the main object to spawn a Group defined in the DCS ME.
SPAWN:RandomizeRoute (SpawnStartPoint, SpawnEndPoint, SpawnRadius)Randomizes a defined route of the Template Group in the ME when the Group is Spawned.
SPAWN:Schedule (SpawnTime, SpawnTimeVariation)SPAWNs a new Group within varying time intervals.
SPAWN:ScheduleStart ()Will start the SPAWNing timers.
SPAWN:ScheduleStop ()Will stop the scheduled SPAWNing activity.
SPAWN:Limit (SpawnMaxGroupsAlive, SpawnMaxGroups)Limits the Maximum amount of Units to be alive, and the maximum amount of Groups to be SPAWNed within the DCS World run-time environment.
SPAWN:RandomizeTemplate (SpawnPrefixTable)This function is rather complicated to understand.
SPAWN:Repeat ()When a Group got SPAWNed, it has a life within the DCSRTE.
SPAWN:RepeatOnLanding ()Same as the @{Repeat) method.
SPAWN:RepeatOnEngineShutDown ()Same as the @{Repeat) method, but now the Group will respawn after its engines have shut down.
SPAWN:Spawn ()Will SPAWN a Group whenever you want to do this.
SPAWN:ReSpawn (SpawnGroupName)Will Re-SPAWN a Group based on a given GroupName.
SPAWN:SpawnUncontrolled ()Will SPAWN a Group whenever you want to do this, but for AIR Groups only to be applied, and will SPAWN the Group in Uncontrolled mode...
SPAWN:FromCarrier (CarrierGroup, TargetZonePrefix, NewGroupName, LateActivate)Will SPAWN a Group from a Carrier.
SPAWN:InZone (ZonePrefix)Will SPAWN a Group within a given ZoneName.
+ +
+
+ + +

Private

+ + +
+
+ + SPAWN:_GetGroupCategoryID (SpawnPrefix) +
+
+ Gets the CategoryID of the Group with the given SpawnPrefix + + +

Parameters:

+
    +
  • SpawnPrefix + + + +
    • +
+ + + + + +
+
+ + SPAWN:_GetGroupCoalitionID (SpawnPrefix) +
+
+ Gets the CoalitionID of the Group with the given SpawnPrefix + + +

Parameters:

+
    +
  • SpawnPrefix + + + +
    • +
+ + + + + +
+
+ + SPAWN:_GetGroupCountryID (SpawnPrefix) +
+
+ Gets the CountryID of the Group with the given SpawnPrefix + + +

Parameters:

+
    +
  • SpawnPrefix + + + +
    • +
+ + + + + +
+
+ + SPAWN:_GetTemplate (SpawnPrefix) +
+
+ Gets the Group Template from the ME environment definition. + This method used the DATABASE object, which contains ALL initial and new SPAWNed object in MOOSE. + + +

Parameters:

+
    +
  • SpawnPrefix + + + +
    • +
+ + + + + +
+
+ + SPAWN:_Prepare (SpawnIncrement) +
+
+ Prepares the new Group Template before Spawning. + + +

Parameters:

+
    +
  • SpawnIncrement + + + +
    • +
+ + + + + +
+
+ + SPAWN:_RandomizeRoute (SpawnTemplate) +
+
+ Will randomize the route of the Group Template. + + +

Parameters:

+
    +
  • SpawnTemplate + + + +
    • +
+ + + + + +
+
+

Events

+ + +
+
+ + SPAWN:OnBirth (event) +
+
+ Obscolete + + +

Parameters:

+
    +
  • event + + + +
    • +
+ + + + + +
+
+ + SPAWN:OnDeadOrCrash (event) +
+
+ Obscolete + + +

Parameters:

+
    +
  • event + + + +
    • +
+ + + + + +
+
+ + SPAWN:OnLand (event) +
+
+ Will detect AIR Units landing... When the event takes place, the SPAWNed Group is registered as landed. + This is needed to ensure that Re-SPAWNing is only done for landed AIR Groups. + + +

Parameters:

+
    +
  • event + + + +
    • +
+ + + + + +
+
+ + SPAWN:OnTakeOff (event) +
+
+ Will detect AIR Units taking off... When the event takes place, the SPAWNed Group is registered as airborne... + This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups. + + +

Parameters:

+
    +
  • event + + + +
    • +
+ + + + + +
+
+ + SPAWN:OnEngineShutDown (event) +
+
+ Will detect AIR Units shutting down their engines ... + When the event takes place, and the method RepeatOnEngineShutDown was called, the SPAWNed Group will Re-SPAWN. + But only when the Unit was registered to have landed. + + +

Parameters:

+
    +
  • event + + + +
    • +
+ + + +

See also:

+ + + +
+
+

Scheduled

+ + +
+
+ + SPAWN:_Scheduler () +
+
+ This function is called automatically by the Spawning scheduler. + It is the internal worker method SPAWNing new Groups on the defined time intervals. + + + + + + + +
+
+

Public

+ + +
+
+ + SPAWN:New (SpawnPrefix) +
+
+ +

Creates the main object to spawn a Group defined in the DCS ME. + Spawned Groups and Units will follow the following naming convention within the DCS World run-time environment:

+
   Groups will have the name SpawnPrefix#ggg, where ggg is a counter from 0 to 999 for each new spawned Group.
+   Units will have the name SpawnPrefix#ggg-uu, where uu is a counter from 0 to 99 for each new spawned Unit belonging to that Group.
+
+ + + +

Parameters:

+
    +
  • SpawnPrefix + string + is the name of the Group in the ME that defines the Template. That Group must have the flag "Late Activation" set. Note that this SpawnPrefix name should not contain any # character. +
    • +
+ +

Returns:

+
    + + SPAWN + + + +
+ + + +

Usage:

+
    + 
    + -- NATO helicopters engaging in the battle field.
+ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' )
    +
+ +
+
+ + SPAWN:RandomizeRoute (SpawnStartPoint, SpawnEndPoint, SpawnRadius) +
+
+ Randomizes a defined route of the Template Group in the ME when the Group is Spawned. This is very useful to define extra variation in the DCS World run-time environment of the behaviour of Groups like Ground Units, Ships, Planes, Helicopters. + + +

Parameters:

+
    +
  • SpawnStartPoint + number + is the waypoint where the randomization begins. Note that the StartPoint = 0 equals the point where the Group is Spawned. This parameter is useful to avoid randomization to start from the first waypoint, but a bit further down the route... +
    • +
  • SpawnEndPoint + number + is the waypoint where the randomization ends. this parameter is useful to avoid randomization to end at a waypoint earlier than the last waypoint on the route. +
    • +
  • SpawnRadius + number + is the radius in meters, that defines the concentric circle in which the randomization of the new waypoint will take place, with the original waypoint located in the middle... +
    • +
+ +

Returns:

+
    + + SPAWN + + + +
+ + + +

Usage:

+
    + 
    + -- NATO helicopters engaging in the battle field.
+ -- The KA-50 has waypoints SP, 1, 2, 3, 4, DP.
+ -- Waypoints 2 and 3 will only be randomized. The others will remain on their original position with each new ${SPAWN} of the helicopter.
+ -- The randomization of waypoint 2 and 3 will take place within a diameter of 4000 meters.
+ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):RandomizeRoute( 2, 2, 2000 )
    +
+ +
+
+ + SPAWN:Schedule (SpawnTime, SpawnTimeVariation) +
+
+ SPAWNs a new Group within varying time intervals. This is useful if you want to have continuity within your missions of certain (AI) Groups to be present (alive) within your missions. + + +

Parameters:

+
    +
  • SpawnTime + number + is the time interval defined in seconds between each new SPAWN of new Groups. +
    • +
  • SpawnTimeVariation + number + is the variation to be applied on the defined time interval between each new SPAWN. The variation is defined as a value between 0 and 1, which expresses the %-tage of variation to be applied as the low and high time interval boundaries. Between these boundaries a new time interval will be applied. See usage. +
    • +
+ +

Returns:

+
    + + SPAWN + + + +
+ + + +

Usage:

+
    + 
    + -- NATO helicopters engaging in the battle field.
+ -- The time interval is set to SPAWN new helicopters between each 600 seconds, with a time variation of 50%.
+ -- The time variation in this case will be between 450 seconds and 750 seconds.
+ -- This is calculated as follows:
+ --      Low limit:   600 * ( 1 - 0.5 / 2 ) = 450
+ --      High limit:  600 * ( 1 + 0.5 / 2 ) = 750
+ -- Between these two values, a random amount of seconds will be choosen for each new SPAWN of the helicopters.
+ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
    +
+ +
+
+ + SPAWN:ScheduleStart () +
+
+ Will start the SPAWNing timers. + This function is called automatically when Schedule is called. + + + + + + + +
+
+ + SPAWN:ScheduleStop () +
+
+ Will stop the scheduled SPAWNing activity. + + + + + + + +
+
+ + SPAWN:Limit (SpawnMaxGroupsAlive, SpawnMaxGroups) +
+
+ Limits the Maximum amount of Units to be alive, and the maximum amount of Groups to be SPAWNed within the DCS World run-time environment. + Note that this method is exceptionally important to balance the amount of Units alive within the DCSRTE and the performance of the mission. Depending on the machine etc, a mission can only process a maximum amount of units. + If the time interval must be short, but there should not be more Units or Groups alive than a maximum amount of units, then this function should be used... + + +

Parameters:

+
    +
  • SpawnMaxGroupsAlive + number + is the Maximum amount of Units to be alive. When there are more Units alive in the DCSRTE of SpawnPrefix, then no new SPAWN will happen of the Group, until some of these Units will be destroyed. +
    • +
  • SpawnMaxGroups + number + +

    is the Maximum amount of Groups that can be SPAWNed from SpawnPrefix. When there are more Groups alive in the DCSRTE of SpawnPrefix, then no more SPAWNs will happen of the Group. This parameter is useful to define a maximum amount of airplanes, ground troops, helicopters, ships etc within a supply area.

    +
        This parameter accepts the value 0, which expresses no Group count limits.
+
    + +
    • +
+ +

Returns:

+
    + + SPAWN + + + +
+ + + +

Usage:

+
    + 
    + -- NATO helicopters engaging in the battle field.
+ -- This helicopter group consists of one Unit. So, this group will SPAWN maximum 2 groups simultaneously within the DCSRTE.
+ -- There will be maximum 24 groups SPAWNed during the whole mission lifetime.
+ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Limit( 2, 24 )
    +
+ +
+
+ + SPAWN:RandomizeTemplate (SpawnPrefixTable) +
+
+ This function is rather complicated to understand. But I'll try to explain... + This function becomes useful when you need to SPAWN random types of Groups defined within the ME, but they all need to follow the same Template route and have the same SpawnPrefix name, then this method becomes very useful. + + +

Parameters:

+
    +
  • SpawnPrefixTable + table{string,...} + is a table with the names of the Groups defined within the ME (with late activatio on), from which on a new SPAWN of SpawnPrefix (the main Group name), a NEW Group will be choosen as the Group to be SPAWNed. + In other words, this method randomizes between a defined set of Groups the Group to be SPAWNed for each new SPAWN. +
    • +
+ +

Returns:

+
    + + SPAWN + + + +
+ + + +

Usage:

+
    + 
    + -- NATO Tank Platoons invading Gori.
+ -- Choose between 13 different 'US Tank Platoon' configurations for each new SPAWN the Group to be SPAWNed for the
+ -- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SpawnPrefixes.
+ -- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and
+ -- with a limit set of maximum 12 Units alive simulteneously  and 150 Groups to be SPAWNed during the whole mission.
+ Spawn_US_Platoon = { 'US Tank Platoon 1', 'US Tank Platoon 2', 'US Tank Platoon 3', 'US Tank Platoon 4', 'US Tank Platoon 5',
+                      'US Tank Platoon 6', 'US Tank Platoon 7', 'US Tank Platoon 8', 'US Tank Platoon 9', 'US Tank Platoon 10',
+                      'US Tank Platoon 11', 'US Tank Platoon 12', 'US Tank Platoon 13' }
+ Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):Limit( 12, 150 ):Schedule( 200, 0.4 ):RandomizeTemplate( Spawn_US_Platoon ):RandomizeRoute( 3, 3, 2000 )
+ Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):Limit( 12, 150 ):Schedule( 200, 0.4 ):RandomizeTemplate( Spawn_US_Platoon ):RandomizeRoute( 3, 3, 2000 )
+ Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):Limit( 12, 150 ):Schedule( 200, 0.4 ):RandomizeTemplate( Spawn_US_Platoon ):RandomizeRoute( 3, 3, 2000 )
    +
+ +
+
+ + SPAWN:Repeat () +
+
+ When a Group got SPAWNed, it has a life within the DCSRTE. For planes and helicopters, when these Units go home and land on their home airbases and farps, they normally would taxi to the parking spot, shut-down their engines and wait forever until the Group is removed by the DCSRTE. + This function is used to Re-Spawn automatically (so no extra call is needed anymore) the same Group after it landed. This will enable a SPAWNed group to be Re-SPAWNed after it lands, until it is destroyed... + Note: When the Group is respawned, it will ReSpawn at the original airbase where it took off. So ensure that the paths for Groups that ReSpawn, always return to the orignal airbase. + + + +

Returns:

+
    + + SPAWN + + + +
+ + + +

Usage:

+
    + 
    + -- RU Su-34 - AI Ship Attack
+ -- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
+ SpawnRU_SU34 = SPAWN:New( 'TF1 RU Su-34 Krymsk@AI - Attack Ships' ):Schedule( 2, 3, 1800, 0.4 ):SpawnUncontrolled():RandomizeRoute( 1, 1, 3000 ):RepeatOnEngineShutDown()
    +
+ +
+
+ + SPAWN:RepeatOnLanding () +
+
+ Same as the @{Repeat) method. + + + +

Returns:

+
    + + SPAWN + + + +
+ + +

See also:

+ + + +
+
+ + SPAWN:RepeatOnEngineShutDown () +
+
+ Same as the @{Repeat) method, but now the Group will respawn after its engines have shut down. + + + +

Returns:

+
    + + SPAWN + + + +
+ + +

See also:

+ + + +
+
+ + SPAWN:Spawn () +
+
+ Will SPAWN a Group whenever you want to do this. + Note that the configuration with the above functions will apply when calling this method: Maxima, Randomization of routes, Scheduler, ... + Uses DATABASE global object defined in MOOSE. + + + +

Returns:

+
    + + SPAWN + + + +
+ + + + +
+
+ + SPAWN:ReSpawn (SpawnGroupName) +
+
+ Will Re-SPAWN a Group based on a given GroupName. The GroupName must be a group that is already alive within the DCSRTE and should have a Group Template defined in the ME (with Late Activation flag on). + Note that the configuration with the above functions will apply when calling this method: Maxima, Randomization of routes, Scheduler, ... + + +

Parameters:

+
    +
  • SpawnGroupName + string + + + +
    • +
+ +

Returns:

+
    + + SPAWN + Uses _Database global object defined in MOOSE. +
+ + + + +
+
+ + SPAWN:SpawnUncontrolled () +
+
+ Will SPAWN a Group whenever you want to do this, but for AIR Groups only to be applied, and will SPAWN the Group in Uncontrolled mode... This will be similar to the Uncontrolled flag setting in the ME. + + + +

Returns:

+
    + + SPAWN + + + +
+ + + + +
+
+ + SPAWN:FromCarrier (CarrierGroup, TargetZonePrefix, NewGroupName, LateActivate) +
+
+ Will SPAWN a Group from a Carrier. This function is mostly advisable to be used if you want to simulate SPAWNing from air units, like helicopters, which are dropping infantry into a defined Landing Zone. + + +

Parameters:

+
    +
  • CarrierGroup + Group + is the Group of the AIR unit or GROUND unit dropping or unloading other units. +
    • +
  • TargetZonePrefix + string + is the Prefix of the Zone defined in the ME where the Group should be moving to after drop. +
    • +
  • NewGroupName + string + (forgot this). +
    • +
  • LateActivate + bool + (optional) does the SPAWNing with Lateactivation on. +
    • +
+ + + + + +
+
+ + SPAWN:InZone (ZonePrefix) +
+
+ Will SPAWN a Group within a given ZoneName. + + +

Parameters:

+
    +
  • ZonePrefix + string + is the name of the zone where the Group is to be SPAWNed. +
    • +
+ +

Returns:

+
    + + SpawnTemplate + + + +
+ + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/STAGE.html b/doc/classes/STAGE.html new file mode 100644 index 000000000..297ee5ca8 --- /dev/null +++ b/doc/classes/STAGE.html @@ -0,0 +1,104 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class STAGE

+

Stages within a TASK within a MISSION.

+

All of the STAGE functionality is considered internally administered and not to be used by any Mission designer.

+

Info:

+
    +
  • Author: Flightcontrol
    • +
+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/classes/TASK.html b/doc/classes/TASK.html new file mode 100644 index 000000000..3507d58a1 --- /dev/null +++ b/doc/classes/TASK.html @@ -0,0 +1,952 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class TASK

+

The TASK Classes define major end-to-end activities within a MISSION.

+

The TASK Class is the Master Class to orchestrate these activities. From this class, many concrete TASK classes are inherited.

+ + +

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TASK:New ()Instantiates a new TASK Base.
TASK:GetGoalProgress ()Get progress of a TASK.
TASK:ShowGoalProgress (Mission, Client)Show progress of a TASK.
TASK:Done ()Sets a TASK to status Done.
TASK:IsDone ()Returns if a TASK is done.
TASK:Failed ()Sets a TASK to status failed.
TASK:IsFailed ()Returns if a TASk has failed.
TASK:GetGoals ()Returns the Goals of a TASK
TASK:Goal (GoalVerb)Returns if a TASK has Goal(s).
TASK:SetGoalTotal (GoalTotal, GoalVerb)Sets the total Goals to be achieved of the Goal Name
TASK:GetGoalTotal (GoalVerb)Gets the total of Goals to be achieved within the TASK of the GoalVerb.
TASK:SetGoalCount (GoalCount, GoalVerb)Sets the total of Goals currently achieved within the TASK of the GoalVerb.
TASK:IncreaseGoalCount (GoalCountIncrease, GoalVerb)Increments the total of Goals currently achieved within the TASK of the GoalVerb, with the given GoalCountIncrease.
TASK:GetGoalCount (GoalVerb)Gets the total of Goals currently achieved within the TASK of the GoalVerb.
TASK:GetGoalPercentage (GoalVerb)Gets the percentage of Goals currently achieved within the TASK of the GoalVerb.
TASK:IsGoalReached ()Returns if all the Goals of the TASK were achieved.
TASK:AddGoalCompletion (GoalVerb, GoalTask, GoalIncrease)Adds an Additional Goal for the TASK to be achieved.
TASK:GetGoalCompletion (GoalVerb)Returns if the additional Goal for the TASK was completed.
TASK:AddSignal (SignalUnitNames, SignalType, SignalColor, SignalHeight)Work function to set signal events within a TASK.
TASK:AddSmokeRed (SignalUnitNames, SignalHeight)When the CLIENT is approaching the landing zone, a RED SMOKE will be fired by an optional SignalUnitNames.
TASK:AddSmokeGreen (SignalUnitNames, SignalHeight)When the CLIENT is approaching the landing zone, a GREEN SMOKE will be fired by an optional SignalUnitNames.
TASK:AddSmokeBlue (SignalUnitNames, SignalHeight)When the CLIENT is approaching the landing zone, a BLUE SMOKE will be fired by an optional SignalUnitNames.
TASK:AddSmokeWhite (SignalUnitNames, SignalHeight)When the CLIENT is approaching the landing zone, a WHITE SMOKE will be fired by an optional SignalUnitNames.
TASK:AddSmokeOrange (SignalUnitNames, SignalHeight)When the CLIENT is approaching the landing zone, an ORANGE SMOKE will be fired by an optional SignalUnitNames.
TASK:AddFlareRed (SignalUnitNames, SignalHeight)When the CLIENT is approaching the landing zone, a RED FLARE will be fired by an optional SignalUnitNames.
TASK:AddFlareGreen (SignalUnitNames, SignalHeight)When the CLIENT is approaching the landing zone, a GREEN FLARE will be fired by an optional SignalUnitNames.
TASK:AddFlareBlue (SignalUnitNames, SignalHeight)When the CLIENT is approaching the landing zone, a BLUE FLARE will be fired by an optional SignalUnitNames.
TASK:AddFlareWhite (SignalUnitNames, SignalHeight)When the CLIENT is approaching the landing zone, a WHITE FLARE will be fired by an optional SignalUnitNames.
TASK:AddFlareOrange (SignalUnitNames, SignalHeight)When the CLIENT is approaching the landing zone, an ORANGE FLARE will be fired by an optional SignalUnitNames.
+ +
+
+ + +

Methods

+ +
+
+ + TASK:New () +
+
+ Instantiates a new TASK Base. Should never be used. Interface Class. + + + +

Returns:

+
    + + TASK + + + +
+ + + + +
+
+ + TASK:GetGoalProgress () +
+
+ Get progress of a TASK. + + + +

Returns:

+
    + + string + GoalsText +
+ + + + +
+
+ + TASK:ShowGoalProgress (Mission, Client) +
+
+ Show progress of a TASK. + + +

Parameters:

+
    +
  • Mission + MISSION + +
        Group structure describing the Mission.
+
    + +
    • +
  • Client + CLIENT + +
            Group structure describing the Client.
+
    + +
    • +
+ + + + + +
+
+ + TASK:Done () +
+
+ Sets a TASK to status Done. + + + + + + + +
+
+ + TASK:IsDone () +
+
+ Returns if a TASK is done. + + + +

Returns:

+
    + + bool + + + +
+ + + + +
+
+ + TASK:Failed () +
+
+ Sets a TASK to status failed. + + + + + + + +
+
+ + TASK:IsFailed () +
+
+ Returns if a TASk has failed. + + + +

Returns:

+
    + + bool +
+ + + + +
+
+ + TASK:GetGoals () +
+
+ Returns the Goals of a TASK + + + +

Returns:

+
    + + Goals +
+ + + + +
+
+ + TASK:Goal (GoalVerb) +
+
+ Returns if a TASK has Goal(s). + + +

Parameters:

+
    +
  • GoalVerb + optional string + is the name of the Goal of the TASK. +
    • +
+ +

Returns:

+
    + + bool + + + +
+ + + + +
+
+ + TASK:SetGoalTotal (GoalTotal, GoalVerb) +
+
+ Sets the total Goals to be achieved of the Goal Name + + +

Parameters:

+
    +
  • GoalTotal + number + is the number of times the GoalVerb needs to be achieved. +
    • +
  • GoalVerb + optional string + is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used. +
    • +
+ + + + + +
+
+ + TASK:GetGoalTotal (GoalVerb) +
+
+ Gets the total of Goals to be achieved within the TASK of the GoalVerb. + + +

Parameters:

+
    +
  • GoalVerb + optional string + is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used. +
    • +
+ + + + + +
+
+ + TASK:SetGoalCount (GoalCount, GoalVerb) +
+
+ Sets the total of Goals currently achieved within the TASK of the GoalVerb. + + +

Parameters:

+
    +
  • GoalCount + number + is the total number of Goals achieved within the TASK. +
    • +
  • GoalVerb + optional string + is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used. +
    • +
+ +

Returns:

+
    + + TASK + + + +
+ + + + +
+
+ + TASK:IncreaseGoalCount (GoalCountIncrease, GoalVerb) +
+
+ Increments the total of Goals currently achieved within the TASK of the GoalVerb, with the given GoalCountIncrease. + + +

Parameters:

+
    +
  • GoalCountIncrease + number + is the number of new Goals achieved within the TASK. +
    • +
  • GoalVerb + optional string + is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used. +
    • +
+ +

Returns:

+
    + + TASK + + + +
+ + + + +
+
+ + TASK:GetGoalCount (GoalVerb) +
+
+ Gets the total of Goals currently achieved within the TASK of the GoalVerb. + + +

Parameters:

+
    +
  • GoalVerb + optional string + is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used. +
    • +
+ +

Returns:

+
    + + TASK + + + +
+ + + + +
+
+ + TASK:GetGoalPercentage (GoalVerb) +
+
+ Gets the percentage of Goals currently achieved within the TASK of the GoalVerb. + + +

Parameters:

+
    +
  • GoalVerb + optional string + is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used. +
    • +
+ +

Returns:

+
    + + TASK + + + +
+ + + + +
+
+ + TASK:IsGoalReached () +
+
+ Returns if all the Goals of the TASK were achieved. + + + +

Returns:

+
    + + bool + + + +
+ + + + +
+
+ + TASK:AddGoalCompletion (GoalVerb, GoalTask, GoalIncrease) +
+
+ Adds an Additional Goal for the TASK to be achieved. + + +

Parameters:

+
    +
  • GoalVerb + string + is the name of the Goal of the TASK. +
    • +
  • GoalTask + string + is a text describing the Goal of the TASK to be achieved. +
    • +
  • GoalIncrease + number + is a number by which the Goal achievement is increasing. +
    • +
+ + + + + +
+
+ + TASK:GetGoalCompletion (GoalVerb) +
+
+ Returns if the additional Goal for the TASK was completed. + + +

Parameters:

+
    +
  • GoalVerb + optional string + is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used. +
    • +
+ +

Returns:

+
    + + string + Goals +
+ + + + +
+
+ + TASK:AddSignal (SignalUnitNames, SignalType, SignalColor, SignalHeight) +
+
+ Work function to set signal events within a TASK. + + +

Parameters:

+
    +
  • SignalUnitNames + + + +
    • +
  • SignalType + + + +
    • +
  • SignalColor + + + +
    • +
  • SignalHeight + + + +
    • +
+ + + + + +
+
+ + TASK:AddSmokeRed (SignalUnitNames, SignalHeight) +
+
+ When the CLIENT is approaching the landing zone, a RED SMOKE will be fired by an optional SignalUnitNames. + + +

Parameters:

+
    +
  • SignalUnitNames + table or string + Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone. +
    • +
  • SignalHeight + number + Altitude that the Signal should be fired... +
    • +
+ + + + + +
+
+ + TASK:AddSmokeGreen (SignalUnitNames, SignalHeight) +
+
+ When the CLIENT is approaching the landing zone, a GREEN SMOKE will be fired by an optional SignalUnitNames. + + +

Parameters:

+
    +
  • SignalUnitNames + table or string + Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone. +
    • +
  • SignalHeight + number + Altitude that the Signal should be fired... +
    • +
+ + + + + +
+
+ + TASK:AddSmokeBlue (SignalUnitNames, SignalHeight) +
+
+ When the CLIENT is approaching the landing zone, a BLUE SMOKE will be fired by an optional SignalUnitNames. + + +

Parameters:

+
    +
  • SignalUnitNames + table or string + Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone. +
    • +
  • SignalHeight + number + Altitude that the Signal should be fired... +
    • +
+ + + + + +
+
+ + TASK:AddSmokeWhite (SignalUnitNames, SignalHeight) +
+
+ When the CLIENT is approaching the landing zone, a WHITE SMOKE will be fired by an optional SignalUnitNames. + + +

Parameters:

+
    +
  • SignalUnitNames + table or string + Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone. +
    • +
  • SignalHeight + number + Altitude that the Signal should be fired... +
    • +
+ + + + + +
+
+ + TASK:AddSmokeOrange (SignalUnitNames, SignalHeight) +
+
+ When the CLIENT is approaching the landing zone, an ORANGE SMOKE will be fired by an optional SignalUnitNames. + + +

Parameters:

+
    +
  • SignalUnitNames + table or string + Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone. +
    • +
  • SignalHeight + number + Altitude that the Signal should be fired... +
    • +
+ + + + + +
+
+ + TASK:AddFlareRed (SignalUnitNames, SignalHeight) +
+
+ When the CLIENT is approaching the landing zone, a RED FLARE will be fired by an optional SignalUnitNames. + + +

Parameters:

+
    +
  • SignalUnitNames + table or string + Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone. +
    • +
  • SignalHeight + number + Altitude that the Signal should be fired... +
    • +
+ + + + + +
+
+ + TASK:AddFlareGreen (SignalUnitNames, SignalHeight) +
+
+ When the CLIENT is approaching the landing zone, a GREEN FLARE will be fired by an optional SignalUnitNames. + + +

Parameters:

+
    +
  • SignalUnitNames + table or string + Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone. +
    • +
  • SignalHeight + number + Altitude that the Signal should be fired... +
    • +
+ + + + + +
+
+ + TASK:AddFlareBlue (SignalUnitNames, SignalHeight) +
+
+ When the CLIENT is approaching the landing zone, a BLUE FLARE will be fired by an optional SignalUnitNames. + + +

Parameters:

+
    +
  • SignalUnitNames + table or string + Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone. +
    • +
  • SignalHeight + number + Altitude that the Signal should be fired... +
    • +
+ + + + + +
+
+ + TASK:AddFlareWhite (SignalUnitNames, SignalHeight) +
+
+ When the CLIENT is approaching the landing zone, a WHITE FLARE will be fired by an optional SignalUnitNames. + + +

Parameters:

+
    +
  • SignalUnitNames + table or string + Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone. +
    • +
  • SignalHeight + number + Altitude that the Signal should be fired... +
    • +
+ + + + + +
+
+ + TASK:AddFlareOrange (SignalUnitNames, SignalHeight) +
+
+ When the CLIENT is approaching the landing zone, an ORANGE FLARE will be fired by an optional SignalUnitNames. + + +

Parameters:

+
    +
  • SignalUnitNames + table or string + Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone. +
    • +
  • SignalHeight + number + Altitude that the Signal should be fired... +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 000000000..a16ec2301 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,214 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ + +

Mission Object Oriented Scripting Environment

+

A Scripting Framework for DCS World, to script quickly missions.

+ +

Modules

+ + + + + + + + + +
routinesVarious routines
traceTracing functions...
+

Scripts

+ + + + + +
eStatHandlerProvides a logging of statistics in a running DCS Mission.
+

Classes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BASEBASE The base class for all the classes defined within MOOSE.
CARGOCARGO
CLEANUPCLEANUP Classes
CLIENTCLIENT Classes
DATABASEAdministers the Initial Sets of the Mission Templates as defined within the Mission Editor.
DEPLOYTASKA DEPLOYTASK orchestrates the deployment of CARGO within a specific landing zone.
DESTROYBASETASKA DESTROYBASETASK will monitor the destruction of Groups and Units.
DESTROYGROUPSTASKDESTROYGROUPSTASK
DESTROYRADARSTASKTask class to destroy radar installations.
DESTROYUNITTYPESTASKSet TASK to destroy certain unit types.
GOHOMETASKA GOHOMETASK orchestrates the travel back to the home base, which is a specific zone defined within the ME.
MENUEncapsulation of DCS World Menu system in a set of MENU classes.
MESSAGEMessage System to display Messages for Clients and Coalitions or All.
MISSIONA MISSION is the main owner of a Mission orchestration within MOOSE .
MOVEMENTLimit the simultaneous movement of Groups within a running Mission.
NOTASKA NOTASK is a dummy activity...
PICKUPTASKA PICKUPTASK orchestrates the loading of CARGO at a specific landing zone.
ROUTETASKA ROUTETASK orchestrates the travel to a specific zone defined within the ME.
SEADProvides defensive behaviour to a set of SAM sites within a running Mission.
SLINGLOADHOOKTASKA SLINGLOADHOOKTASK will orchestrate the sling-load hook activity to slingload a CARGO from a specific landing zone(s).
SLINGLOADUNHOOKTASKA SLINGLOADUNHOOKTASK will orchestrate the sling-load unhook activity to (sling)load a CARGO and deploy it in a specific landing zone(s).
SPAWNDynamic spawning of Groups and Units.
STAGEStages within a TASK within a MISSION.
TASKThe TASK Classes define major end-to-end activities within a MISSION.
+

Topics

+ + + + + +
manual.md
+ +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/ldoc.css b/doc/ldoc.css new file mode 100644 index 000000000..7d74ca235 --- /dev/null +++ b/doc/ldoc.css @@ -0,0 +1,307 @@ +/* BEGIN RESET + +Copyright (c) 2010, Yahoo! Inc. All rights reserved. +Code licensed under the BSD License: +http://developer.yahoo.com/yui/license.html +version: 2.8.2r1 +*/ +html { + color: #000; + background: #FFF; +} +body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td { + margin: 0; + padding: 0; +} +table { + border-collapse: collapse; + border-spacing: 0; +} +fieldset,img { + border: 0; +} +address,caption,cite,code,dfn,em,strong,th,var,optgroup { + font-style: inherit; + font-weight: inherit; +} +del,ins { + text-decoration: none; +} +li { + list-style: disc; + margin-left: 20px; +} +caption,th { + text-align: left; +} +h1,h2,h3,h4,h5,h6 { + font-size: 100%; + font-weight: bold; +} +q:before,q:after { + content: ''; +} +abbr,acronym { + border: 0; + font-variant: normal; +} +sup { + vertical-align: baseline; +} +sub { + vertical-align: baseline; +} +legend { + color: #000; +} +input,button,textarea,select,optgroup,option { + font-family: inherit; + font-size: inherit; + font-style: inherit; + font-weight: inherit; +} +input,button,textarea,select {*font-size:100%; +} +/* END RESET */ + +body { + margin-left: 1em; + margin-right: 1em; + font-family: arial, helvetica, geneva, sans-serif; + background-color: #ffffff; margin: 0px; +} + +code, tt { font-family: monospace; font-size: 1.1em; } +span.parameter { font-family:monospace; } +span.parameter:after { content:":"; } +span.types:before { content:"("; } +span.types:after { content:")"; } +.type { font-weight: bold; font-style:italic } + +body, p, td, th { font-size: .95em; line-height: 1.2em;} + +p, ul { margin: 10px 0 0 0px;} + +strong { font-weight: bold;} + +em { font-style: italic;} + +h1 { + font-size: 1.5em; + margin: 0 0 20px 0; +} +h2, h3, h4 { margin: 15px 0 10px 0; } +h2 { font-size: 1.25em; } +h3 { font-size: 1.15em; } +h4 { font-size: 1.06em; } + +a:link { font-weight: bold; color: #004080; text-decoration: none; } +a:visited { font-weight: bold; color: #006699; text-decoration: none; } +a:link:hover { text-decoration: underline; } + +hr { + color:#cccccc; + background: #00007f; + height: 1px; +} + +blockquote { margin-left: 3em; } + +ul { list-style-type: disc; } + +p.name { + font-family: "Andale Mono", monospace; + padding-top: 1em; +} + +pre.example { + background-color: rgb(245, 245, 245); + border: 1px solid silver; + padding: 10px; + margin: 10px 0 10px 0; + font-family: "Andale Mono", monospace; + font-size: .85em; +} + +pre { + background-color: rgb(245, 245, 245); + border: 1px solid silver; + padding: 10px; + margin: 10px 0 10px 0; + overflow: auto; + font-family: "Andale Mono", monospace; +} + + +table.index { border: 1px #00007f; } +table.index td { text-align: left; vertical-align: top; } + +#container { + margin-left: 1em; + margin-right: 1em; + background-color: #f0f0f0; +} + +#product { + text-align: center; + border-bottom: 1px solid #cccccc; + background-color: #ffffff; +} + +#product big { + font-size: 2em; +} + +#main { + background-color: #f0f0f0; + border-left: 2px solid #cccccc; +} + +#navigation { + float: left; + width: 14em; + vertical-align: top; + background-color: #f0f0f0; + overflow: visible; +} + +#navigation h2 { + background-color:#e7e7e7; + font-size:1.1em; + color:#000000; + text-align: left; + padding:0.2em; + border-top:1px solid #dddddd; + border-bottom:1px solid #dddddd; +} + +#navigation ul +{ + font-size:1em; + list-style-type: none; + margin: 1px 1px 10px 1px; +} + +#navigation li { + text-indent: -1em; + display: block; + margin: 3px 0px 0px 22px; +} + +#navigation li li a { + margin: 0px 3px 0px -1em; +} + +#content { + margin-left: 14em; + padding: 1em; + width: 700px; + border-left: 2px solid #cccccc; + border-right: 2px solid #cccccc; + background-color: #ffffff; +} + +#about { + clear: both; + padding: 5px; + border-top: 2px solid #cccccc; + background-color: #ffffff; +} + +@media print { + body { + font: 12pt "Times New Roman", "TimeNR", Times, serif; + } + a { font-weight: bold; color: #004080; text-decoration: underline; } + + #main { + background-color: #ffffff; + border-left: 0px; + } + + #container { + margin-left: 2%; + margin-right: 2%; + background-color: #ffffff; + } + + #content { + padding: 1em; + background-color: #ffffff; + } + + #navigation { + display: none; + } + pre.example { + font-family: "Andale Mono", monospace; + font-size: 10pt; + page-break-inside: avoid; + } +} + +table.module_list { + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.module_list td { + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.module_list td.name { background-color: #f0f0f0; min-width: 200px; } +table.module_list td.summary { width: 100%; } + + +table.function_list { + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.function_list td { + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.function_list td.name { background-color: #f0f0f0; min-width: 200px; } +table.function_list td.summary { width: 100%; } + +ul.nowrap { + overflow:auto; + white-space:nowrap; +} + +dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;} +dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;} +dl.table h3, dl.function h3 {font-size: .95em;} + +/* stop sublists from having initial vertical space */ +ul ul { margin-top: 0px; } +ol ul { margin-top: 0px; } +ol ol { margin-top: 0px; } +ul ol { margin-top: 0px; } + +/* make the target distinct; helps when we're navigating to a function */ +a:target + * { + background-color: #FF9; +} + +/* styles for prettification of source */ +pre .comment { color: #558817; } +pre .constant { color: #a8660d; } +pre .escape { color: #844631; } +pre .keyword { color: #aa5050; font-weight: bold; } +pre .library { color: #0e7c6b; } +pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; } +pre .string { color: #8080ff; } +pre .number { color: #f8660d; } +pre .operator { color: #2239a8; font-weight: bold; } +pre .preprocessor, pre .prepro { color: #a33243; } +pre .global { color: #800080; } +pre .prompt { color: #558817; } +pre .url { color: #272fc2; text-decoration: underline; } diff --git a/doc/modules/cleanup.html b/doc/modules/cleanup.html new file mode 100644 index 000000000..022b3b6ee --- /dev/null +++ b/doc/modules/cleanup.html @@ -0,0 +1,307 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module cleanup

+

CLEANUP will keep (a) CleanUp Zone(s) clean.

+

This class can be used to KEEP airbases or farps clean (note the word keep here, it cannot destroy units that are already dead). + The CleanUp class works with 2 validation logic compontents: + * EVENT validation: An event detection to intercept HIT events, upon which a validation of units CLEANUP CONDITIONS are applied. Once a unit is HIT, it is registered in a TIMED validation logic. + * TIMED validation: Units registered in a TIMED validation, are repeatedly validated of certain CLEANUP CONDITIONS. + If the CLEANUP CONDITIONS apply, the unit will be destroyed, and the group will be destroyed. + * It does not clean the zone, it tries to keep it clean by destroying units or groups before they explode or crash into the ground. + * For airplanes or helicopters, when in the CleanUpZone: + ** When the unit is airborne, and it is HIT ( by a weapon or a crash of another unit ), CLEANUP will destroy the unit or group when the health of the unit reaches an AIRBORNE HEALTH LIMIT.

+ +
+When the unit is HIT, it will register the unit for further repeated health monitoring, until:
+
+ +

* the unit's health is beyond the an AIRBORNE HEALTH LIMIT + * until the height of the unit is below the safety zone to prevent it from crashing. + * When the unit is not airborne, and it is HIT, it will be registered + * When the unit is

+ + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + +
CLEANUP:New (ZoneNames, TimeInterval)Creates the main object which is handling the cleaning of the debris within the given Zone Names.
CLEANUP:_ExecuteDeadEvents (CleanUpUnit)This function is required, and used a non-documented feature.
CLEANUP:_CheckLife (the)Measures the life of a Unit using the LifeLimit treshold.
CLEANUP:_CleanUnit (CleanUpUnit)Cleans a Group from the DCSRTE.
CLEANUP:_EventAddForCleanUp (event)Detects if the Unit has an SEVENTENGINESHUTDOWN or an SEVENT_HIT within the given ZoneNames.
CLEANUP:_Scheduler ()At the defined time interval, CleanUp the Groups within the CleanUpList.
+ +
+
+ + +

Functions

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

Parameters:

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

Returns:

+
    + + CLEANUP + + + +
+ + + +

Usage:

+
    + 
    + -- Clean these Zones.
+ CleanUpAirports = CLEANUP:New( { 'CLEAN Tbilisi', 'CLEAN Kutaisi' }, 150 )
+ or
+ CleanUpTbilisi = CLEANUP:New( 'CLEAN Tbilisi', 150 )
+ CleanUpKutaisi = CLEANUP:New( 'CLEAN Kutaisi', 600 )
    +
+ +
+
+ + CLEANUP:_ExecuteDeadEvents (CleanUpUnit) +
+
+ This function is required, and used a non-documented feature. The function world.onEvent will loop through all registered event handlers with the event structure given. + This is required to be done because the method Group.destroy(Group) does not generate the SEVENTDEAD through all the registered event handlers. + As such, the other classes using the SEVENTDEAD will get confused if this event is not catched properly... + + +

Parameters:

+
    +
  • CleanUpUnit + + + +
    • +
+ + + + + +
+
+ + CLEANUP:_CheckLife (the) +
+
+ Measures the life of a Unit using the LifeLimit treshold. Returns true if Group has a life lower than the treshold, false if the life is still okay. + + +

Parameters:

+
    +
  • the + Group + Group to be cleaned. +
    • +
+ +

Returns:

+
    + + bool + + + +
+ + + + +
+
+ + CLEANUP:_CleanUnit (CleanUpUnit) +
+
+ Cleans a Group from the DCSRTE. + + +

Parameters:

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

Parameters:

+
    +
  • event + + + +
    • +
+ + + + + +
+
+ + CLEANUP:_Scheduler () +
+
+ At the defined time interval, CleanUp the Groups within the CleanUpList. + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-02-11 11:12:10 +
+
+ + diff --git a/doc/modules/routines.html b/doc/modules/routines.html new file mode 100644 index 000000000..110b7aa33 --- /dev/null +++ b/doc/modules/routines.html @@ -0,0 +1,210 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module routines

+

Various routines

+

+ +

+

Info:

+
    +
  • Author: Flightcontrol
    • +
+ + +

Functions

+ + + + + + + + + +
do_scheduled_functions ()not intended for users to use this function.
ChooseInfantry (TeleportPrefixTable, TeleportMax)Obsolete function, but kept to rework in framework.
+

Tables

+ + + + + + + + + +
routinesExtract of MIST functions.
utilsUtils- conversion, Lua utils, etc.
+ +
+
+ + +

Functions

+ +
+
+ + do_scheduled_functions () +
+
+ not intended for users to use this function. + + + + + + + +
+
+ + ChooseInfantry (TeleportPrefixTable, TeleportMax) +
+
+ Obsolete function, but kept to rework in framework. + + +

Parameters:

+
    +
  • TeleportPrefixTable + + + +
    • +
  • TeleportMax + + + +
    • +
+ + + + + +
+
+

Tables

+ +
+
+ + routines +
+
+ Extract of MIST functions. + + + + + + + +
+
+ + utils +
+
+ Utils- conversion, Lua utils, etc. + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/modules/trace.html b/doc/modules/trace.html new file mode 100644 index 000000000..056e1959a --- /dev/null +++ b/doc/modules/trace.html @@ -0,0 +1,106 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module trace

+

Tracing functions...

+

+ +

+

Info:

+
    +
  • Author: Flightcontrol
    • +
+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/scripts/eStatHandler.html b/doc/scripts/eStatHandler.html new file mode 100644 index 000000000..9fab8910b --- /dev/null +++ b/doc/scripts/eStatHandler.html @@ -0,0 +1,102 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Script eStatHandler

+

Provides a logging of statistics in a running DCS Mission.

+

+ +

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ + diff --git a/doc/topics/manual.md.html b/doc/topics/manual.md.html new file mode 100644 index 000000000..2177d6bbc --- /dev/null +++ b/doc/topics/manual.md.html @@ -0,0 +1,178 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ + +

MOOSE Framework for Eagle Dynamics DCS World

+ +

+

Context

+

MOOSE is a Mission Object Oriented Scripting Environment, and is meant for mission designers and mission hosters. +It allows (will allow) to quickly setup complex missions using pre-scripted scenarios. +In order to run missions using this framework, you will need to install the framework within your Eagle Dynamics program files folder.

+ +

The goal of MOOSE is to allow mission designers to enhance their scripting with mission orchestration objects, which can be instantiated from defined classes within the framework. +This will allow to write mission scripts with minimal code embedded. Of course, the richness of the framework will determine the richness of the misson scenarios. +We can expect that MOOSE will evolve over time, as more missions will be designed within the framework.

+ +

+

Currently supported functions

+

MOOSE contains currently the following mission design functions. The words in CAPITAL letters document the classes that can be used within MOOSE to accomplish these functions.

+ +
    +
  1. SPAWN Dynamic spawning and respawning of Groups with related functions.
    2. +
  2. MOVEMENT Keeps control over the amount of units driving around the battlefield simultaneously.
    3. +
  3. CLEANUP Clean-Up zones with air units that crashed. Can be used to prevent airports blocking air traffic and ground control operations due to crashed units near the airfield.
    4. +
  4. SEAD Enables the defenses for SAM sites. Mobile SAMs will evade fired anti-radiation missiles by shutting down their radars (for a while). If they are mobile, they will also drive away.
    5. +
  5. MISSION Create Taskforces or Missions within a DCS Mission. A mission will consist of TASKs, and CLIENTs.
    6. +
  6. TASK Add tasks for the mission. There are many different tasks that can be given, by using the classes derived from TASK.
    7. +
  7. DEPLOYTASK Deploy Cargo within a zone.
    8. +
  8. PICKUPTASK Pick-Up Cargo from a zone.
    9. +
  9. GOHOMETASK Fly back home.
    10. +
  10. DESTROYGROUPSTASK Destroy Groups.
    11. +
  11. DESTROYUNITTYPESTASK Destroy Units by measuring their UNIT Type.
    12. +
  12. DESTROYRADARSTASK Destroy Radars of SAM Groups.
    13. +
  13. SLINGLOADHOOKTASK Hook-Up Cargo within a zone and sling-load it outside of the zone.
    14. +
  14. SLINGLOADUNHOOKTASK Sling-load Cargo to a zone and Un-Hook the Cargo within the zone.
    15. +
  15. CLIENT Registers a client within MOOSE.
    16. +
  16. MESSAGE Send messages to CLIENTs.
    17. +
  17. MENU Menu System.
    18. +
+ +

+

Installation

+

The installation of the MOOSE framework is straightforward.

+ +
    +

  1. Extract MOOSE.zip. You can do this quickly by right clicking the MOOSE.zip file, and select "Extract All".

    2. +

  2. The extraction will add a directory within the Scripts directory of the Eagle Dynamics DCS world installation. + Example, the Scripts directory of my DCS World installation folder is C:\Program Files\Eagle Dynamics\DCS World\Scripts

    3. +

  3. Browse within the new MOOSE directory to the DCS_Script directory and run Install.bat as an administrator. + This will make a backup of the missionScripting.lua file and replace this with a new one.

    4. +
+ +

And you're done.

+ +

+

What has changed?

+ +

Not much. The missionscripting.lua file has been enhanced with the following code:

+ +
+ +
+Include = {}
+
+Include.LoadPath = 'Scripts/MOOSE'
+Include.Files = {}
+
+Include.File = function( IncludeFile )
+    if not Include.Files[ IncludeFile ] then
+        Include.Files[IncludeFile] = IncludeFile
+        dofile( Include.LoadPath .. "/" .. IncludeFile .. ".lua" )
+        env.info( "Include:" .. IncludeFile .. " loaded." )
+    end
+end
+
+Include.File( "Database" )
+Include.File( "StatHandler" )
+
+ +
+ +

This code allows for the inclusion of the MOOSE framework, and this now becomes part of your DCS World Simulation Engine. +Missions designed with the MOOSE framework will now run.

+ + + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ +