diff --git a/Documentation/Base.html b/Documentation/Base.html new file mode 100644 index 000000000..dd64bba02 --- /dev/null +++ b/Documentation/Base.html @@ -0,0 +1,756 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Base

+ +

BASE The base class for all the classes defined within MOOSE.

+ +

Global(s)

+ + + + + + + + + +
BASE + +
FORMATION + +
+

Type BASE

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BASE:AddEvent(Event, EventFunction) + +
BASE.ClassID +

The ID number of the class.

+
BASE.ClassName +

The name of the class.

+
BASE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) + +
BASE:CreateEventCrash(EventTime, Initiator) + +
BASE:DisableEvents() + +
BASE:E(Arguments) + +
BASE:EnableEvents() + +
BASE.Events + +
BASE:F(Arguments) + +
BASE:F2(Arguments) + +
BASE:F3(Arguments) + +
BASE:GetClassID() +

Get the ClassID of the class instance.

+
BASE:GetClassName() +

Get the ClassName of the class instance.

+
BASE:GetClassNameAndID() +

Get the ClassName + ClassID of the class instance.

+
BASE.Inherit(Child, Parent, self) +

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

+
BASE.Inherited(Child, self) +

This is the worker method to retrieve the Parent class.

+
BASE:New() + +
BASE:T(Arguments) + +
BASE:T2(Arguments) + +
BASE:T3(Arguments) + +
BASE:onEvent(event) + +
+ +

Type FORMATION

+ + + + + +
FORMATION.Cone +

A cone formation.

+
+ +

Global(s)

+
+
+ + #BASE + +BASE + +
+
+ + + +
+
+
+
+ + #FORMATION + +FORMATION + +
+
+ + + +
+
+

Type Base

+ +

Type BASE

+ +

The BASE Class

+ +

Field(s)

+
+
+ + +BASE:AddEvent(Event, EventFunction) + +
+
+ + + +

Parameters

+
    +
  • + +

    Event :

    + +
    • +
  • + +

    EventFunction :

    + +
    • +
+
+
+
+
+ + +BASE.ClassID + +
+
+ +

The ID number of the class.

+ +
+
+
+
+ + +BASE.ClassName + +
+
+ +

The name of the class.

+ +
+
+
+
+ + +BASE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) + +
+
+ + + +

Parameters

+
    +
  • + +

    EventTime :

    + +
    • +
  • + +

    Initiator :

    + +
    • +
  • + +

    IniUnitName :

    + +
    • +
  • + +

    place :

    + +
    • +
  • + +

    subplace :

    + +
    • +
+
+
+
+
+ + +BASE:CreateEventCrash(EventTime, Initiator) + +
+
+ + + +

Parameters

+
    +
  • + +

    EventTime :

    + +
    • +
  • + +

    Initiator :

    + +
    • +
+
+
+
+
+ + +BASE:DisableEvents() + +
+
+ + + +
+
+
+
+ + +BASE:E(Arguments) + +
+
+ + + + +

Log an exception

+ +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:EnableEvents() + +
+
+ + + +
+
+
+
+ + + +BASE.Events + +
+
+ + + +
+
+
+
+ + +BASE:F(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:F2(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:F3(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:GetClassID() + +
+
+ +

Get the ClassID of the class instance.

+ +

Return value

+ +

#string: +The ClassID of the class instance.

+ +
+
+
+
+ + +BASE:GetClassName() + +
+
+ +

Get the ClassName of the class instance.

+ +

Return value

+ +

#string: +The ClassName of the class instance.

+ +
+
+
+
+ + +BASE:GetClassNameAndID() + +
+
+ +

Get the ClassName + ClassID of the class instance.

+ + +

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

+ +

Return value

+ +

#string: +The ClassName + ClassID of the class instance.

+ +
+
+
+
+ + +BASE.Inherit(Child, Parent, self) + +
+
+ +

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

+ +

Parameters

+
    +
  • + +

    Child : +is the Child class that inherits.

    + +
    • +
  • + +

    Parent : +is the Parent class that the Child inherits from.

    + +
    • +
  • + +

    self :

    + +
    • +
+

Return value

+ + +

Child

+ +
+
+
+
+ + +BASE.Inherited(Child, self) + +
+
+ +

This is the worker method to retrieve the Parent class.

+ +

Parameters

+
    +
  • + +

    #BASE Child : +is the Child class from which the Parent class needs to be retrieved.

    + +
    • +
  • + +

    self :

    + +
    • +
+

Return value

+ +

#BASE:

+ + +
+
+
+
+ + +BASE:New() + +
+
+ + + +
+
+
+
+ + +BASE:T(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:T2(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:T3(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:onEvent(event) + +
+
+ + + +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+ +

Type FORMATION

+ +

The Formation Class

+ +

Field(s)

+
+
+ + +FORMATION.Cone + +
+
+ +

A cone formation.

+ +
+
+ +
+ +
+ + diff --git a/Documentation/CARGO.html b/Documentation/CARGO.html new file mode 100644 index 000000000..796636888 --- /dev/null +++ b/Documentation/CARGO.html @@ -0,0 +1,215 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module CARGO

+ +

CARGO Classes

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CARGO + +
CARGOS + +
CARGO_GROUP + +
CARGO_PACKAGE + +
CARGO_SLINGLOAD + +
CARGO_ZONE + +
CargoStatic + +
+

Global(s)

+
+
+ + + +CARGO + +
+
+ + + +
+
+
+
+ + + +CARGOS + +
+
+ + + +
+
+
+
+ + + +CARGO_GROUP + +
+
+ + + +
+
+
+
+ + + +CARGO_PACKAGE + +
+
+ + + +
+
+
+
+ + + +CARGO_SLINGLOAD + +
+
+ + + +
+
+
+
+ + + +CARGO_ZONE + +
+
+ + + +
+
+
+
+ + + +CargoStatic + +
+
+ + + +
+
+

Type CARGO

+ +
+ +
+ + diff --git a/Documentation/CLEANUP.html b/Documentation/CLEANUP.html new file mode 100644 index 000000000..6bd698e94 --- /dev/null +++ b/Documentation/CLEANUP.html @@ -0,0 +1,497 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module CLEANUP

+ +

CLEANUP Classes

+ +

Global(s)

+ + + + + + + + + +
CLEANUP + +
CleanUpSurfaceTypeText + +
+

Type CLEANUP

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CLEANUP.ClassName + +
CLEANUP.CleanUpList + +
CLEANUP:New(ZoneNames, TimeInterval) + +
CLEANUP.TimeInterval + +
CLEANUP.ZoneNames + +
CLEANUP:_AddForCleanUp(CleanUpUnit, CleanUpUnitName) + +
CLEANUP:_DestroyGroup(GroupObject, CleanUpGroupName) +

Destroys a group from the simulator, but checks first if it is still existing!

+
CLEANUP:_DestroyMissile(MissileObject) +

Destroys a missile from the simulator, but checks first if it is still existing!

+
CLEANUP:_DestroyUnit(CleanUpUnit, CleanUpUnitName) +

Destroys a unit from the simulator, but checks first if it is still existing!

+
CLEANUP:_EventAddForCleanUp(event) +

Detects if the Unit has an SEVENTENGINESHUTDOWN or an SEVENT_HIT within the given ZoneNames.

+
CLEANUP:_EventCrash(event) +

Detects if an SA site was shot with an anti radiation missile.

+
CLEANUP:_EventHitCleanUp(event) +

Detects if the Unit has an SEVENTHIT within the given ZoneNames.

+
CLEANUP:_EventShot(event) +

Detects if an SA site was shot with an anti radiation missile.

+
CLEANUP:_Scheduler() +

At the defined time interval, CleanUp the Groups within the CleanUpList.

+
+ +

Global(s)

+
+
+ + #CLEANUP + +CLEANUP + +
+
+ + + +
+
+
+
+ + + +CleanUpSurfaceTypeText + +
+
+ + + +
+
+

Type CLEANUP

+ +

The CLEANUP class.

+ +

Field(s)

+
+
+ + #string + +CLEANUP.ClassName + +
+
+ + + +
+
+
+
+ + + +CLEANUP.CleanUpList + +
+
+ + + +
+
+
+
+ + +CLEANUP:New(ZoneNames, TimeInterval) + +
+
+ + + +

Parameters

+
    +
  • + +

    ZoneNames :

    + +
    • +
  • + +

    TimeInterval :

    + +
    • +
+
+
+
+
+ + #number + +CLEANUP.TimeInterval + +
+
+ + + +
+
+
+
+ + + +CLEANUP.ZoneNames + +
+
+ + + +
+
+
+
+ + +CLEANUP:_AddForCleanUp(CleanUpUnit, CleanUpUnitName) + +
+
+ + + +

Parameters

+
    +
  • + +

    CleanUpUnit :

    + +
    • +
  • + +

    CleanUpUnitName :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_DestroyGroup(GroupObject, CleanUpGroupName) + +
+
+ +

Destroys a group from the simulator, but checks first if it is still existing!

+ +

Parameters

+
    +
  • + +

    GroupObject :

    + +
    • +
  • + +

    CleanUpGroupName :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_DestroyMissile(MissileObject) + +
+
+ +

Destroys a missile from the simulator, but checks first if it is still existing!

+ +

Parameter

+
    +
  • + +

    MissileObject :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_DestroyUnit(CleanUpUnit, CleanUpUnitName) + +
+
+ +

Destroys a unit from the simulator, but checks first if it is still existing!

+ +

Parameters

+
    +
  • + +

    CleanUpUnit :

    + +
    • +
  • + +

    CleanUpUnitName :

    + +
    • +
+
+
+
+
+ + +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.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_EventCrash(event) + +
+
+ +

Detects if an SA site was shot with an anti radiation missile.

+ + +

In this case, take evasive actions based on the skill level set within the ME.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_EventHitCleanUp(event) + +
+
+ +

Detects if the Unit has an SEVENTHIT within the given ZoneNames.

+ + +

If this is the case, destroy the unit.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_EventShot(event) + +
+
+ +

Detects if an SA site was shot with an anti radiation missile.

+ + +

In this case, take evasive actions based on the skill level set within the ME.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_Scheduler() + +
+
+ +

At the defined time interval, CleanUp the Groups within the CleanUpList.

+ +
+
+ +
+ +
+ + diff --git a/Documentation/Client.html b/Documentation/Client.html new file mode 100644 index 000000000..1b71011cd --- /dev/null +++ b/Documentation/Client.html @@ -0,0 +1,955 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Client

+ +

CLIENT Classes

+ +

Global(s)

+ + + + + + + + + +
CLIENT + +
ClientGroupUnit + +
+

Type CLIENT

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CLIENT.AddBriefing(string, self, ClientBriefing) +

AddBriefing adds a briefing to a Client when a Player joins a Mission.

+
CLIENT:Alive(CallBack) +

Checks for a client alive event and calls a function on a continuous basis.

+
CLIENT.AliveCheckFunction + +
CLIENT.ClassName + +
CLIENT.ClientAlive + +
CLIENT.ClientAlive2 + +
CLIENT.ClientBriefingShown + +
CLIENT.ClientCallBack + +
CLIENT.ClientName + +
CLIENT:ClientPosition() +

Returns the Position of the CLIENT.

+
CLIENT.ClientTransport + +
CLIENT:GetAltitude() +

Returns the altitude of the CLIENT.

+
CLIENT:GetClientGroupDCSUnit() +

Returns the DCSUnit of the CLIENT.

+
CLIENT:GetClientGroupID() + +
CLIENT:GetClientGroupName() + +
CLIENT:GetClientGroupUnit() +

Returns the Unit of the CLIENT.

+
CLIENT:GetDCSGroup() +

Return the DCSGroup of a Client.

+
CLIENT:GetPointVec2() +

Returns the Point of the CLIENT.

+
CLIENT:GetUnit() + +
CLIENT:IsAlive(Returns) +

Checks if client is alive and returns true or false.

+
CLIENT:IsTransport() +

IsTransport returns if a Client is a transport.

+
CLIENT.Message(string, number, string, string, number, self, Message, MessageDuration, MessageId, MessageCategory, MessageInterval) +

Message is the key Message driver for the CLIENT class.

+
CLIENT.Messages + +
CLIENT:New(ClientName, ClientBriefing) +

Use this method to register new Clients within the MOF.

+
CLIENT.ONBOARDSIDE + +
CLIENT.Reset(string, self, ClientName) +

Resets a CLIENT.

+
CLIENT:ShowCargo() +

ShowCargo shows the CARGO within the CLIENT to the Player.

+
CLIENT.SwitchMessages(PrmTable) +

SwitchMessages is a local function called by the DCS World Menu system to switch off messages.

+
CLIENT:Transport() +

Transport defines that the Client is a Transport.

+
CLIENT:_AliveCheckCallBack() + +
CLIENT._Menus + +
CLIENT._Tasks + +
+ +

Global(s)

+
+
+ + #CLIENT + +CLIENT + +
+
+ + + +
+
+
+
+ + + +ClientGroupUnit + +
+
+ + + +
+
+

Type Client

+ +

Type CLIENT

+ +

The CLIENT class

+ +

Field(s)

+
+
+ + +CLIENT.AddBriefing(string, self, ClientBriefing) + +
+
+ +

AddBriefing adds a briefing to a Client when a Player joins a Mission.

+ +

Parameters

+
    +
  • + +

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

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    ClientBriefing :

    + +
    • +
+

Return value

+ + +

CLIENT

+ +
+
+
+
+ + +CLIENT:Alive(CallBack) + +
+
+ +

Checks for a client alive event and calls a function on a continuous basis.

+ +

Parameter

+
    +
  • + +

    #function CallBack : +Function.

    + +
    • +
+
+
+
+
+ + + +CLIENT.AliveCheckFunction + +
+
+ + + +
+
+
+
+ + #string + +CLIENT.ClassName + +
+
+ + + +
+
+
+
+ + #boolean + +CLIENT.ClientAlive + +
+
+ + + +
+
+
+
+ + #boolean + +CLIENT.ClientAlive2 + +
+
+ + + +
+
+
+
+ + #boolean + +CLIENT.ClientBriefingShown + +
+
+ + + +
+
+
+
+ + + +CLIENT.ClientCallBack + +
+
+ + + +
+
+
+
+ + +CLIENT.ClientName + +
+
+ + + +
+
+
+
+ + +CLIENT:ClientPosition() + +
+
+ +

Returns the Position of the CLIENT.

+ +

Return value

+ +

DCSTypes#Position:

+ + +
+
+
+
+ + #boolean + +CLIENT.ClientTransport + +
+
+ + + +
+
+
+
+ + +CLIENT:GetAltitude() + +
+
+ +

Returns the altitude of the CLIENT.

+ +

Return value

+ +

DCSTypes#Distance:

+ + +
+
+
+
+ + +CLIENT:GetClientGroupDCSUnit() + +
+
+ +

Returns the DCSUnit of the CLIENT.

+ +

Return value

+ + +

DCSUnit

+ +
+
+
+
+ + +CLIENT:GetClientGroupID() + +
+
+ + + +
+
+
+
+ + +CLIENT:GetClientGroupName() + +
+
+ + + +
+
+
+
+ + +CLIENT:GetClientGroupUnit() + +
+
+ +

Returns the Unit of the CLIENT.

+ +

Return value

+ +

Unit#UNIT:

+ + +
+
+
+
+ + +CLIENT:GetDCSGroup() + +
+
+ +

Return the DCSGroup of a Client.

+ + +

This function is modified to deal with a couple of bugs in DCS 1.5.3

+ +

Return value

+ +

DCSGroup#Group:

+ + +
+
+
+
+ + +CLIENT:GetPointVec2() + +
+
+ +

Returns the Point of the CLIENT.

+ +

Return value

+ +

DCSTypes#Vec2:

+ + +
+
+
+
+ + +CLIENT:GetUnit() + +
+
+ + + +
+
+
+
+ + +CLIENT:IsAlive(Returns) + +
+
+ +

Checks if client is alive and returns true or false.

+ +

Parameter

+
    +
  • + +

    #boolean Returns : +true if client is alive.

    + +
    • +
+
+
+
+
+ + +CLIENT:IsTransport() + +
+
+ +

IsTransport returns if a Client is a transport.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + +CLIENT.Message(string, number, string, string, number, self, 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

+
    +
  • + +

    string : +Message is the text describing the message.

    + +
    • +
  • + +

    number : +MessageDuration is the duration in seconds that the Message should be displayed.

    + +
    • +
  • + +

    string : +MessageId is a text identifying the Message in the MessageQueue. The Message system overwrites Messages with the same MessageId

    + +
    • +
  • + +

    string : +MessageCategory is the category of the message (the title).

    + +
    • +
  • + +

    number : +MessageInterval is the interval in seconds between the display of the Message when the CLIENT is in the air.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    Message :

    + +
    • +
  • + +

    MessageDuration :

    + +
    • +
  • + +

    MessageId :

    + +
    • +
  • + +

    MessageCategory :

    + +
    • +
  • + +

    MessageInterval :

    + +
    • +
+
+
+
+
+ + + +CLIENT.Messages + +
+
+ + + +
+
+
+
+ + +CLIENT:New(ClientName, ClientBriefing) + +
+
+ +

Use this method to register new Clients within the MOF.

+ +

Parameters

+
    +
  • + +

    #string ClientName : +Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client.

    + +
    • +
  • + +

    #string ClientBriefing : +Text that describes the briefing of the mission when a Player logs into the Client.

    + +
    • +
+

Return value

+ +

#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.ONBOARDSIDE + +
+
+ + + +
+
+
+
+ + +CLIENT.Reset(string, self, ClientName) + +
+
+ +

Resets a CLIENT.

+ +

Parameters

+
    +
  • + +

    string : +ClientName Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    ClientName :

    + +
    • +
+
+
+
+
+ + +CLIENT:ShowCargo() + +
+
+ +

ShowCargo shows the CARGO within the CLIENT to the Player.

+ + +

The CARGO is shown throught the MESSAGE system of DCS World.

+ +
+
+
+
+ + +CLIENT.SwitchMessages(PrmTable) + +
+
+ +

SwitchMessages is a local function called by the DCS World Menu system to switch off messages.

+ +

Parameter

+
    +
  • + +

    PrmTable :

    + +
    • +
+
+
+
+
+ + +CLIENT:Transport() + +
+
+ +

Transport defines that the Client is a Transport.

+ +

Return value

+ + +

CLIENT

+ +
+
+
+
+ + +CLIENT:_AliveCheckCallBack() + +
+
+ + + +
+
+
+
+ + + +CLIENT._Menus + +
+
+ + + +
+
+
+
+ + + +CLIENT._Tasks + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Documentation/DCSAirbase.html b/Documentation/DCSAirbase.html new file mode 100644 index 000000000..ef29a2605 --- /dev/null +++ b/Documentation/DCSAirbase.html @@ -0,0 +1,442 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DCSAirbase

+ + + +

Global(s)

+ + + + + +
Airbase + +
+

Type Airbase

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Airbase.Category +

enum contains identifiers of airbase categories.

+
Airbase.Desc +

Airbase descriptor. Airdromes are unique and their types are unique, but helipads and ships are not always unique and may have the same type.

+
Airbase.ID +

Identifier of an airbase. It assigned to an airbase by the Mission Editor automatically. This identifier is used in AI tasks to refer an airbase that exists (spawned and not dead) or not.

+
Airbase.getByName(name) +

Returns airbase by its name.

+
Airbase:getCallsign() +

Returns the airbase's callsign - the localized string.

+
Airbase:getDesc() +

Returns descriptor of the airbase.

+
Airbase.getDescByName(typeName) +

Returns airbase descriptor by type name.

+
Airbase:getID() +

Returns identifier of the airbase.

+
Airbase:getUnit() +

Returns Unit that is corresponded to the airbase.

+
+ +

Type Airbase.Category

+ + + + + + + + + + + + + +
Airbase.Category.AIRDROME + +
Airbase.Category.HELIPAD + +
Airbase.Category.SHIP + +
+ +

Type Airbase.Desc

+ + + + + +
Airbase.Desc.category +

Category of the airbase type.

+
+ +

Global(s)

+
+
+ + #Airbase + +Airbase + +
+
+ + + +
+
+

Type DCSAirbase

+ +

Type Airbase

+ +

Represents airbases: airdromes, helipads and ships with flying decks or landing pads.

+ + +

+ +

Field(s)

+
+
+ + #Airbase.Category + +Airbase.Category + +
+
+ +

enum contains identifiers of airbase categories.

+ +
+
+
+
+ + #Airbase.Desc + +Airbase.Desc + +
+
+ +

Airbase descriptor. Airdromes are unique and their types are unique, but helipads and ships are not always unique and may have the same type.

+ +
+
+
+
+ + #Airbase.ID + +Airbase.ID + +
+
+ +

Identifier of an airbase. It assigned to an airbase by the Mission Editor automatically. This identifier is used in AI tasks to refer an airbase that exists (spawned and not dead) or not.

+ +
+
+
+
+ + +Airbase.getByName(name) + +
+
+ +

Returns airbase by its name.

+ + +

If no airbase found the function will return nil.

+ +

Parameter

+
    +
  • + +

    #string name :

    + +
    • +
+

Return value

+ +

#Airbase:

+ + +
+
+
+
+ + +Airbase:getCallsign() + +
+
+ +

Returns the airbase's callsign - the localized string.

+ +

Return value

+ +

#string:

+ + +
+
+
+
+ + +Airbase:getDesc() + +
+
+ +

Returns descriptor of the airbase.

+ +

Return value

+ +

#Airbase.Desc:

+ + +
+
+
+
+ + +Airbase.getDescByName(typeName) + +
+
+ +

Returns airbase descriptor by type name.

+ + +

If no descriptor is found the function will return nil.

+ +

Parameter

+
    +
  • + +

    #TypeName typeName : +Airbase type name.

    + +
    • +
+

Return value

+ +

#Airbase.Desc:

+ + +
+
+
+
+ + +Airbase:getID() + +
+
+ +

Returns identifier of the airbase.

+ +

Return value

+ +

#Airbase.ID:

+ + +
+
+
+
+ + +Airbase:getUnit() + +
+
+ +

Returns Unit that is corresponded to the airbase.

+ + +

Works only for ships.

+ +

Return value

+ +

Unit#Unit:

+ + +
+
+ +

Type Airbase.Category

+ +

Enum contains identifiers of airbase categories.

+ +

Field(s)

+
+
+ + +Airbase.Category.AIRDROME + +
+
+ + + +
+
+
+
+ + +Airbase.Category.HELIPAD + +
+
+ + + +
+
+
+
+ + +Airbase.Category.SHIP + +
+
+ + + +
+
+ +

Type Airbase.Desc

+ +

Airbase descriptor.

+ + +

Airdromes are unique and their types are unique, but helipads and ships are not always unique and may have the same type.

+ +

Field(s)

+
+
+ + #Airbase.Category + +Airbase.Desc.category + +
+
+ +

Category of the airbase type.

+ +
+
+ +

Type Airbase.ID

+ +

Type TypeName

+ +
+ +
+ + diff --git a/Documentation/DCSCoalitionObject.html b/Documentation/DCSCoalitionObject.html new file mode 100644 index 000000000..b0e504542 --- /dev/null +++ b/Documentation/DCSCoalitionObject.html @@ -0,0 +1,154 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DCSCoalitionObject

+ + + +

Global(s)

+ + + + + +
CoalitionObject + +
+

Type CoalitionObject

+ + + + + + + + + +
CoalitionObject:getCoalition() +

Returns coalition of the object.

+
CoalitionObject:getCountry() +

Returns object country.

+
+ +

Global(s)

+
+
+ + #CoalitionObject + +CoalitionObject + +
+
+ + + +
+
+

Type DCSCoalitionObject

+ +

Type CoalitionObject

+

Field(s)

+
+
+ + +CoalitionObject:getCoalition() + +
+
+ +

Returns coalition of the object.

+ +

Return value

+ +

#coalition.side:

+ + +
+
+
+
+ + +CoalitionObject:getCountry() + +
+
+ +

Returns object country.

+ +

Return value

+ +

#country.id:

+ + +
+
+ +

Type coalition.side

+ +

Type country.id

+ +
+ +
+ + diff --git a/Documentation/DCSController.html b/Documentation/DCSController.html new file mode 100644 index 000000000..39af114b7 --- /dev/null +++ b/Documentation/DCSController.html @@ -0,0 +1,717 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DCSController

+ + + +

Global(s)

+ + + + + +
Controller + +
+

Type Controller

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Controller.Detection +

Enum contains identifiers of surface types.

+
Controller:getDetectedTargets(detection) +

Returns list of detected targets.

+
Controller:hasTask() +

Returns true if the controller has a task.

+
Controller:isTargetDetected(target, detection) +

Checks if the target is detected or not.

+
Controller:knowTarget(object, type, distance) +

Know a target.

+
Controller:popTask() +

Pops current (front) task from the queue and makes active next task in the queue (if exists).

+
Controller:pushTask(task) +

Pushes the task to the front of the queue and makes the task active.

+
Controller:resetTask() +

Resets current task of the controller.

+
Controller:setOnOff(value) +

Enables and disables the controller.

+
Controller:setOption(optionId, optionValue) +

Sets the option to the controller.

+
Controller:setTask(task) +

Resets current task and then sets the task to the controller.

+
+ +

Type Controller.Detection

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Controller.Detection.DLINK + +
Controller.Detection.IRST + +
Controller.Detection.OPTIC + +
Controller.Detection.RADAR + +
Controller.Detection.RWR + +
Controller.Detection.VISUAL + +
+ +

Type DetectedTarget

+ + + + + + + + + + + + + + + + + +
DetectedTarget.distance +

Distance to the target is known

+
DetectedTarget.object +

The target

+
DetectedTarget.type +

The target type is known

+
DetectedTarget.visible +

The target is visible

+
+ +

Global(s)

+
+
+ + #Controller + +Controller + +
+
+ + + +
+
+

Type DCSController

+ +

Type Controller

+ +

Controller is an object that performs A.I.-routines.

+ + +

Other words controller is an instance of A.I.. Controller stores current main task, active enroute tasks and behavior options. Controller performs commands. Please, read DCS A-10C GUI Manual EN.pdf chapter "Task Planning for Unit Groups", page 91 to understand A.I. system of DCS:A-10C.

+ +

This class has 2 types of functions:

+ +
    +
  • Tasks
    • +
  • Commands: Commands are instant actions those required zero time to perform. Commands may be used both for control unit/group behavior and control game mechanics.
    • +
+ +

Field(s)

+
+
+ + #Controller.Detection + +Controller.Detection + +
+
+ +

Enum contains identifiers of surface types.

+ +
+
+
+
+ + +Controller:getDetectedTargets(detection) + +
+
+ +

Returns list of detected targets.

+ + +

If one or more detection method is specified the function will return targets which were detected by at least one of these methods. If no detection methods are specified the function will return targets which were detected by any method.

+ +

Parameter

+
    +
  • + +

    #Controller.Detection detection : +Controller.Detection detection1, Controller.Detection detection2, ... Controller.Detection detectionN

    + +
    • +
+

Return value

+ +

#list:

+

DetectedTarget> array of DetectedTarget

+ +
+
+
+
+ + +Controller:hasTask() + +
+
+ +

Returns true if the controller has a task.

+ +

Return value

+ +

#boolean:

+ + +
+
+
+
+ + +Controller:isTargetDetected(target, detection) + +
+
+ +

Checks if the target is detected or not.

+ + +

If one or more detection method is specified the function will return true if the target is detected by at least one of these methods. If no detection methods are specified the function will return true if the target is detected by any method.

+ +

Parameters

+
    +
  • + +

    Object#Object target : +Target to check

    + +
    • +
  • + +

    #Controller.Detection detection : +Controller.Detection detection1, Controller.Detection detection2, ... Controller.Detection detectionN

    + +
    • +
+

Return values

+
    +
  1. + +

    #boolean: +detected True if the target is detected.

    + +
    2. +
  2. + +

    #boolean: +visible Has effect only if detected is true. True if the target is visible now.

    + +
    3. +
  3. + +

    #ModelTime: +lastTime Has effect only if visible is false. Last time when target was seen.

    + +
    4. +
  4. + +

    #boolean: +type Has effect only if detected is true. True if the target type is known.

    + +
    5. +
  5. + +

    #boolean: +distance Has effect only if detected is true. True if the distance to the target is known.

    + +
    6. +
  6. + +

    #Vec3: +lastPos Has effect only if visible is false. Last position of the target when it was seen.

    + +
    7. +
  7. + +

    #Vec3: +lastVel Has effect only if visible is false. Last velocity of the target when it was seen.

    + +
    8. +
+
+
+
+
+ + +Controller:knowTarget(object, type, distance) + +
+
+ +

Know a target.

+ +

Parameters

+
    +
  • + +

    Object#Object object : +The target.

    + +
    • +
  • + +

    #boolean type : +Target type is known.

    + +
    • +
  • + +

    #boolean distance : +Distance to target is known.

    + +
    • +
+
+
+
+
+ + +Controller:popTask() + +
+
+ +

Pops current (front) task from the queue and makes active next task in the queue (if exists).

+ + +

If no more tasks in the queue the function works like function Controller.resetTask() function. Does nothing if the queue is empty.

+ +
+
+
+
+ + +Controller:pushTask(task) + +
+
+ +

Pushes the task to the front of the queue and makes the task active.

+ + +

Further call of function Controller.setTask() function will stop current task, clear the queue and set the new task active. If the task queue is empty the function will work like function Controller.setTask() function.

+ +

Parameter

+
    +
  • + +

    #Task task :

    + +
    • +
+
+
+
+
+ + +Controller:resetTask() + +
+
+ +

Resets current task of the controller.

+ +
+
+
+
+ + +Controller:setOnOff(value) + +
+
+ +

Enables and disables the controller.

+ + +

Note: Now it works only for ground / naval groups!

+ +

Parameter

+
    +
  • + +

    #boolean value : +Enable / Disable.

    + +
    • +
+
+
+
+
+ + +Controller:setOption(optionId, optionValue) + +
+
+ +

Sets the option to the controller.

+ + +

Option is a pair of identifier and value. Behavior options are global parameters those affect controller behavior in all tasks it performs. +Option identifiers and values are stored in table AI.Option in subtables Air, Ground and Naval.

+ +

OptionId = AI.Option.Air.id or AI.Option.Ground.id or AI.Option.Naval.id +OptionValue = AI.Option.Air.val[optionName] or AI.Option.Ground.val[optionName] or AI.Option.Naval.val[optionName]

+ + +

Parameters

+
    +
  • + +

    #OptionId optionId : +Option identifier.

    + +
    • +
  • + +

    #OptionValue optionValue : +Value of the option.

    + +
    • +
+
+
+
+
+ + +Controller:setTask(task) + +
+
+ +

Resets current task and then sets the task to the controller.

+ + +

Task is a table that contains task identifier and task parameters.

+ +

Parameter

+
    +
  • + +

    #Task task :

    + +
    • +
+
+
+ +

Type Controller.Detection

+ +

Enum contains identifiers of surface types.

+ +

Field(s)

+
+
+ + +Controller.Detection.DLINK + +
+
+ + + +
+
+
+
+ + +Controller.Detection.IRST + +
+
+ + + +
+
+
+
+ + +Controller.Detection.OPTIC + +
+
+ + + +
+
+
+
+ + +Controller.Detection.RADAR + +
+
+ + + +
+
+
+
+ + +Controller.Detection.RWR + +
+
+ + + +
+
+
+
+ + +Controller.Detection.VISUAL + +
+
+ + + +
+
+ +

Type DetectedTarget

+ +

Detected target.

+ +

Field(s)

+
+
+ + #boolean + +DetectedTarget.distance + +
+
+ +

Distance to the target is known

+ +
+
+
+
+ + Object#Object + +DetectedTarget.object + +
+
+ +

The target

+ +
+
+
+
+ + #boolean + +DetectedTarget.type + +
+
+ +

The target type is known

+ +
+
+
+
+ + #boolean + +DetectedTarget.visible + +
+
+ +

The target is visible

+ +
+
+ +

Type ModelTime

+ +

Type OptionId

+ +

Type OptionValue

+ +

Type Task

+ +

Type Vec3

+ +

Type list

+ +
+ +
+ + diff --git a/Documentation/DCSGroup.html b/Documentation/DCSGroup.html new file mode 100644 index 000000000..84f136e86 --- /dev/null +++ b/Documentation/DCSGroup.html @@ -0,0 +1,525 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DCSGroup

+ + + +

Global(s)

+ + + + + +
Group + +
+

Type Group

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Group.Category +

Enum contains identifiers of group types.

+
Group.ID +

Identifier of a group. It is assigned to a group by Mission Editor automatically.

+
Group:destroy() +

Destroys the group and all of its units.

+
Group.getByName(name) +

Returns group by the name assigned to the group in Mission Editor.

+
Group:getCategory() +

Returns category of the group.

+
Group:getController() +

Returns controller of the group.

+
Group:getID() +

Returns the group identifier.

+
Group:getInitialSize() +

Returns initial size of the group.

+
Group:getName() +

Returns the group's name.

+
Group:getSize() +

Returns current size of the group.

+
Group:getUnit(unitNumber) +

Returns the unit with number unitNumber.

+
Group:getUnits() +

Returns array of the units present in the group now.

+
Group:isExist() +

returns true if the group exist or false otherwise.

+
+ +

Type Group.Category

+ + + + + + + + + + + + + + + + + +
Group.Category.AIRPLANE + +
Group.Category.GROUND + +
Group.Category.HELICOPTER + +
Group.Category.SHIP + +
+ +

Global(s)

+
+
+ + #Group + +Group + +
+
+ + + +
+
+

Type DCSGroup

+ +

Type Group

+ +

Represents group of Units.

+ +

Field(s)

+
+
+ + #Group.Category + +Group.Category + +
+
+ +

Enum contains identifiers of group types.

+ +
+
+
+
+ + #ID + +Group.ID + +
+
+ +

Identifier of a group. It is assigned to a group by Mission Editor automatically.

+ +
+
+
+
+ + +Group:destroy() + +
+
+ +

Destroys the group and all of its units.

+ +
+
+
+
+ + +Group.getByName(name) + +
+
+ +

Returns group by the name assigned to the group in Mission Editor.

+ +

Parameter

+
    +
  • + +

    #string name :

    + +
    • +
+

Return value

+ +

#Group:

+ + +
+
+
+
+ + +Group:getCategory() + +
+
+ +

Returns category of the group.

+ +

Return value

+ +

#Group.Category:

+ + +
+
+
+
+ + +Group:getController() + +
+
+ +

Returns controller of the group.

+ +

Return value

+ +

Controller#Controller:

+ + +
+
+
+
+ + +Group:getID() + +
+
+ +

Returns the group identifier.

+ +

Return value

+ +

#ID:

+ + +
+
+
+
+ + +Group:getInitialSize() + +
+
+ +

Returns initial size of the group.

+ + +

If some of the units will be destroyed, initial size of the group will not be changed. Initial size limits the unitNumber parameter for Group.getUnit() function.

+ +

Return value

+ +

#number:

+ + +
+
+
+
+ + +Group:getName() + +
+
+ +

Returns the group's name.

+ + +

This is the same name assigned to the group in Mission Editor.

+ +

Return value

+ +

#string:

+ + +
+
+
+
+ + +Group:getSize() + +
+
+ +

Returns current size of the group.

+ + +

If some of the units will be destroyed, As units are destroyed the size of the group will be changed.

+ +

Return value

+ +

#number:

+ + +
+
+
+
+ + +Group:getUnit(unitNumber) + +
+
+ +

Returns the unit with number unitNumber.

+ + +

If the unit is not exists the function will return nil.

+ +

Parameter

+
    +
  • + +

    #number unitNumber :

    + +
    • +
+

Return value

+ +

DCSUnit#Unit:

+ + +
+
+
+
+ + +Group:getUnits() + +
+
+ +

Returns array of the units present in the group now.

+ + +

Destroyed units will not be enlisted at all.

+ +

Return value

+ +

#list: +DCSUnit#Unit> array of Units

+ +
+
+
+
+ + +Group:isExist() + +
+
+ +

returns true if the group exist or false otherwise.

+ +

Return value

+ +

#boolean:

+ + +
+
+ +

Type Group.Category

+ +

Enum contains identifiers of group types.

+ +

Field(s)

+
+
+ + +Group.Category.AIRPLANE + +
+
+ + + +
+
+
+
+ + +Group.Category.GROUND + +
+
+ + + +
+
+
+
+ + +Group.Category.HELICOPTER + +
+
+ + + +
+
+
+
+ + +Group.Category.SHIP + +
+
+ + + +
+
+ +

Type ID

+ +

Type list

+ +
+ +
+ + diff --git a/Documentation/DCSObject.html b/Documentation/DCSObject.html new file mode 100644 index 000000000..19b344586 --- /dev/null +++ b/Documentation/DCSObject.html @@ -0,0 +1,570 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DCSObject

+ + + +

Global(s)

+ + + + + +
Object + +
+

Type Object

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Object.Category + +
Object.Desc + +
Object:destroy() + +
Object:getCategory() + +
Object:getDesc() +

Returns object descriptor.

+
Object:getName() +

Returns name of the object.

+
Object:getPoint() +

Returns object coordinates for current time.

+
Object:getPosition() +

Returns object position for current time.

+
Object:getTypeName() +

Returns type name of the Object.

+
Object:getVelocity() +

Returns the unit's velocity vector.

+
Object:hasAttribute(attributeName) +

Returns true if the object belongs to the category.

+
Object:inAir() +

Returns true if the unit is in air.

+
Object:isExist() + +
+ +

Type Object.Category

+ + + + + + + + + + + + + + + + + + + + + +
Object.Category.BASE + +
Object.Category.SCENERY + +
Object.Category.STATIC + +
Object.Category.UNIT + +
Object.Category.WEAPON + +
+ +

Type Object.Desc

+ + + + + + + + + +
Object.Desc.box +

bounding box of collision geometry

+
Object.Desc.life +

initial life level

+
+ +

Global(s)

+
+
+ + #Object + +Object + +
+
+ + + +
+
+

Type DCSObject

+ +

Type AttributeName

+ +

Type Box3

+ +

Type Object

+

Field(s)

+
+
+ + #Object.Category + +Object.Category + +
+
+ + + +
+
+
+
+ + #Object.Desc + +Object.Desc + +
+
+ + + +
+
+
+
+ + +Object:destroy() + +
+
+ + + +
+
+
+
+ + +Object:getCategory() + +
+
+ + + +

Return value

+ +

#Object.Category:

+ + +
+
+
+
+ + +Object:getDesc() + +
+
+ +

Returns object descriptor.

+ +

Return value

+ +

#Object.Desc:

+ + +
+
+
+
+ + +Object:getName() + +
+
+ +

Returns name of the object.

+ + +

This is the name that is assigned to the object in the Mission Editor.

+ +

Return value

+ +

#string:

+ + +
+
+
+
+ + +Object:getPoint() + +
+
+ +

Returns object coordinates for current time.

+ +

Return value

+ +

#Vec3:

+ + +
+
+
+
+ + +Object:getPosition() + +
+
+ +

Returns object position for current time.

+ +

Return value

+ +

#Position3:

+ + +
+
+
+
+ + +Object:getTypeName() + +
+
+ +

Returns type name of the Object.

+ +

Return value

+ +

#string:

+ + +
+
+
+
+ + +Object:getVelocity() + +
+
+ +

Returns the unit's velocity vector.

+ +

Return value

+ +

#Vec3:

+ + +
+
+
+
+ + +Object:hasAttribute(attributeName) + +
+
+ +

Returns true if the object belongs to the category.

+ +

Parameter

+ +

Return value

+ +

#boolean:

+ + +
+
+
+
+ + +Object:inAir() + +
+
+ +

Returns true if the unit is in air.

+ +

Return value

+ +

#boolean:

+ + +
+
+
+
+ + +Object:isExist() + +
+
+ + + +

Return value

+ +

#boolean:

+ + +
+
+ +

Type Object.Category

+

Field(s)

+
+
+ + +Object.Category.BASE + +
+
+ + + +
+
+
+
+ + +Object.Category.SCENERY + +
+
+ + + +
+
+
+
+ + +Object.Category.STATIC + +
+
+ + + +
+
+
+
+ + +Object.Category.UNIT + +
+
+ + + +
+
+
+
+ + +Object.Category.WEAPON + +
+
+ + + +
+
+ +

Type Object.Desc

+

Field(s)

+
+
+ + #Box3 + +Object.Desc.box + +
+
+ +

bounding box of collision geometry

+ +
+
+
+
+ + #number + +Object.Desc.life + +
+
+ +

initial life level

+ +
+
+ +

Type Position3

+ +

Type Vec3

+ +
+ +
+ + diff --git a/Documentation/DCSTypes.html b/Documentation/DCSTypes.html new file mode 100644 index 000000000..dddec9f2f --- /dev/null +++ b/Documentation/DCSTypes.html @@ -0,0 +1,2470 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DCSTypes

+ + + +

Global(s)

+ + + + + +
AI + +
+

Type AI

+ + + + + + + + + + + + + +
AI.Option + +
AI.Skill + +
AI.Task + +
+ +

Type AI.Option

+ + + + + + + + + + + + + +
AI.Option.Air + +
AI.Option.Ground + +
AI.Option.Naval + +
+ +

Type AI.Option.Air

+ + + + + + + + + +
AI.Option.Air.id + +
AI.Option.Air.val + +
+ +

Type AI.Option.Air.val

+ + + + + + + + + + + + + + + + + +
AI.Option.Air.val.FLARE_USING + +
AI.Option.Air.val.RADAR_USING + +
AI.Option.Air.val.REACTION_ON_THREAT + +
AI.Option.Air.val.ROE + +
+ +

Type AI.Option.Air.val.FLARE_USING

+ + + + + + + + + + + + + + + + + +
AI.Option.Air.val.FLARE_USING.AGAINST_FIRED_MISSILE + +
AI.Option.Air.val.FLARE_USING.NEVER + +
AI.Option.Air.val.FLARE_USING.WHEN_FLYING_IN_SAM_WEZ + +
AI.Option.Air.val.FLARE_USING.WHEN_FLYING_NEAR_ENEMIES + +
+ +

Type AI.Option.Air.val.RADAR_USING

+ + + + + + + + + + + + + + + + + +
AI.Option.Air.val.RADAR_USING.FOR_ATTACK_ONLY + +
AI.Option.Air.val.RADAR_USING.FOR_CONTINUOUS_SEARCH + +
AI.Option.Air.val.RADAR_USING.FOR_SEARCH_IF_REQUIRED + +
AI.Option.Air.val.RADAR_USING.NEVER + +
+ +

Type AI.Option.Air.val.REACTION_ON_THREAT

+ + + + + + + + + + + + + + + + + + + + + +
AI.Option.Air.val.REACTION_ON_THREAT.ALLOW_ABORT_MISSION + +
AI.Option.Air.val.REACTION_ON_THREAT.BYPASS_AND_ESCAPE + +
AI.Option.Air.val.REACTION_ON_THREAT.EVADE_FIRE + +
AI.Option.Air.val.REACTION_ON_THREAT.NO_REACTION + +
AI.Option.Air.val.REACTION_ON_THREAT.PASSIVE_DEFENCE + +
+ +

Type AI.Option.Air.val.ROE

+ + + + + + + + + + + + + + + + + + + + + +
AI.Option.Air.val.ROE.OPEN_FIRE + +
AI.Option.Air.val.ROE.OPEN_FIRE_WEAPON_FREE + +
AI.Option.Air.val.ROE.RETURN_FIRE + +
AI.Option.Air.val.ROE.WEAPON_FREE + +
AI.Option.Air.val.ROE.WEAPON_HOLD + +
+ +

Type AI.Option.Ground

+ + + + + + + + + +
AI.Option.Ground.id + +
AI.Option.Ground.val + +
+ +

Type AI.Option.Ground.id

+ + + + + + + + + + + + + + + + + +
AI.Option.Ground.id.ALARM_STATE +

AI.Option.Ground.val.ALARM_STATE

+
AI.Option.Ground.id.DISPERSE_ON_ATTACK +

true or false

+
AI.Option.Ground.id.NO_OPTION + +
AI.Option.Ground.id.ROE +

AI.Option.Ground.val.ROE

+
+ +

Type AI.Option.Ground.val

+ + + + + + + + + +
AI.Option.Ground.val.ALARM_STATE + +
AI.Option.Ground.val.ROE + +
+ +

Type AI.Option.Ground.val.ALARM_STATE

+ + + + + + + + + + + + + +
AI.Option.Ground.val.ALARM_STATE.AUTO + +
AI.Option.Ground.val.ALARM_STATE.GREEN + +
AI.Option.Ground.val.ALARM_STATE.RED + +
+ +

Type AI.Option.Ground.val.ROE

+ + + + + + + + + + + + + +
AI.Option.Ground.val.ROE.OPEN_FIRE + +
AI.Option.Ground.val.ROE.RETURN_FIRE + +
AI.Option.Ground.val.ROE.WEAPON_HOLD + +
+ +

Type AI.Option.Naval

+ + + + + + + + + +
AI.Option.Naval.id + +
AI.Option.Naval.val + +
+ +

Type AI.Option.Naval.id

+ + + + + + + + + +
AI.Option.Naval.id.NO_OPTION + +
AI.Option.Naval.id.ROE + +
+ +

Type AI.Option.Naval.val

+ + + + + +
AI.Option.Naval.val.ROE + +
+ +

Type AI.Option.Naval.val.ROE

+ + + + + + + + + + + + + +
AI.Option.Naval.val.ROE.OPEN_FIRE + +
AI.Option.Naval.val.ROE.RETURN_FIRE + +
AI.Option.Naval.val.ROE.WEAPON_HOLD + +
+ +

Type AI.Skill

+ + + + + + + + + + + + + + + + + + + + + + + + + +
AI.Skill.AVERAGE + +
AI.Skill.CLIENT + +
AI.Skill.EXCELLENT + +
AI.Skill.GOOD + +
AI.Skill.HIGH + +
AI.Skill.PLAYER + +
+ +

Type AI.Task

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AI.Task.AltitudeType + +
AI.Task.Designation + +
AI.Task.OrbitPattern + +
AI.Task.TurnMethod + +
AI.Task.VehicleFormation + +
AI.Task.WaypointType + +
AI.Task.WeaponExpend + +
+ +

Type AI.Task.AltitudeType

+ + + + + + + + + +
AI.Task.AltitudeType.BARO + +
AI.Task.AltitudeType.RADIO + +
+ +

Type AI.Task.Designation

+ + + + + + + + + + + + + + + + + + + + + +
AI.Task.Designation.AUTO + +
AI.Task.Designation.IR_POINTER + +
AI.Task.Designation.LASER + +
AI.Task.Designation.NO + +
AI.Task.Designation.WP + +
+ +

Type AI.Task.OrbitPattern

+ + + + + + + + + +
AI.Task.OrbitPattern.CIRCLE + +
AI.Task.OrbitPattern.RACE_TRACK + +
+ +

Type AI.Task.TurnMethod

+ + + + + + + + + +
AI.Task.TurnMethod.FIN_POINT + +
AI.Task.TurnMethod.FLY_OVER_POINT + +
+ +

Type AI.Task.VehicleFormation

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AI.Task.VehicleFormation.CONE + +
AI.Task.VehicleFormation.DIAMOND + +
AI.Task.VehicleFormation.ECHELON_LEFT + +
AI.Task.VehicleFormation.ECHELON_RIGHT + +
AI.Task.VehicleFormation.OFF_ROAD + +
AI.Task.VehicleFormation.ON_ROAD + +
AI.Task.VehicleFormation.RANK + +
AI.Task.VehicleFormation.VEE + +
+ +

Type AI.Task.WaypointType

+ + + + + + + + + + + + + + + + + +
AI.Task.WaypointType.LAND + +
AI.Task.WaypointType.TAKEOFF + +
AI.Task.WaypointType.TAKEOFF_PARKING + +
AI.Task.WaypointType.TURNING_POINT + +
+ +

Type AI.Task.WeaponExpend

+ + + + + + + + + + + + + + + + + + + + + + + + + +
AI.Task.WeaponExpend.ALL + +
AI.Task.WeaponExpend.FOUR + +
AI.Task.WeaponExpend.HALF + +
AI.Task.WeaponExpend.ONE + +
AI.Task.WeaponExpend.QUARTER + +
AI.Task.WeaponExpend.TWO + +
+ +

Type Box3

+ + + + + + + + + +
Box3.max + +
Box3.min + +
+ +

Type Desc

+ + + + + + + + + + + + + +
Desc.attributes +

object type attributes

+
Desc.displayName +

localized display name

+
Desc.typeName +

type name

+
+ +

Type Position3

+ + + + + + + + + + + + + + + + + +
Position3.p + +
Position3.x + +
Position3.y + +
Position3.z + +
+ +

Type Vec2

+ + + + + + + + + +
Vec2.x +

Vec2.x = Vec3.x

+
Vec2.y +

Vec2.y = Vec3.z

+
+ +

Type Vec3

+ + + + + + + + + + + + + +
Vec3.x +

is directed to the north

+
Vec3.y +

is directed up

+
Vec3.z +

is directed to the east

+
+ +

Global(s)

+
+
+ + #AI + +AI + +
+
+ + + +
+
+

Type DCSTypes

+ +

Type AI

+

Field(s)

+
+
+ + #AI.Option + +AI.Option + +
+
+ + + +
+
+
+
+ + #AI.Skill + +AI.Skill + +
+
+ + + +
+
+
+
+ + #AI.Task + +AI.Task + +
+
+ + + +
+
+ +

Type AI.Option

+

Field(s)

+
+
+ + #AI.Option.Air + +AI.Option.Air + +
+
+ + + +
+
+
+
+ + #AI.Option.Ground + +AI.Option.Ground + +
+
+ + + +
+
+
+
+ + #AI.Option.Naval + +AI.Option.Naval + +
+
+ + + +
+
+ +

Type AI.Option.Air

+

Field(s)

+
+
+ + #AI.Option.Air.id + +AI.Option.Air.id + +
+
+ + + +
+
+
+
+ + #AI.Option.Air.val + +AI.Option.Air.val + +
+
+ + + +
+
+ +

Type AI.Option.Air.id

+ +

Type AI.Option.Air.val

+

Field(s)

+
+
+ + #AI.Option.Air.val.FLARE_USING + +AI.Option.Air.val.FLARE_USING + +
+
+ + + +
+
+
+
+ + #AI.Option.Air.val.RADAR_USING + +AI.Option.Air.val.RADAR_USING + +
+
+ + + +
+
+
+
+ + #AI.Option.Air.val.REACTION_ON_THREAT + +AI.Option.Air.val.REACTION_ON_THREAT + +
+
+ + + +
+
+
+
+ + #AI.Option.Air.val.ROE + +AI.Option.Air.val.ROE + +
+
+ + + +
+
+ +

Type AI.Option.Air.val.FLARE_USING

+

Field(s)

+
+
+ + +AI.Option.Air.val.FLARE_USING.AGAINST_FIRED_MISSILE + +
+
+ + + +
+
+
+
+ + +AI.Option.Air.val.FLARE_USING.NEVER + +
+
+ + + +
+
+
+
+ + +AI.Option.Air.val.FLARE_USING.WHEN_FLYING_IN_SAM_WEZ + +
+
+ + + +
+
+
+
+ + +AI.Option.Air.val.FLARE_USING.WHEN_FLYING_NEAR_ENEMIES + +
+
+ + + +
+
+ +

Type AI.Option.Air.val.RADAR_USING

+

Field(s)

+
+
+ + +AI.Option.Air.val.RADAR_USING.FOR_ATTACK_ONLY + +
+
+ + + +
+
+
+
+ + +AI.Option.Air.val.RADAR_USING.FOR_CONTINUOUS_SEARCH + +
+
+ + + +
+
+
+
+ + +AI.Option.Air.val.RADAR_USING.FOR_SEARCH_IF_REQUIRED + +
+
+ + + +
+
+
+
+ + +AI.Option.Air.val.RADAR_USING.NEVER + +
+
+ + + +
+
+ +

Type AI.Option.Air.val.REACTION_ON_THREAT

+

Field(s)

+
+
+ + +AI.Option.Air.val.REACTION_ON_THREAT.ALLOW_ABORT_MISSION + +
+
+ + + +
+
+
+
+ + +AI.Option.Air.val.REACTION_ON_THREAT.BYPASS_AND_ESCAPE + +
+
+ + + +
+
+
+
+ + +AI.Option.Air.val.REACTION_ON_THREAT.EVADE_FIRE + +
+
+ + + +
+
+
+
+ + +AI.Option.Air.val.REACTION_ON_THREAT.NO_REACTION + +
+
+ + + +
+
+
+
+ + +AI.Option.Air.val.REACTION_ON_THREAT.PASSIVE_DEFENCE + +
+
+ + + +
+
+ +

Type AI.Option.Air.val.ROE

+

Field(s)

+
+
+ + +AI.Option.Air.val.ROE.OPEN_FIRE + +
+
+ + + +
+
+
+
+ + +AI.Option.Air.val.ROE.OPEN_FIRE_WEAPON_FREE + +
+
+ + + +
+
+
+
+ + +AI.Option.Air.val.ROE.RETURN_FIRE + +
+
+ + + +
+
+
+
+ + +AI.Option.Air.val.ROE.WEAPON_FREE + +
+
+ + + +
+
+
+
+ + +AI.Option.Air.val.ROE.WEAPON_HOLD + +
+
+ + + +
+
+ +

Type AI.Option.Ground

+

Field(s)

+
+
+ + #AI.Option.Ground.id + +AI.Option.Ground.id + +
+
+ + + +
+
+
+
+ + #AI.Option.Ground.val + +AI.Option.Ground.val + +
+
+ + + +
+
+ +

Type AI.Option.Ground.id

+

Field(s)

+
+
+ + +AI.Option.Ground.id.ALARM_STATE + +
+
+ +

AI.Option.Ground.val.ALARM_STATE

+ +
+
+
+
+ + +AI.Option.Ground.id.DISPERSE_ON_ATTACK + +
+
+ +

true or false

+ +
+
+
+
+ + +AI.Option.Ground.id.NO_OPTION + +
+
+ + + +
+
+
+
+ + +AI.Option.Ground.id.ROE + +
+
+ +

AI.Option.Ground.val.ROE

+ +
+
+ +

Type AI.Option.Ground.val

+

Field(s)

+
+
+ + #AI.Option.Ground.val.ALARM_STATE + +AI.Option.Ground.val.ALARM_STATE + +
+
+ + + +
+
+
+
+ + #AI.Option.Ground.val.ROE + +AI.Option.Ground.val.ROE + +
+
+ + + +
+
+ +

Type AI.Option.Ground.val.ALARM_STATE

+

Field(s)

+
+
+ + +AI.Option.Ground.val.ALARM_STATE.AUTO + +
+
+ + + +
+
+
+
+ + +AI.Option.Ground.val.ALARM_STATE.GREEN + +
+
+ + + +
+
+
+
+ + +AI.Option.Ground.val.ALARM_STATE.RED + +
+
+ + + +
+
+ +

Type AI.Option.Ground.val.ROE

+

Field(s)

+
+
+ + +AI.Option.Ground.val.ROE.OPEN_FIRE + +
+
+ + + +
+
+
+
+ + +AI.Option.Ground.val.ROE.RETURN_FIRE + +
+
+ + + +
+
+
+
+ + +AI.Option.Ground.val.ROE.WEAPON_HOLD + +
+
+ + + +
+
+ +

Type AI.Option.Naval

+

Field(s)

+
+
+ + #AI.Option.Naval.id + +AI.Option.Naval.id + +
+
+ + + +
+
+
+
+ + #AI.Option.Naval.val + +AI.Option.Naval.val + +
+
+ + + +
+
+ +

Type AI.Option.Naval.id

+

Field(s)

+
+
+ + +AI.Option.Naval.id.NO_OPTION + +
+
+ + + +
+
+
+
+ + +AI.Option.Naval.id.ROE + +
+
+ + + +
+
+ +

Type AI.Option.Naval.val

+

Field(s)

+
+
+ + #AI.Option.Naval.val.ROE + +AI.Option.Naval.val.ROE + +
+
+ + + +
+
+ +

Type AI.Option.Naval.val.ROE

+

Field(s)

+
+
+ + +AI.Option.Naval.val.ROE.OPEN_FIRE + +
+
+ + + +
+
+
+
+ + +AI.Option.Naval.val.ROE.RETURN_FIRE + +
+
+ + + +
+
+
+
+ + +AI.Option.Naval.val.ROE.WEAPON_HOLD + +
+
+ + + +
+
+ +

Type AI.Skill

+

Field(s)

+
+
+ + +AI.Skill.AVERAGE + +
+
+ + + +
+
+
+
+ + +AI.Skill.CLIENT + +
+
+ + + +
+
+
+
+ + +AI.Skill.EXCELLENT + +
+
+ + + +
+
+
+
+ + +AI.Skill.GOOD + +
+
+ + + +
+
+
+
+ + +AI.Skill.HIGH + +
+
+ + + +
+
+
+
+ + +AI.Skill.PLAYER + +
+
+ + + +
+
+ +

Type AI.Task

+

Field(s)

+
+
+ + #AI.Task.AltitudeType + +AI.Task.AltitudeType + +
+
+ + + +
+
+
+
+ + #AI.Task.Designation + +AI.Task.Designation + +
+
+ + + +
+
+
+
+ + #AI.Task.OrbitPattern + +AI.Task.OrbitPattern + +
+
+ + + +
+
+
+
+ + #AI.Task.TurnMethod + +AI.Task.TurnMethod + +
+
+ + + +
+
+
+
+ + #AI.Task.VehicleFormation + +AI.Task.VehicleFormation + +
+
+ + + +
+
+
+
+ + #AI.Task.WaypointType + +AI.Task.WaypointType + +
+
+ + + +
+
+
+
+ + #AI.Task.WeaponExpend + +AI.Task.WeaponExpend + +
+
+ + + +
+
+ +

Type AI.Task.AltitudeType

+

Field(s)

+
+
+ + +AI.Task.AltitudeType.BARO + +
+
+ + + +
+
+
+
+ + +AI.Task.AltitudeType.RADIO + +
+
+ + + +
+
+ +

Type AI.Task.Designation

+

Field(s)

+
+
+ + +AI.Task.Designation.AUTO + +
+
+ + + +
+
+
+
+ + +AI.Task.Designation.IR_POINTER + +
+
+ + + +
+
+
+
+ + +AI.Task.Designation.LASER + +
+
+ + + +
+
+
+
+ + +AI.Task.Designation.NO + +
+
+ + + +
+
+
+
+ + +AI.Task.Designation.WP + +
+
+ + + +
+
+ +

Type AI.Task.OrbitPattern

+

Field(s)

+
+
+ + +AI.Task.OrbitPattern.CIRCLE + +
+
+ + + +
+
+
+
+ + +AI.Task.OrbitPattern.RACE_TRACK + +
+
+ + + +
+
+ +

Type AI.Task.TurnMethod

+

Field(s)

+
+
+ + +AI.Task.TurnMethod.FIN_POINT + +
+
+ + + +
+
+
+
+ + +AI.Task.TurnMethod.FLY_OVER_POINT + +
+
+ + + +
+
+ +

Type AI.Task.VehicleFormation

+

Field(s)

+
+
+ + +AI.Task.VehicleFormation.CONE + +
+
+ + + +
+
+
+
+ + +AI.Task.VehicleFormation.DIAMOND + +
+
+ + + +
+
+
+
+ + +AI.Task.VehicleFormation.ECHELON_LEFT + +
+
+ + + +
+
+
+
+ + +AI.Task.VehicleFormation.ECHELON_RIGHT + +
+
+ + + +
+
+
+
+ + +AI.Task.VehicleFormation.OFF_ROAD + +
+
+ + + +
+
+
+
+ + +AI.Task.VehicleFormation.ON_ROAD + +
+
+ + + +
+
+
+
+ + +AI.Task.VehicleFormation.RANK + +
+
+ + + +
+
+
+
+ + +AI.Task.VehicleFormation.VEE + +
+
+ + + +
+
+ +

Type AI.Task.WaypointType

+

Field(s)

+
+
+ + +AI.Task.WaypointType.LAND + +
+
+ + + +
+
+
+
+ + +AI.Task.WaypointType.TAKEOFF + +
+
+ + + +
+
+
+
+ + +AI.Task.WaypointType.TAKEOFF_PARKING + +
+
+ + + +
+
+
+
+ + +AI.Task.WaypointType.TURNING_POINT + +
+
+ + + +
+
+ +

Type AI.Task.WeaponExpend

+

Field(s)

+
+
+ + +AI.Task.WeaponExpend.ALL + +
+
+ + + +
+
+
+
+ + +AI.Task.WeaponExpend.FOUR + +
+
+ + + +
+
+
+
+ + +AI.Task.WeaponExpend.HALF + +
+
+ + + +
+
+
+
+ + +AI.Task.WeaponExpend.ONE + +
+
+ + + +
+
+
+
+ + +AI.Task.WeaponExpend.QUARTER + +
+
+ + + +
+
+
+
+ + +AI.Task.WeaponExpend.TWO + +
+
+ + + +
+
+ +

Type Angle

+ +

An angle type

+ + +

Type Azimuth

+ +

Azimuth is an angle of rotation around world axis y counter-clockwise.

+ + +

Type Box3

+ +

3-dimensional box.

+ +

Field(s)

+
+
+ + #Vec3 + +Box3.max + +
+
+ + + +
+
+
+
+ + #Vec3 + +Box3.min + +
+
+ + + +
+
+ +

Type Desc

+

Field(s)

+
+
+ + #table + +Desc.attributes + +
+
+ +

object type attributes

+ +
+
+
+
+ + #string + +Desc.displayName + +
+
+ +

localized display name

+ +
+
+
+
+ + #TypeName + +Desc.typeName + +
+
+ +

type name

+ +
+
+ +

Type Distance

+ +

A distance type

+ + +

Type Mass

+ +

Mass is given in kilograms.

+ + +

Type MissionTime

+ +

Mission time is a model time plus time of the mission start.

+ + +

Type ModelTime

+ +

Model time is the time that drives the simulation.

+ + +

Model time may be stopped, accelerated and decelerated relative real time.

+ + +

Type Position3

+ +

Position is a composite structure.

+ + +

It consists of both coordinate vector and orientation matrix. Position3 (also known as "Pos3" for short) is a table that has following format:

+ +

Field(s)

+
+
+ + #Vec3 + +Position3.p + +
+
+ + + +
+
+
+
+ + #Vec3 + +Position3.x + +
+
+ + + +
+
+
+
+ + #Vec3 + +Position3.y + +
+
+ + + +
+
+
+
+ + #Vec3 + +Position3.z + +
+
+ + + +
+
+ +

Type Time

+ +

Time is given in seconds.

+ + +

Type TypeName

+ +

Each object belongs to a type.

+ + +

Object type is a named couple of properties those independent of mission and common for all units of the same type. Name of unit type is a string. Samples of unit type: "Su-27", "KAMAZ" and "M2 Bradley".

+ + +

Type Vec2

+ +

Vec2 is a 2D-vector for the ground plane as a reference plane.

+ +

Field(s)

+
+
+ + #Distance + +Vec2.x + +
+
+ +

Vec2.x = Vec3.x

+ +
+
+
+
+ + #Distance + +Vec2.y + +
+
+ +

Vec2.y = Vec3.z

+ +
+
+ +

Type Vec3

+ +

Vec3 type is a 3D-vector.

+ + +

DCS world has 3-dimensional coordinate system. DCS ground is an infinite plain.

+ +

Field(s)

+
+
+ + #Distance + +Vec3.x + +
+
+ +

is directed to the north

+ +
+
+
+
+ + #Distance + +Vec3.y + +
+
+ +

is directed up

+ +
+
+
+
+ + #Distance + +Vec3.z + +
+
+ +

is directed to the east

+ +
+
+ +
+ +
+ + diff --git a/Documentation/DCSUnit.html b/Documentation/DCSUnit.html new file mode 100644 index 000000000..23892817e --- /dev/null +++ b/Documentation/DCSUnit.html @@ -0,0 +1,2040 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DCSUnit

+ + + +

Global(s)

+ + + + + +
Unit + +
+

Type Unit

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Unit.< +

Unit.AmmoItem> Ammo

+
Unit.AmmoItem + +
Unit.Category + +
Unit.Desc + +
Unit.DescAircraft + +
Unit.DescAirplane + +
Unit.DescHelicopter + +
Unit.DescShip + +
Unit.DescVehicle + +
Unit.ID +

Identifier of an unit. It assigned to an unit by the Mission Editor automatically.

+
Unit.IRST + +
Unit.Optic + +
Unit.OpticType + +
Unit.Radar + +
Unit.RadarType + +
Unit.RefuelingSystem + +
Unit.Sensor + +
Unit.SensorType + +
Unit.detectionDistanceAfterburner +

..., engines are in afterburner mode

+
Unit.detectionDistanceIdle +

detection of tail-on target with heat signature = 1 in upper hemisphere, engines are in idle

+
Unit.detectionDistanceMaximal +

..., engines are in maximal mode

+
Unit:getAmmo() +

Returns the unit ammunition.

+
Unit.getByName(name) +

Returns unit object by the name assigned to the unit in Mission Editor.

+
Unit:getCallsign() +

Returns the unit's callsign - the localized string.

+
Unit:getController() +

Returns controller of the unit if it exist and nil otherwise

+
Unit:getDesc() +

Returns unit descriptor.

+
Unit:getFuel() +

Returns relative amount of fuel (from 0.0 to 1.0) the unit has in its internal tanks.

+
Unit:getGroup() +

Returns the unit's group if it exist and nil otherwise

+
Unit:getID() +

returns the unit's unique identifier.

+
Unit:getLife() +

Returns the unit's health.

+
Unit:getLife0() +

returns the unit's initial health.

+
Unit:getNumber() +

Returns the unit's number in the group.

+
Unit:getPlayerName() +

Returns name of the player that control the unit or nil if the unit is controlled by A.I.

+
Unit:getRadar() +

returns two values: +First value indicates if at least one of the unit's radar(s) is on.

+
Unit:getSensors() +

Returns the unit sensors.

+
Unit:hasSensors(sensorType, ...) +

Returns true if the unit has specified types of sensors.

+
Unit:isActive() +

Returns if the unit is activated.

+
+ +

Type Unit.AmmoItem

+ + + + + + + + + +
Unit.AmmoItem.count +

ammunition count

+
Unit.AmmoItem.desc +

ammunition descriptor

+
+ +

Type Unit.Category

+ + + + + + + + + + + + + + + + + + + + + +
Unit.Category.AIRPLANE + +
Unit.Category.GROUND_UNIT + +
Unit.Category.HELICOPTER + +
Unit.Category.SHIP + +
Unit.Category.STRUCTURE + +
+ +

Type Unit.Desc

+ + + + + + + + + + + + + +
Unit.Desc.category +

Unit Category

+
Unit.Desc.massEmpty +

mass of empty unit

+
Unit.Desc.speedMax +

istance / Time, --maximal velocity

+
+ +

Type Unit.DescAircraft

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Unit.DescAircraft.Hmax +

Ceiling

+
Unit.DescAircraft.NyMax +

maximal safe acceleration

+
Unit.DescAircraft.NyMin +

minimal safe acceleration

+
Unit.DescAircraft.VyMax +

#Distance / #Time, --maximal climb rate

+
Unit.DescAircraft.fuelMassMax +

maximal inner fuel mass

+
Unit.DescAircraft.range +

Operational range

+
Unit.DescAircraft.tankerType +

refueling system type

+
+ +

Type Unit.DescAirplane

+ + + + + + + + + +
Unit.DescAirplane.speedMax0 +

Distance / Time maximal TAS at ground level

+
Unit.DescAirplane.speedMax10K +

Distance / Time maximal TAS at altitude of 10 km

+
+ +

Type Unit.DescHelicopter

+ + + + + +
Unit.DescHelicopter.HmaxStat +

static ceiling

+
+ +

Type Unit.DescVehicle

+ + + + + + + + + +
Unit.DescVehicle.maxSlopeAngle +

maximal slope angle

+
Unit.DescVehicle.riverCrossing +

can the vehicle cross a rivers

+
+ +

Type Unit.Optic

+ + + + + +
Unit.Optic.opticType + +
+ +

Type Unit.OpticType

+ + + + + + + + + + + + + +
Unit.OpticType.IR +

Infra-Red optic sensor

+
Unit.OpticType.LLTV +

Low-level TV-sensor

+
Unit.OpticType.TV +

TV-sensor

+
+ +

Type Unit.Radar

+ + + + + + + + + + + + + +
Unit.Radar.detectionDistanceAir +

detection distance for RCS=1m^2 airborne target, nil if radar doesn't support air search

+
Unit.Radar.detectionDistanceHRM +

detection distance for RCS=1m^2 in high-resolution mapping mode, nil if radar has no HRM

+
Unit.Radar.detectionDistanceRBM +

detection distance for RCS=1m^2 in real-beam mapping mode, nil if radar doesn't support surface/land search

+
+ +

Type Unit.Radar.detectionDistanceAir

+ + + + + + + + + +
Unit.Radar.detectionDistanceAir.lowerHemisphere + +
Unit.Radar.detectionDistanceAir.upperHemisphere + +
+ +

Type Unit.Radar.detectionDistanceAir.lowerHemisphere

+ + + + + + + + + +
Unit.Radar.detectionDistanceAir.lowerHemisphere.headOn + +
Unit.Radar.detectionDistanceAir.lowerHemisphere.tailOn + +
+ +

Type Unit.Radar.detectionDistanceAir.upperHemisphere

+ + + + + + + + + +
Unit.Radar.detectionDistanceAir.upperHemisphere.headOn + +
Unit.Radar.detectionDistanceAir.upperHemisphere.tailOn + +
+ +

Type Unit.RadarType

+ + + + + + + + + +
Unit.RadarType.AS +

air search radar

+
Unit.RadarType.SS +

surface/land search radar

+
+ +

Type Unit.RefuelingSystem

+ + + + + + + + + +
Unit.RefuelingSystem.BOOM_AND_RECEPTACLE + +
Unit.RefuelingSystem.PROBE_AND_DROGUE + +
+ +

Type Unit.Sensor

+ + + + + + + + + +
Unit.Sensor.type + +
Unit.Sensor.typeName + +
+ +

Type Unit.SensorType

+ + + + + + + + + + + + + + + + + +
Unit.SensorType.IRST + +
Unit.SensorType.OPTIC + +
Unit.SensorType.RADAR + +
Unit.SensorType.RWR + +
+ +

Global(s)

+
+
+ + #Unit + +Unit + +
+
+ + + +
+
+

Type DCSUnit

+ +

Type Angle

+ +

Type Controller

+ +

Type Distance

+ +

Type Mass

+ +

Type TypeName

+ +

Type Unit

+ +

An IRST.

+ +

Field(s)

+
+
+ + #list + +Unit.< + +
+
+ +

Unit.AmmoItem> Ammo

+ +
+
+
+
+ + #Unit.AmmoItem + +Unit.AmmoItem + +
+
+ + + +
+
+
+
+ + #Unit.Category + +Unit.Category + +
+
+ + + +
+
+
+
+ + #Unit.Desc + +Unit.Desc + +
+
+ + + +
+
+
+
+ + #Unit.DescAircraft + +Unit.DescAircraft + +
+
+ + + +
+
+
+
+ + #Unit.DescAirplane + +Unit.DescAirplane + +
+
+ + + +
+
+
+
+ + #Unit.DescHelicopter + +Unit.DescHelicopter + +
+
+ + + +
+
+
+
+ + #Unit.DescShip + +Unit.DescShip + +
+
+ + + +
+
+
+
+ + #Unit.DescVehicle + +Unit.DescVehicle + +
+
+ + + +
+
+
+
+ + +Unit.ID + +
+
+ +

Identifier of an unit. It assigned to an unit by the Mission Editor automatically.

+ +
+
+
+
+ + #Unit.IRST + +Unit.IRST + +
+
+ + + +
+
+
+
+ + #Unit.Optic + +Unit.Optic + +
+
+ + + +
+
+
+
+ + #Unit.OpticType + +Unit.OpticType + +
+
+ + + +
+
+
+
+ + #Unit.Radar + +Unit.Radar + +
+
+ + + +
+
+
+
+ + #Unit.RadarType + +Unit.RadarType + +
+
+ + + +
+
+
+
+ + #Unit.RefuelingSystem + +Unit.RefuelingSystem + +
+
+ + + +
+
+
+
+ + #Unit.Sensor + +Unit.Sensor + +
+
+ + + +
+
+
+
+ + #Unit.SensorType + +Unit.SensorType + +
+
+ + + +
+
+
+
+ + #Distance + +Unit.detectionDistanceAfterburner + +
+
+ +

..., engines are in afterburner mode

+ +
+
+
+
+ + #Distance + +Unit.detectionDistanceIdle + +
+
+ +

detection of tail-on target with heat signature = 1 in upper hemisphere, engines are in idle

+ +
+
+
+
+ + #Distance + +Unit.detectionDistanceMaximal + +
+
+ +

..., engines are in maximal mode

+ +
+
+
+
+ + +Unit:getAmmo() + +
+
+ +

Returns the unit ammunition.

+ +

Return value

+ +

#Unit.Ammo:

+ + +
+
+
+
+ + +Unit.getByName(name) + +
+
+ +

Returns unit object by the name assigned to the unit in Mission Editor.

+ + +

If there is unit with such name or the unit is destroyed the function will return nil. The function provides access to non-activated units too.

+ +

Parameter

+
    +
  • + +

    #string name :

    + +
    • +
+

Return value

+ +

#Unit:

+ + +
+
+
+
+ + +Unit:getCallsign() + +
+
+ +

Returns the unit's callsign - the localized string.

+ +

Return value

+ +

#string:

+ + +
+
+
+
+ + +Unit:getController() + +
+
+ +

Returns controller of the unit if it exist and nil otherwise

+ +

Return value

+ +

#Controller:

+ + +
+
+
+
+ + +Unit:getDesc() + +
+
+ +

Returns unit descriptor.

+ + +

Descriptor type depends on unit category.

+ +

Return value

+ +

#Unit.Desc:

+ + +
+
+
+
+ + +Unit:getFuel() + +
+
+ +

Returns relative amount of fuel (from 0.0 to 1.0) the unit has in its internal tanks.

+ + +

If there are additional fuel tanks the value may be greater than 1.0.

+ +

Return value

+ +

#number:

+ + +
+
+
+
+ + +Unit:getGroup() + +
+
+ +

Returns the unit's group if it exist and nil otherwise

+ +

Return value

+ +

DCSGroup#Group:

+ + +
+
+
+
+ + +Unit:getID() + +
+
+ +

returns the unit's unique identifier.

+ +

Return value

+ +

#Unit.ID:

+ + +
+
+
+
+ + +Unit:getLife() + +
+
+ +

Returns the unit's health.

+ + +

Dead units has health <= 1.0

+ +

Return value

+ +

#number:

+ + +
+
+
+
+ + +Unit:getLife0() + +
+
+ +

returns the unit's initial health.

+ +

Return value

+ +

#number:

+ + +
+
+
+
+ + +Unit:getNumber() + +
+
+ +

Returns the unit's number in the group.

+ + +

The number is the same number the unit has in ME. It may not be changed during the mission. If any unit in the group is destroyed, the numbers of another units will not be changed.

+ +

Return value

+ +

#number:

+ + +
+
+
+
+ + +Unit:getPlayerName() + +
+
+ +

Returns name of the player that control the unit or nil if the unit is controlled by A.I.

+ +

Return value

+ +

#string:

+ + +
+
+
+
+ + +Unit:getRadar() + +
+
+ +

returns two values: +First value indicates if at least one of the unit's radar(s) is on.

+ + +

Second value is the object of the radar's interest. Not nil only if at least one radar of the unit is tracking a target.

+ +

Return value

+ +

#boolean, Object#Object:

+ + +
+
+
+
+ + +Unit:getSensors() + +
+
+ +

Returns the unit sensors.

+ +

Return value

+ +

#Unit.Sensors:

+ + +
+
+
+
+ + +Unit:hasSensors(sensorType, ...) + +
+
+ +

Returns true if the unit has specified types of sensors.

+ + +

This function is more preferable than Unit.getSensors() if you don't want to get information about all the unit's sensors, and just want to check if the unit has specified types of sensors.

+ +

Parameters

+
    +
  • + +

    #Unit.SensorType sensorType : +(= nil) Sensor type.

    + +
    • +
  • + +

    ... : +Additional parameters.

    + +
    • +
+

Return value

+ +

#boolean:

+ + +

Usage:

+ 
If sensorType is Unit.SensorType.OPTIC, additional parameters are optic sensor types. Following example checks if the unit has LLTV or IR optics:
+unit:hasSensors(Unit.SensorType.OPTIC, Unit.OpticType.LLTV, Unit.OpticType.IR)
+If sensorType is Unit.SensorType.RADAR, additional parameters are radar types. Following example checks if the unit has air search radars:
+unit:hasSensors(Unit.SensorType.RADAR, Unit.RadarType.AS)
+If no additional parameters are specified the function returns true if the unit has at least one sensor of specified type.
+If sensor type is not specified the function returns true if the unit has at least one sensor of any type.
+
+ +
+
+
+
+ + +Unit:isActive() + +
+
+ +

Returns if the unit is activated.

+ +

Return value

+ +

#boolean:

+ + +
+
+ +

Type Unit.Ammo

+ +

Type Unit.AmmoItem

+ +

ammunition item: "type-count" pair.

+ +

Field(s)

+
+
+ + #number + +Unit.AmmoItem.count + +
+
+ +

ammunition count

+ +
+
+
+
+ + #Weapon.Desc + +Unit.AmmoItem.desc + +
+
+ +

ammunition descriptor

+ +
+
+ +

Type Unit.Category

+ +

Enum that stores unit categories.

+ +

Field(s)

+
+
+ + +Unit.Category.AIRPLANE + +
+
+ + + +
+
+
+
+ + +Unit.Category.GROUND_UNIT + +
+
+ + + +
+
+
+
+ + +Unit.Category.HELICOPTER + +
+
+ + + +
+
+
+
+ + +Unit.Category.SHIP + +
+
+ + + +
+
+
+
+ + +Unit.Category.STRUCTURE + +
+
+ + + +
+
+ +

Type Unit.Desc

+ +

A unit descriptor.

+ +

Field(s)

+
+
+ + #Unit.Category + +Unit.Desc.category + +
+
+ +

Unit Category

+ +
+
+
+
+ + #Mass + +Unit.Desc.massEmpty + +
+
+ +

mass of empty unit

+ +
+
+
+
+ + #number + +Unit.Desc.speedMax + +
+
+ +

istance / Time, --maximal velocity

+ +
+
+ +

Type Unit.DescAircraft

+ +

An aircraft descriptor.

+ +

Field(s)

+
+
+ + #Distance + +Unit.DescAircraft.Hmax + +
+
+ +

Ceiling

+ +
+
+
+
+ + #number + +Unit.DescAircraft.NyMax + +
+
+ +

maximal safe acceleration

+ +
+
+
+
+ + #number + +Unit.DescAircraft.NyMin + +
+
+ +

minimal safe acceleration

+ +
+
+
+
+ + #number + +Unit.DescAircraft.VyMax + +
+
+ +

#Distance / #Time, --maximal climb rate

+ +
+
+
+
+ + #Mass + +Unit.DescAircraft.fuelMassMax + +
+
+ +

maximal inner fuel mass

+ +
+
+
+
+ + #Distance + +Unit.DescAircraft.range + +
+
+ +

Operational range

+ +
+
+
+
+ + #Unit.RefuelingSystem + +Unit.DescAircraft.tankerType + +
+
+ +

refueling system type

+ +
+
+ +

Type Unit.DescAirplane

+ +

An airplane descriptor.

+ +

Field(s)

+
+
+ + #number + +Unit.DescAirplane.speedMax0 + +
+
+ +

Distance / Time maximal TAS at ground level

+ +
+
+
+
+ + #number + +Unit.DescAirplane.speedMax10K + +
+
+ +

Distance / Time maximal TAS at altitude of 10 km

+ +
+
+ +

Type Unit.DescHelicopter

+ +

A helicopter descriptor.

+ +

Field(s)

+
+
+ + #Distance + +Unit.DescHelicopter.HmaxStat + +
+
+ +

static ceiling

+ +
+
+ +

Type Unit.DescShip

+ +

A ship descriptor.

+ + +

Type Unit.DescVehicle

+ +

A vehicle descriptor.

+ +

Field(s)

+
+
+ + #Angle + +Unit.DescVehicle.maxSlopeAngle + +
+
+ +

maximal slope angle

+ +
+
+
+
+ + #boolean + +Unit.DescVehicle.riverCrossing + +
+
+ +

can the vehicle cross a rivers

+ +
+
+ +

Type Unit.ID

+ +

Type Unit.IRST

+ +

Type Unit.Optic

+ +

An optic sensor.

+ +

Field(s)

+
+
+ + #Unit.OpticType + +Unit.Optic.opticType + +
+
+ + + +
+
+ +

Type Unit.OpticType

+ +

Enum that stores types of optic sensors.

+ +

Field(s)

+
+
+ + +Unit.OpticType.IR + +
+
+ +

Infra-Red optic sensor

+ +
+
+
+
+ + +Unit.OpticType.LLTV + +
+
+ +

Low-level TV-sensor

+ +
+
+
+
+ + +Unit.OpticType.TV + +
+
+ +

TV-sensor

+ +
+
+ +

Type Unit.RWR

+ +

An RWR.

+ + +

Type Unit.Radar

+ +

A radar.

+ +

Field(s)

+
+
+ + #Unit.Radar.detectionDistanceAir + +Unit.Radar.detectionDistanceAir + +
+
+ +

detection distance for RCS=1m^2 airborne target, nil if radar doesn't support air search

+ +
+
+
+
+ + #Distance + +Unit.Radar.detectionDistanceHRM + +
+
+ +

detection distance for RCS=1m^2 in high-resolution mapping mode, nil if radar has no HRM

+ +
+
+
+
+ + #Distance + +Unit.Radar.detectionDistanceRBM + +
+
+ +

detection distance for RCS=1m^2 in real-beam mapping mode, nil if radar doesn't support surface/land search

+ +
+
+ +

Type Unit.Radar.detectionDistanceAir

+

Field(s)

+
+
+ + #Unit.Radar.detectionDistanceAir.lowerHemisphere + +Unit.Radar.detectionDistanceAir.lowerHemisphere + +
+
+ + + +
+
+
+
+ + #Unit.Radar.detectionDistanceAir.upperHemisphere + +Unit.Radar.detectionDistanceAir.upperHemisphere + +
+
+ + + +
+
+ +

Type Unit.Radar.detectionDistanceAir.lowerHemisphere

+

Field(s)

+
+
+ + #Distance + +Unit.Radar.detectionDistanceAir.lowerHemisphere.headOn + +
+
+ + + +
+
+
+
+ + #Distance + +Unit.Radar.detectionDistanceAir.lowerHemisphere.tailOn + +
+
+ + + +
+
+ +

Type Unit.Radar.detectionDistanceAir.upperHemisphere

+

Field(s)

+
+
+ + #Distance + +Unit.Radar.detectionDistanceAir.upperHemisphere.headOn + +
+
+ + + +
+
+
+
+ + #Distance + +Unit.Radar.detectionDistanceAir.upperHemisphere.tailOn + +
+
+ + + +
+
+ +

Type Unit.RadarType

+ +

Enum that stores radar types.

+ +

Field(s)

+
+
+ + +Unit.RadarType.AS + +
+
+ +

air search radar

+ +
+
+
+
+ + +Unit.RadarType.SS + +
+
+ +

surface/land search radar

+ +
+
+ +

Type Unit.RefuelingSystem

+ +

Enum that stores aircraft refueling system types.

+ +

Field(s)

+
+
+ + +Unit.RefuelingSystem.BOOM_AND_RECEPTACLE + +
+
+ + + +
+
+
+
+ + +Unit.RefuelingSystem.PROBE_AND_DROGUE + +
+
+ + + +
+
+ +

Type Unit.Sensor

+ +

A unit sensor.

+ +

Field(s)

+
+
+ + #Unit.SensorType + +Unit.Sensor.type + +
+
+ + + +
+
+
+
+ + #TypeName + +Unit.Sensor.typeName + +
+
+ + + +
+
+ +

Type Unit.SensorType

+ +

Enum that stores sensor types.

+ +

Field(s)

+
+
+ + +Unit.SensorType.IRST + +
+
+ + + +
+
+
+
+ + +Unit.SensorType.OPTIC + +
+
+ + + +
+
+
+
+ + +Unit.SensorType.RADAR + +
+
+ + + +
+
+
+
+ + +Unit.SensorType.RWR + +
+
+ + + +
+
+ +

Type Unit.Sensors

+ +

Type Weapon.Desc

+ +

Type list

+ +
+ +
+ + diff --git a/Documentation/DCStimer.html b/Documentation/DCStimer.html new file mode 100644 index 000000000..0e0cab0bd --- /dev/null +++ b/Documentation/DCStimer.html @@ -0,0 +1,296 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DCStimer

+ + + +

Global(s)

+ + + + + +
timer + +
+

Type timer

+ + + + + + + + + + + + + + + + + + + + + + + + + +
timer.getAbsTime() +

Returns mission time in seconds.

+
timer.getTime() +

Returns model time in seconds.

+
timer.getTime0() +

Returns mission start time in seconds.

+
timer.removeFunction(functionId) +

Removes the function from schedule.

+
timer.scheduleFunction(functionToCall, functionArgument, time) +

Schedules function to call at desired model time.

+
timer.setFunctionTime(functionId, time) +

Re-schedules function to call at another model time.

+
+ +

Global(s)

+
+
+ + #timer + +timer + +
+
+ + + +
+
+

Type DCStimer

+ +

Type FunctionToCall

+ +

Type Time

+ +

Type timer

+

Field(s)

+
+
+ + +timer.getAbsTime() + +
+
+ +

Returns mission time in seconds.

+ +

Return value

+ +

#Time:

+ + +
+
+
+
+ + +timer.getTime() + +
+
+ +

Returns model time in seconds.

+ +

Return value

+ +

#Time: +

+ +
+
+
+
+ + +timer.getTime0() + +
+
+ +

Returns mission start time in seconds.

+ +

Return value

+ +

#Time:

+ + +
+
+
+
+ + +timer.removeFunction(functionId) + +
+
+ +

Removes the function from schedule.

+ +

Parameter

+
    +
  • + +

    functionId : +Function identifier to remove from schedule

    + +
    • +
+
+
+
+
+ + +timer.scheduleFunction(functionToCall, functionArgument, time) + +
+
+ +

Schedules function to call at desired model time.

+ + +

Time function FunctionToCall(any argument, Time time)

+ +

...

+ +

return ...

+ +

end

+ +

Must return model time of next call or nil. Note that the DCS scheduler calls the function in protected mode and any Lua errors in the called function will be trapped and not reported. If the function triggers a Lua error then it will be terminated and not scheduled to run again.

+ +

Parameters

+
    +
  • + +

    #FunctionToCall functionToCall : +Lua-function to call. Must have prototype of FunctionToCall.

    + +
    • +
  • + +

    functionArgument : +Function argument of any type to pass to functionToCall.

    + +
    • +
  • + +

    #Time time : +Model time of the function call.

    + +
    • +
+

Return value

+ + +

functionId

+ +
+
+
+
+ + +timer.setFunctionTime(functionId, time) + +
+
+ +

Re-schedules function to call at another model time.

+ +

Parameters

+
    +
  • + +

    functionId : +Lua-function to call. Must have prototype of FunctionToCall.

    + +
    • +
  • + +

    #Time time : +Model time of the function call.

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Documentation/DEPLOYTASK.html b/Documentation/DEPLOYTASK.html new file mode 100644 index 000000000..841465371 --- /dev/null +++ b/Documentation/DEPLOYTASK.html @@ -0,0 +1,379 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DEPLOYTASK

+ +

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

+ +

Global(s)

+ + + + + +
DEPLOYTASK + +
+

Type DEPLOYTASK

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DEPLOYTASK:AddCargoMenus(Client, Cargos, TransportRadius) + +
DEPLOYTASK.ClassName + +
DEPLOYTASK.GoalVerb + +
DEPLOYTASK:InitCargo(InitCargos) + +
DEPLOYTASK:LoadCargo(LoadCargos) + +
DEPLOYTASK.New(CargoType) +

Creates a new DEPLOYTASK object, which models the sequence of STAGEs to unload a cargo.

+
DEPLOYTASK:RemoveCargoMenus(Client) + +
DEPLOYTASK.SetCargoTargetZoneName(string, self, TargetZoneName) +

When the cargo is unloaded, it will move to the target zone name.

+
DEPLOYTASK.TEXT + +
DEPLOYTASK:ToZone(LandingZone) + +
+ +

Global(s)

+
+
+ + #DEPLOYTASK + +DEPLOYTASK + +
+
+ + + +
+
+

Type DEPLOYTASK

+ +

A DeployTask

+ +

Field(s)

+
+
+ + +DEPLOYTASK:AddCargoMenus(Client, Cargos, TransportRadius) + +
+
+ + + +

Parameters

+
    +
  • + +

    Client :

    + +
    • +
  • + +

    Cargos :

    + +
    • +
  • + +

    TransportRadius :

    + +
    • +
+
+
+
+
+ + #string + +DEPLOYTASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +DEPLOYTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DEPLOYTASK:InitCargo(InitCargos) + +
+
+ + + +

Parameter

+
    +
  • + +

    InitCargos :

    + +
    • +
+
+
+
+
+ + +DEPLOYTASK:LoadCargo(LoadCargos) + +
+
+ + + +

Parameter

+
    +
  • + +

    LoadCargos :

    + +
    • +
+
+
+
+
+ + +DEPLOYTASK.New(CargoType) + +
+
+ +

Creates a new DEPLOYTASK object, which models the sequence of STAGEs to unload a cargo.

+ +

Parameter

+
    +
  • + +

    #string CargoType : +Type of the Cargo.

    + +
    • +
+

Return value

+ +

#DEPLOYTASK: +The created DeployTask

+ +
+
+
+
+ + +DEPLOYTASK:RemoveCargoMenus(Client) + +
+
+ + + +

Parameter

+
    +
  • + +

    Client :

    + +
    • +
+
+
+
+
+ + +DEPLOYTASK.SetCargoTargetZoneName(string, self, TargetZoneName) + +
+
+ +

When the cargo is unloaded, it will move to the target zone name.

+ +

Parameters

+
    +
  • + +

    string : +TargetZoneName Name of the Zone to where the Cargo should move after unloading.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    TargetZoneName :

    + +
    • +
+
+
+
+
+ + + +DEPLOYTASK.TEXT + +
+
+ + + +
+
+
+
+ + +DEPLOYTASK:ToZone(LandingZone) + +
+
+ + + +

Parameter

+
    +
  • + +

    LandingZone :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Documentation/DESTROYBASETASK.html b/Documentation/DESTROYBASETASK.html new file mode 100644 index 000000000..49efa6437 --- /dev/null +++ b/Documentation/DESTROYBASETASK.html @@ -0,0 +1,337 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DESTROYBASETASK

+ +

A DESTROYBASETASK will monitor the destruction of Groups and Units.

+ + +

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

+ +

Global(s)

+ + + + + +
DESTROYBASETASK + +
+

Type DESTROYBASETASK

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DESTROYBASETASK.ClassName + +
DESTROYBASETASK.DestroyPercentage + +
DESTROYBASETASK.Destroyed + +
DESTROYBASETASK.EventDead(event, self) +

Handle the SEVENTDEAD events to validate the destruction of units for the task monitoring.

+
DESTROYBASETASK.GoalVerb + +
DESTROYBASETASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupPrefixes, DestroyPercentage) +

Creates a new DESTROYBASETASK.

+
DESTROYBASETASK.ReportGoalProgress(DestroyGroup, DestroyUnit, self) +

Validate task completeness of DESTROYBASETASK.

+
+ +

Global(s)

+
+
+ + #DESTROYBASETASK + +DESTROYBASETASK + +
+
+ + + +
+
+

Type DESTROYBASETASK

+ +

The DESTROYBASETASK class

+ +

Field(s)

+
+
+ + #string + +DESTROYBASETASK.ClassName + +
+
+ + + +
+
+
+
+ + #number + +DESTROYBASETASK.DestroyPercentage + +
+
+ + + +
+
+
+
+ + #number + +DESTROYBASETASK.Destroyed + +
+
+ + + +
+
+
+
+ + +DESTROYBASETASK.EventDead(event, self) + +
+
+ +

Handle the SEVENTDEAD events to validate the destruction of units for the task monitoring.

+ +

Parameters

+
    +
  • + +

    event :

    +
        Event structure of DCS world.
+
    + +
    • +
  • + +

    self :

    + +
    • +
+
+
+
+
+ + #string + +DESTROYBASETASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DESTROYBASETASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupPrefixes, DestroyPercentage) + +
+
+ +

Creates a new DESTROYBASETASK.

+ +

Parameters

+
    +
  • + +

    string : +DestroyGroupType Text describing the group to be destroyed. f.e. "Radar Installations", "Ships", "Vehicles", "Command Centers".

    + +
    • +
  • + +

    string : +DestroyUnitType Text describing the unit types to be destroyed. f.e. "SA-6", "Row Boats", "Tanks", "Tents".

    + +
    • +
  • + +

    table : +string,...} DestroyGroupPrefixes Table of Prefixes of the Groups to be destroyed before task is completed.

    + +
    • +
  • + +

    ? : +umber DestroyPercentage 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.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroupType :

    + +
    • +
  • + +

    DestroyUnitType :

    + +
    • +
  • + +

    DestroyGroupPrefixes :

    + +
    • +
  • + +

    DestroyPercentage :

    + +
    • +
+

Return value

+ + +

DESTROYBASETASK

+ +
+
+
+
+ + +DESTROYBASETASK.ReportGoalProgress(DestroyGroup, DestroyUnit, self) + +
+
+ +

Validate task completeness of DESTROYBASETASK.

+ +

Parameters

+
    +
  • + +

    DestroyGroup :

    +
        Group structure describing the group to be evaluated.
+
    + +
    • +
  • + +

    DestroyUnit :

    +
        Unit structure describing the Unit to be evaluated.
+
    + +
    • +
  • + +

    self :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Documentation/DESTROYGROUPSTASK.html b/Documentation/DESTROYGROUPSTASK.html new file mode 100644 index 000000000..f5f7c2eb4 --- /dev/null +++ b/Documentation/DESTROYGROUPSTASK.html @@ -0,0 +1,261 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DESTROYGROUPSTASK

+ +

DESTROYGROUPSTASK

+ +

Global(s)

+ + + + + +
DESTROYGROUPSTASK + +
+

Type DESTROYGROUPSTASK

+ + + + + + + + + + + + + + + + + +
DESTROYGROUPSTASK.ClassName + +
DESTROYGROUPSTASK.GoalVerb + +
DESTROYGROUPSTASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyPercentage) +

Creates a new DESTROYGROUPSTASK.

+
DESTROYGROUPSTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) +

Report Goal Progress.

+
+ +

Global(s)

+
+
+ + #DESTROYGROUPSTASK + +DESTROYGROUPSTASK + +
+
+ + + +
+
+

Type DESTROYGROUPSTASK

+

Field(s)

+
+
+ + #string + +DESTROYGROUPSTASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +DESTROYGROUPSTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DESTROYGROUPSTASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyPercentage) + +
+
+ +

Creates a new DESTROYGROUPSTASK.

+ +

Parameters

+
    +
  • + +

    string : +DestroyGroupType String describing the group to be destroyed.

    + +
    • +
  • + +

    string : +DestroyUnitType String describing the unit to be destroyed.

    + +
    • +
  • + +

    table : +string,...} DestroyGroupNames Table of string containing the name of the groups to be destroyed before task is completed.

    + +
    • +
  • + +

    ? : +umber DestroyPercentage 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. +-@return DESTROYGROUPSTASK

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroupType :

    + +
    • +
  • + +

    DestroyUnitType :

    + +
    • +
  • + +

    DestroyGroupNames :

    + +
    • +
  • + +

    DestroyPercentage :

    + +
    • +
+
+
+
+
+ + +DESTROYGROUPSTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) + +
+
+ +

Report Goal Progress.

+ +

Parameters

+
    +
  • + +

    Group : +DestroyGroup Group structure describing the group to be evaluated.

    + +
    • +
  • + +

    Unit : +DestroyUnit Unit structure describing the Unit to be evaluated.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroup :

    + +
    • +
  • + +

    DestroyUnit :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Documentation/DESTROYRADARSTASK.html b/Documentation/DESTROYRADARSTASK.html new file mode 100644 index 000000000..bc83b5d9f --- /dev/null +++ b/Documentation/DESTROYRADARSTASK.html @@ -0,0 +1,232 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DESTROYRADARSTASK

+ +

Task class to destroy radar installations.

+ +

Global(s)

+ + + + + +
DESTROYRADARSTASK + +
+

Type DESTROYRADARSTASK

+ + + + + + + + + + + + + + + + + +
DESTROYRADARSTASK.ClassName + +
DESTROYRADARSTASK.GoalVerb + +
DESTROYRADARSTASK.New(table, self, DestroyGroupNames) +

Creates a new DESTROYRADARSTASK.

+
DESTROYRADARSTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) +

Report Goal Progress.

+
+ +

Global(s)

+
+
+ + #DESTROYRADARSTASK + +DESTROYRADARSTASK + +
+
+ + + +
+
+

Type DESTROYRADARSTASK

+

Field(s)

+
+
+ + #string + +DESTROYRADARSTASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +DESTROYRADARSTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DESTROYRADARSTASK.New(table, self, DestroyGroupNames) + +
+
+ +

Creates a new DESTROYRADARSTASK.

+ +

Parameters

+
    +
  • + +

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

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroupNames :

    + +
    • +
+

Return value

+ + +

DESTROYRADARSTASK

+ +
+
+
+
+ + +DESTROYRADARSTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) + +
+
+ +

Report Goal Progress.

+ +

Parameters

+
    +
  • + +

    Group : +DestroyGroup Group structure describing the group to be evaluated.

    + +
    • +
  • + +

    Unit : +DestroyUnit Unit structure describing the Unit to be evaluated.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroup :

    + +
    • +
  • + +

    DestroyUnit :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Documentation/DESTROYUNITTYPESTASK.html b/Documentation/DESTROYUNITTYPESTASK.html new file mode 100644 index 000000000..d961a1b51 --- /dev/null +++ b/Documentation/DESTROYUNITTYPESTASK.html @@ -0,0 +1,265 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DESTROYUNITTYPESTASK

+ +

Set TASK to destroy certain unit types.

+ +

Global(s)

+ + + + + +
DESTROYUNITTYPESTASK + +
+

Type DESTROYUNITTYPESTASK

+ + + + + + + + + + + + + + + + + +
DESTROYUNITTYPESTASK.ClassName + +
DESTROYUNITTYPESTASK.GoalVerb + +
DESTROYUNITTYPESTASK.New(string, string, table, string, self, DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyUnitTypes) +

Creates a new DESTROYUNITTYPESTASK.

+
DESTROYUNITTYPESTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) +

Report Goal Progress.

+
+ +

Global(s)

+
+
+ + #DESTROYUNITTYPESTASK + +DESTROYUNITTYPESTASK + +
+
+ + + +
+
+

Type DESTROYUNITTYPESTASK

+

Field(s)

+
+
+ + #string + +DESTROYUNITTYPESTASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +DESTROYUNITTYPESTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DESTROYUNITTYPESTASK.New(string, string, table, string, self, DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyUnitTypes) + +
+
+ +

Creates a new DESTROYUNITTYPESTASK.

+ +

Parameters

+
    +
  • + +

    string : +DestroyGroupType String describing the group to be destroyed. f.e. "Radar Installations", "Fleet", "Batallion", "Command Centers".

    + +
    • +
  • + +

    string : +DestroyUnitType String describing the unit to be destroyed. f.e. "radars", "ships", "tanks", "centers".

    + +
    • +
  • + +

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

    + +
    • +
  • + +

    string : +DestroyUnitTypes Table of string containing the type names of the units to achieve mission success.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroupType :

    + +
    • +
  • + +

    DestroyUnitType :

    + +
    • +
  • + +

    DestroyGroupNames :

    + +
    • +
  • + +

    DestroyUnitTypes :

    + +
    • +
+

Return value

+ + +

DESTROYUNITTYPESTASK

+ +
+
+
+
+ + +DESTROYUNITTYPESTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) + +
+
+ +

Report Goal Progress.

+ +

Parameters

+
    +
  • + +

    Group : +DestroyGroup Group structure describing the group to be evaluated.

    + +
    • +
  • + +

    Unit : +DestroyUnit Unit structure describing the Unit to be evaluated.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroup :

    + +
    • +
  • + +

    DestroyUnit :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Documentation/Database.html b/Documentation/Database.html new file mode 100644 index 000000000..9fde7a5ed --- /dev/null +++ b/Documentation/Database.html @@ -0,0 +1,1007 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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).

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ClientGroup + +
DATABASE + +
DATABASECategory + +
DATABASECoalition + +
InitGroup + +
InitUnitDesc + +
LogClose() + +
TargetGroup + +
TargetUnitDesc + +
nHours + +
nMins + +
nSecs + +
+

Type DATABASE

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DATABASE.ActivePlayers + +
DATABASE.ClassName + +
DATABASE.ClientsByID + +
DATABASE.ClientsByName + +
DATABASE:GetStatusGroup(GroupName) +

Get a status to a Group within the Database, this to check crossing events for example.

+
DATABASE.Groups + +
DATABASE.NavPoints + +
DATABASE:New() +

Creates a new DATABASE Object to administer the Groups defined and alive within the DCSRTE.

+
DATABASE:OnDeadOrCrash(event) +

Track DCSRTE DEAD or CRASH events for the internal scoring.

+
DATABASE:OnHit(event) + +
DATABASE.Players + +
DATABASE:ReportScoreAll() + +
DATABASE:ReportScorePlayer() + +
DATABASE:ScoreAdd(PlayerName, ScoreType, ScoreTimes, ScoreAmount, PlayerUnitName, PlayerUnitCoalition, PlayerUnitCategory, PlayerUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType) + +
DATABASE:ScoreMenu() + +
DATABASE:ScoreOpen() + +
DATABASE:SecondsToClock(sSeconds) + +
DATABASE:SetStatusGroup(GroupName, Status) +

Set a status to a Group within the Database, this to check crossing events for example.

+
DATABASE:Spawn(SpawnTemplate) +

Instantiate new Groups within the DCSRTE.

+
DATABASE.Statics + +
DATABASE.Units + +
DATABASE:_AddMissionScore(MissionName, Score) +

Registers Mission Scores for possible multiple players that contributed in the Mission.

+
DATABASE:_AddMissionTaskScore(PlayerUnit, MissionName, Score) +

Registers Scores the players completing a Mission Task.

+
DATABASE:_AddPlayerFromUnit(UnitData) +

Add a new player entering a Unit.

+
DATABASE:_FollowPlayers() +

Follows new players entering Clients within the DCSRTE.

+
DATABASE:_RegisterGroup(GroupTemplate) +

Registers new Group Templates within the DATABASE Object.

+
+ +

Global(s)

+
+
+ + + +ClientGroup + +
+
+ + + +
+
+
+
+ + #DATABASE + +DATABASE + +
+
+ + + +
+
+
+
+ + + +DATABASECategory + +
+
+ + + +
+
+
+
+ + + +DATABASECoalition + +
+
+ + + +
+
+
+
+ + + +InitGroup + +
+
+ + + +
+
+
+
+ + + +InitUnitDesc + +
+
+ + + +
+
+
+
+ + +LogClose() + +
+
+ + + +
+
+
+
+ + + +TargetGroup + +
+
+ + + +
+
+
+
+ + + +TargetUnitDesc + +
+
+ + + +
+
+
+
+ + + +nHours + +
+
+ + + +
+
+
+
+ + + +nMins + +
+
+ + + +
+
+
+
+ + + +nSecs + +
+
+ + + +
+
+

Type Database

+ +

Type DATABASE

+ +

The DATABASE class

+ +

Field(s)

+
+
+ + + +DATABASE.ActivePlayers + +
+
+ + + +
+
+
+
+ + #string + +DATABASE.ClassName + +
+
+ + + +
+
+
+
+ + + +DATABASE.ClientsByID + +
+
+ + + +
+
+
+
+ + + +DATABASE.ClientsByName + +
+
+ + + +
+
+
+
+ + +DATABASE:GetStatusGroup(GroupName) + +
+
+ +

Get a status to a Group within the Database, this to check crossing events for example.

+ +

Parameter

+
    +
  • + +

    GroupName :

    + +
    • +
+
+
+
+
+ + + +DATABASE.Groups + +
+
+ + + +
+
+
+
+ + + +DATABASE.NavPoints + +
+
+ + + +
+
+
+
+ + +DATABASE:New() + +
+
+ +

Creates a new DATABASE Object to administer the Groups defined and alive within the DCSRTE.

+ +

Return value

+ + +

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:OnDeadOrCrash(event) + +
+
+ +

Track DCSRTE DEAD or CRASH events for the internal scoring.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +DATABASE:OnHit(event) + +
+
+ + + +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + + +DATABASE.Players + +
+
+ + + +
+
+
+
+ + +DATABASE:ReportScoreAll() + +
+
+ + + +
+
+
+
+ + +DATABASE:ReportScorePlayer() + +
+
+ + + +
+
+
+
+ + +DATABASE:ScoreAdd(PlayerName, ScoreType, ScoreTimes, ScoreAmount, PlayerUnitName, PlayerUnitCoalition, PlayerUnitCategory, PlayerUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType) + +
+
+ + + +

Parameters

+
    +
  • + +

    PlayerName :

    + +
    • +
  • + +

    ScoreType :

    + +
    • +
  • + +

    ScoreTimes :

    + +
    • +
  • + +

    ScoreAmount :

    + +
    • +
  • + +

    PlayerUnitName :

    + +
    • +
  • + +

    PlayerUnitCoalition :

    + +
    • +
  • + +

    PlayerUnitCategory :

    + +
    • +
  • + +

    PlayerUnitType :

    + +
    • +
  • + +

    TargetUnitName :

    + +
    • +
  • + +

    TargetUnitCoalition :

    + +
    • +
  • + +

    TargetUnitCategory :

    + +
    • +
  • + +

    TargetUnitType :

    + +
    • +
+
+
+
+
+ + +DATABASE:ScoreMenu() + +
+
+ + + +
+
+
+
+ + +DATABASE:ScoreOpen() + +
+
+ + + +
+
+
+
+ + +DATABASE:SecondsToClock(sSeconds) + +
+
+ + + +

Parameter

+
    +
  • + +

    sSeconds :

    + +
    • +
+
+
+
+
+ + +DATABASE:SetStatusGroup(GroupName, Status) + +
+
+ +

Set a status to a Group within the Database, this to check crossing events for example.

+ +

Parameters

+
    +
  • + +

    GroupName :

    + +
    • +
  • + +

    Status :

    + +
    • +
+
+
+
+
+ + +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.

+ +

Parameter

+
    +
  • + +

    SpawnTemplate :

    + +
    • +
+
+
+
+
+ + + +DATABASE.Statics + +
+
+ + + +
+
+
+
+ + + +DATABASE.Units + +
+
+ + + +
+
+
+
+ + +DATABASE:_AddMissionScore(MissionName, Score) + +
+
+ +

Registers Mission Scores for possible multiple players that contributed in the Mission.

+ +

Parameters

+
    +
  • + +

    MissionName :

    + +
    • +
  • + +

    Score :

    + +
    • +
+
+
+
+
+ + +DATABASE:_AddMissionTaskScore(PlayerUnit, MissionName, Score) + +
+
+ +

Registers Scores the players completing a Mission Task.

+ +

Parameters

+
    +
  • + +

    PlayerUnit :

    + +
    • +
  • + +

    MissionName :

    + +
    • +
  • + +

    Score :

    + +
    • +
+
+
+
+
+ + +DATABASE:_AddPlayerFromUnit(UnitData) + +
+
+ +

Add a new player entering a Unit.

+ +

Parameter

+
    +
  • + +

    UnitData :

    + +
    • +
+
+
+
+
+ + +DATABASE:_FollowPlayers() + +
+
+ +

Follows new players entering Clients within the DCSRTE.

+ +
+
+
+
+ + +DATABASE:_RegisterGroup(GroupTemplate) + +
+
+ +

Registers new Group Templates within the DATABASE Object.

+ +

Parameter

+
    +
  • + +

    GroupTemplate :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Documentation/Escort.html b/Documentation/Escort.html new file mode 100644 index 000000000..58b3d0925 --- /dev/null +++ b/Documentation/Escort.html @@ -0,0 +1,882 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Escort

+ +

Taking the lead of AI escorting your flight.

+ + +

The ESCORT class allows you to interact with escoring AI on your flight and take the lead.

+ +

Global(s)

+ + + + + +
ESCORT + +
+

Type ESCORT

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ESCORT.ClassName + +
ESCORT.EscortClient + +
ESCORT.EscortGroup + +
ESCORT.EscortName + +
ESCORT.FollowScheduler +

The id of the _FollowScheduler function.

+
ESCORT:New(EscortClient, EscortGroup, EscortName) +

ESCORT class constructor for an AI group

+
ESCORT.OptionROE + +
ESCORT.OptionReactionOnThreat +

Which REACTIONONTHREAT is set to the EscortGroup.

+
ESCORT:RegisterRoute() + +
ESCORT.ReportTargets +

If true, nearby targets are reported.

+
ESCORT.Targets + +
ESCORT._AttackTarget(MenuParam) + +
ESCORT:_FollowScheduler(FollowDistance) + +
ESCORT._HoldPosition(MenuParam) + +
ESCORT._HoldPositionNearBy(MenuParam) + +
ESCORT._JoinUpAndFollow(MenuParam) + +
ESCORT._OptionROTEvadeFire(MenuParam) + +
ESCORT._OptionROTNoReaction(MenuParam) + +
ESCORT._OptionROTPassiveDefense(MenuParam) + +
ESCORT._OptionROTVertical(MenuParam) + +
ESCORT._ROEHoldFire(MenuParam) + +
ESCORT._ROEOpenFire(MenuParam) + +
ESCORT._ROEReturnFire(MenuParam) + +
ESCORT._ROEWeaponFree(MenuParam) + +
ESCORT._ReportNearbyTargets(MenuParam) + +
ESCORT:_ReportTargetsScheduler() + +
ESCORT._ResumeMission(MenuParam) + +
ESCORT._ScanTargets30Seconds(MenuParam) + +
ESCORT._ScanTargets60Seconds(MenuParam) + +
+ +

Type MENUPARAM

+ + + + + + + + + +
MENUPARAM.ParamDistance + +
MENUPARAM.ParamSelf + +
+ +

Global(s)

+
+
+ + #ESCORT + +ESCORT + +
+
+ + + +
+
+

Type Escort

+ +

Type Distance

+ +

Type ESCORT

+ +

ESCORT class

+ +

Field(s)

+
+
+ + #string + +ESCORT.ClassName + +
+
+ + + +
+
+
+
+ + Client#CLIENT + +ESCORT.EscortClient + +
+
+ + + +
+
+
+
+ + Group#GROUP + +ESCORT.EscortGroup + +
+
+ + + +
+
+
+
+ + #string + +ESCORT.EscortName + +
+
+ + + +
+
+
+
+ + #number + +ESCORT.FollowScheduler + +
+
+ +

The id of the _FollowScheduler function.

+ +
+
+
+
+ + +ESCORT:New(EscortClient, EscortGroup, EscortName) + +
+
+ +

ESCORT class constructor for an AI group

+ +

Parameters

+
    +
  • + +

    Client#CLIENT EscortClient : +The client escorted by the EscortGroup.

    + +
    • +
  • + +

    Group#GROUP EscortGroup : +The group AI escorting the EscortClient.

    + +
    • +
  • + +

    #string EscortName : +Name of the escort.

    + +
    • +
+

Return value

+ +

#ESCORT: +self

+ +
+
+
+
+ + + +ESCORT.OptionROE + +
+
+ + + +
+
+
+
+ + DCSTypes#AI.Option.Air.val.REACTION_ON_THREAT + +ESCORT.OptionReactionOnThreat + +
+
+ +

Which REACTIONONTHREAT is set to the EscortGroup.

+ +
+
+
+
+ + +ESCORT:RegisterRoute() + +
+
+ + + +
+
+
+
+ + #boolean + +ESCORT.ReportTargets + +
+
+ +

If true, nearby targets are reported.

+ +
+
+
+
+ + + +ESCORT.Targets + +
+
+ + + +
+
+
+
+ + +ESCORT._AttackTarget(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT:_FollowScheduler(FollowDistance) + +
+
+ + + +

Parameter

+
    +
  • + +

    FollowDistance :

    + +
    • +
+
+
+
+
+ + +ESCORT._HoldPosition(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._HoldPositionNearBy(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._JoinUpAndFollow(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._OptionROTEvadeFire(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._OptionROTNoReaction(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._OptionROTPassiveDefense(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._OptionROTVertical(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._ROEHoldFire(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._ROEOpenFire(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._ROEReturnFire(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._ROEWeaponFree(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._ReportNearbyTargets(MenuParam) + +
+
+ + + +

Parameter

+
    +
  • + +

    MenuParam :

    + +
    • +
+
+
+
+
+ + +ESCORT:_ReportTargetsScheduler() + +
+
+ + + +
+
+
+
+ + +ESCORT._ResumeMission(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._ScanTargets30Seconds(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._ScanTargets60Seconds(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+ +

Type MENUPARAM

+ +

MENUPARAM type

+ +

Field(s)

+
+
+ + #Distance + +MENUPARAM.ParamDistance + +
+
+ + + +
+
+
+
+ + #ESCORT + +MENUPARAM.ParamSelf + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Documentation/GOHOMETASK.html b/Documentation/GOHOMETASK.html new file mode 100644 index 000000000..542c51183 --- /dev/null +++ b/Documentation/GOHOMETASK.html @@ -0,0 +1,163 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module GOHOMETASK

+ +

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

+ +

Global(s)

+ + + + + +
GOHOMETASK + +
+

Type GOHOMETASK

+ + + + + + + + + +
GOHOMETASK.ClassName + +
GOHOMETASK.New(table, self, LandingZones) +

Creates a new GOHOMETASK.

+
+ +

Global(s)

+
+
+ + #GOHOMETASK + +GOHOMETASK + +
+
+ + + +
+
+

Type GOHOMETASK

+

Field(s)

+
+
+ + #string + +GOHOMETASK.ClassName + +
+
+ + + +
+
+
+
+ + +GOHOMETASK.New(table, self, LandingZones) + +
+
+ +

Creates a new GOHOMETASK.

+ +

Parameters

+
    +
  • + +

    table : +string,...}|string LandingZones Table of Landing Zone names where Home(s) are located.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    LandingZones :

    + +
    • +
+

Return value

+ + +

GOHOMETASK

+ +
+
+ +
+ +
+ + diff --git a/Documentation/Group.html b/Documentation/Group.html new file mode 100644 index 000000000..0307c5eaa --- /dev/null +++ b/Documentation/Group.html @@ -0,0 +1,2163 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Group

+ +

A GROUP class abstraction of a DCSGroup class.

+ + +

The GROUP class will take an abstraction of the DCSGroup class, providing more methods that can be done with a GROUP.

+ +

Global(s)

+ + + + + +
GROUP + +
+

Type DCSGroup

+ + + + + +
DCSGroup.id_ +

The ID of the group in DCS

+
+ +

Type GROUP

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
GROUP:Activate() +

Activates a GROUP.

+
GROUP:AllOnGround() +

Returns if all units of the group are on the ground or landed.

+
GROUP.ClassName + +
GROUP.Controller +

The controller of the group.

+
GROUP:CopyRoute(Begin, End, Randomize, Radius) +

Return the route of a group by using the Database#DATABASE class.

+
GROUP.DCSGroup +

The DCS group class.

+
GROUP:Destroy() +

Destroy a GROUP +Note that this destroy method also raises a destroy event at run-time.

+
GROUP.FindGroup(Group, DCSGroup) +

Find the created GROUP using the DCSGroup ID.

+
GROUP:GetCallsign() +

Gets the callsign of the fist unit of the group.

+
GROUP:GetDCSGroup() +

Gets the DCSGroup of the GROUP.

+
GROUP:GetDCSUnit(UnitNumber) +

Gets the DCS Unit of the GROUP.

+
GROUP:GetDetectedTargets() + +
GROUP:GetID() +

Gets the ID of the GROUP.

+
GROUP:GetMaxHeight() +

Returns the current maximum height of the group.

+
GROUP:GetMaxVelocity() +

Returns the current maximum velocity of the group.

+
GROUP:GetMinHeight() +

Returns the current minimum height of the group.

+
GROUP:GetName() +

Gets the name of the GROUP.

+
GROUP:GetPointVec2() +

Gets the current Point of the GROUP in VEC3 format.

+
GROUP:GetPositionVec3() +

Gets the current Point of the GROUP in VEC3 format.

+
GROUP:GetTaskMission() +

Return the mission template of the group.

+
GROUP:GetTaskRoute() +

Return the mission route of the group.

+
GROUP:GetTypeName() +

Gets the type name of the group.

+
GROUP:GetUnit(UnitNumber) +

Gets the DCS Unit.

+
GROUP.GroupID +

the ID of the group.

+
GROUP.GroupName +

The name of the group.

+
GROUP:IsAir() +

Returns if the group is of an air category.

+
GROUP:IsAlive() +

Returns if the group is alive.

+
GROUP:IsTargetDetected(DCSObject) + +
GROUP:Message(Message, Duration) +

Returns a message for a coalition or a client.

+
GROUP:MessageToAll(Message, Duration) +

Send a message to all coalitions.

+
GROUP:MessageToBlue(Message, Duration) +

Send a message to the blue coalition.

+
GROUP:MessageToClient(Message, Duration, Client) +

Send a message to a client.

+
GROUP:MessageToRed(Message, Duration) +

Send a message to the red coalition.

+
GROUP:New(DCSGroup) +

Create a new GROUP from a DCSGroup

+
GROUP:NewFromDCSUnit(DCSUnit) +

Create a new GROUP from an existing DCSUnit in the mission.

+
GROUP:NewFromName(GroupName) +

Create a new GROUP from an existing group name.

+
GROUP:OptionROEHoldFire() +

Holding weapons.

+
GROUP:OptionROEOpenFire() +

Openfire.

+
GROUP:OptionROEReturnFire() +

Return fire.

+
GROUP:OptionROEWeaponFree() +

Weapon free.

+
GROUP:OptionROTEvadeFire() +

Evade fire.

+
GROUP:OptionROTNoReaction() +

No evasion on enemy threats.

+
GROUP:OptionROTPassiveDefense() +

Evasion passive defense.

+
GROUP:OptionROTVertical() +

Vertical manoeuvres.

+
GROUP:PopCurrentTask() +

Popping current Task from the group.

+
GROUP:PushTask(DCSTask) +

Pushing Task on the queue from the group.

+
GROUP:RegisterWayPoint(WayPoint) + +
GROUP:Route(GoPoints) +

Make the group to follow a given route.

+
GROUP:SetTask(DCSTask) +

Clearing the Task Queue and Setting the Task on the queue from the group.

+
GROUP:TaskAttackUnit(The, AttackUnit) +

Attack the Unit.

+
GROUP:TaskCondition(time, userFlag, userFlagValue, condition, duration, lastWayPoint) +

Return a condition section for a controlled task

+
GROUP:TaskControlled(DCSTask, DCSStopCondition) +

Return a Controlled Task taking a Task and a TaskCondition

+
GROUP:TaskEmbarkToTransportAtVec2(Point, Radius) +

Move to a defined Vec2 Point, and embark to a group when arrived within a defined Radius.

+
GROUP:TaskEmbarkingAtVec2(Point, Duration, EmbarkingGroup) +

Move the group to a Vec2 Point, wait for a defined duration and embark a group.

+
GROUP:TaskHoldPosition(Duration) +

Hold position at the current position of the first unit of the group.

+
GROUP:TaskLandAtVec2(Point, Duration) +

Land the group at a Vec2Point.

+
GROUP:TaskLandAtZone(Zone, Duration) +

Land the group at a @{Zone#ZONE).

+
GROUP:TaskMission(TaskMission) +

Return a Misson task from a mission template.

+
GROUP:TaskOrbitCircle(Altitude, Speed) +

Orbit at the current position of the first unit of the group at a specified alititude

+
GROUP:TaskOrbitCircleAtVec2(Point, Altitude, Speed) +

Orbit at a specified position at a specified alititude during a specified duration with a specified speed.

+
GROUP:TaskRegisterWayPoint(WayPoint) + +
GROUP:TaskRoute(Points) +

Return a Misson task to follow a given route defined by Points.

+
GROUP:TaskRouteToVec3(Point, Speed) +

Make the group to fly to a given point and hover.

+
GROUP:TaskRouteToZone(Zone, Randomize, Speed, Formation) +

Route the group to a given zone.

+
GROUP:_GetController() +

Get the controller for the GROUP.

+
+ +

Type Vec3

+ + + + + + + + + +
Vec3.x + +
Vec3.y + +
+ +

Global(s)

+
+
+ + #GROUP + +GROUP + +
+
+ + + +
+
+

Type Group

+ +

Type DCSGroup

+ +

A DCSGroup

+ +

Field(s)

+
+
+ + +DCSGroup.id_ + +
+
+ +

The ID of the group in DCS

+ +
+
+ +

Type DCSStopCondition

+ +

Type DCSTask

+ +

Type Duration

+ +

Type GROUP

+ +

The GROUP class

+ +

Field(s)

+
+
+ + +GROUP:Activate() + +
+
+ +

Activates a GROUP.

+ +
+
+
+
+ + +GROUP:AllOnGround() + +
+
+ +

Returns if all units of the group are on the ground or landed.

+ + +

If all units of this group are on the ground, this function will return true, otherwise false.

+ +

Return value

+ +

#boolean: +All units on the ground result.

+ +
+
+
+
+ + #string + +GROUP.ClassName + +
+
+ + + +
+
+
+
+ + #table + +GROUP.Controller + +
+
+ +

The controller of the group.

+ +
+
+
+
+ + +GROUP:CopyRoute(Begin, End, Randomize, Radius) + +
+
+ +

Return the route of a group by using the Database#DATABASE class.

+ +

Parameters

+
    +
  • + +

    #number Begin : +The route point from where the copy will start. The base route point is 0.

    + +
    • +
  • + +

    #number End : +The route point where the copy will end. The End point is the last point - the End point. The last point has base 0.

    + +
    • +
  • + +

    #boolean Randomize : +Randomization of the route, when true.

    + +
    • +
  • + +

    #number Radius : +When randomization is on, the randomization is within the radius.

    + +
    • +
+
+
+
+
+ + DCSGroup#Group + +GROUP.DCSGroup + +
+
+ +

The DCS group class.

+ +
+
+
+
+ + +GROUP:Destroy() + +
+
+ +

Destroy a GROUP +Note that this destroy method also raises a destroy event at run-time.

+ + +

So all event listeners will catch the destroy event of this GROUP.

+ +
+
+
+
+ + +GROUP.FindGroup(Group, DCSGroup) + +
+
+ +

Find the created GROUP using the DCSGroup ID.

+ + +

If a GROUP was created with the DCSGroupID, the the GROUP instance will be returned. +Otherwise nil will be returned.

+ +

Parameters

+ +

Return value

+ +

#GROUP:

+ + +
+
+
+
+ + +GROUP:GetCallsign() + +
+
+ +

Gets the callsign of the fist unit of the group.

+ +

Return value

+ +

#string: +The callsign of the first unit of the group.

+ +
+
+
+
+ + +GROUP:GetDCSGroup() + +
+
+ +

Gets the DCSGroup of the GROUP.

+ +

Return value

+ +

#Group: +The DCSGroup.

+ +
+
+
+
+ + +GROUP:GetDCSUnit(UnitNumber) + +
+
+ +

Gets the DCS Unit of the GROUP.

+ +

Parameter

+
    +
  • + +

    #number UnitNumber : +The unit index to be returned from the GROUP.

    + +
    • +
+

Return value

+ +

#Unit: +The DCS Unit.

+ +
+
+
+
+ + +GROUP:GetDetectedTargets() + +
+
+ + + +
+
+
+
+ + +GROUP:GetID() + +
+
+ +

Gets the ID of the GROUP.

+ +

Return value

+ +

#number: +The ID of the GROUP.

+ +
+
+
+
+ + +GROUP:GetMaxHeight() + +
+
+ +

Returns the current maximum height of the group.

+ + +

Each unit within the group gets evaluated, and the maximum height (= the unit which is the highest elevated) is returned.

+ +

Return value

+ +

#number: +Maximum height found.

+ +
+
+
+
+ + +GROUP:GetMaxVelocity() + +
+
+ +

Returns the current maximum velocity of the group.

+ + +

Each unit within the group gets evaluated, and the maximum velocity (= the unit which is going the fastest) is returned.

+ +

Return value

+ +

#number: +Maximum velocity found.

+ +
+
+
+
+ + +GROUP:GetMinHeight() + +
+
+ +

Returns the current minimum height of the group.

+ + +

Each unit within the group gets evaluated, and the minimum height (= the unit which is the lowest elevated) is returned.

+ +

Return value

+ +

#number: +Minimum height found.

+ +
+
+
+
+ + +GROUP:GetName() + +
+
+ +

Gets the name of the GROUP.

+ +

Return value

+ +

#string: +The name of the GROUP.

+ +
+
+
+
+ + +GROUP:GetPointVec2() + +
+
+ +

Gets the current Point of the GROUP in VEC3 format.

+ +

Return value

+ +

#Vec3: +Current x,y and z position of the group.

+ +
+
+
+
+ + +GROUP:GetPositionVec3() + +
+
+ +

Gets the current Point of the GROUP in VEC3 format.

+ +

Return value

+ +

#Vec3: +Current Vec3 position of the group.

+ +
+
+
+
+ + +GROUP:GetTaskMission() + +
+
+ +

Return the mission template of the group.

+ +

Return value

+ +

#table: +The MissionTemplate

+ +
+
+
+
+ + +GROUP:GetTaskRoute() + +
+
+ +

Return the mission route of the group.

+ +

Return value

+ +

#table: +The mission route defined by points.

+ +
+
+
+
+ + +GROUP:GetTypeName() + +
+
+ +

Gets the type name of the group.

+ +

Return value

+ +

#string: +The type name of the group.

+ +
+
+
+
+ + +GROUP:GetUnit(UnitNumber) + +
+
+ +

Gets the DCS Unit.

+ +

Parameter

+
    +
  • + +

    #number UnitNumber : +The number of the Unit to be returned.

    + +
    • +
+

Return value

+ +

Unit#UNIT: +The DCS Unit.

+ +
+
+
+
+ + #number + +GROUP.GroupID + +
+
+ +

the ID of the group.

+ +
+
+
+
+ + #string + +GROUP.GroupName + +
+
+ +

The name of the group.

+ +
+
+
+
+ + +GROUP:IsAir() + +
+
+ +

Returns if the group is of an air category.

+ + +

If the group is a helicopter or a plane, then this method will return true, otherwise false.

+ +

Return value

+ +

#boolean: +Air category evaluation result.

+ +
+
+
+
+ + +GROUP:IsAlive() + +
+
+ +

Returns if the group is alive.

+ + +

When the group exists at run-time, this method will return true, otherwise false.

+ +

Return value

+ +

#boolean: +Alive result.

+ +
+
+
+
+ + +GROUP:IsTargetDetected(DCSObject) + +
+
+ + + +

Parameter

+
    +
  • + +

    DCSObject :

    + +
    • +
+
+
+
+
+ + +GROUP:Message(Message, Duration) + +
+
+ +

Returns a message for a coalition or a client.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
+

Return value

+ +

Message#MESSAGE:

+ + +
+
+
+
+ + +GROUP:MessageToAll(Message, Duration) + +
+
+ +

Send a message to all coalitions.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
+
+
+
+
+ + +GROUP:MessageToBlue(Message, Duration) + +
+
+ +

Send a message to the blue coalition.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
+
+
+
+
+ + +GROUP:MessageToClient(Message, Duration, Client) + +
+
+ +

Send a message to a client.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
  • + +

    Client#CLIENT Client : +The client object receiving the message.

    + +
    • +
+
+
+
+
+ + +GROUP:MessageToRed(Message, Duration) + +
+
+ +

Send a message to the red coalition.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
+
+
+
+
+ + +GROUP:New(DCSGroup) + +
+
+ +

Create a new GROUP from a DCSGroup

+ +

Parameter

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:NewFromDCSUnit(DCSUnit) + +
+
+ +

Create a new GROUP from an existing DCSUnit in the mission.

+ +

Parameter

+
    +
  • + +

    DCSUnit : +The DCSUnit.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:NewFromName(GroupName) + +
+
+ +

Create a new GROUP from an existing group name.

+ +

Parameter

+
    +
  • + +

    GroupName : +The name of the DCS Group.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROEHoldFire() + +
+
+ +

Holding weapons.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROEOpenFire() + +
+
+ +

Openfire.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROEReturnFire() + +
+
+ +

Return fire.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROEWeaponFree() + +
+
+ +

Weapon free.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROTEvadeFire() + +
+
+ +

Evade fire.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROTNoReaction() + +
+
+ +

No evasion on enemy threats.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROTPassiveDefense() + +
+
+ +

Evasion passive defense.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROTVertical() + +
+
+ +

Vertical manoeuvres.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:PopCurrentTask() + +
+
+ +

Popping current Task from the group.

+ +

Return value

+ +

Group#GROUP: +self

+ +
+
+
+
+ + +GROUP:PushTask(DCSTask) + +
+
+ +

Pushing Task on the queue from the group.

+ +

Parameter

+
    +
  • + +

    DCSTask :

    + +
    • +
+

Return value

+ +

Group#GROUP: +self

+ +
+
+
+
+ + +GROUP:RegisterWayPoint(WayPoint) + +
+
+ + + +

Parameter

+
    +
  • + +

    WayPoint :

    + +
    • +
+
+
+
+
+ + +GROUP:Route(GoPoints) + +
+
+ +

Make the group to follow a given route.

+ +

Parameter

+
    +
  • + +

    #table GoPoints : +A table of Route Points.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:SetTask(DCSTask) + +
+
+ +

Clearing the Task Queue and Setting the Task on the queue from the group.

+ +

Parameter

+
    +
  • + +

    DCSTask :

    + +
    • +
+

Return value

+ +

Group#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskAttackUnit(The, AttackUnit) + +
+
+ +

Attack the Unit.

+ +

Parameters

+
    +
  • + +

    Unit#UNIT The : +unit.

    + +
    • +
  • + +

    AttackUnit :

    + +
    • +
+

Return value

+ +

#DCSTask: +The DCS task structure.

+ +
+
+
+
+ + +GROUP:TaskCondition(time, userFlag, userFlagValue, condition, duration, lastWayPoint) + +
+
+ +

Return a condition section for a controlled task

+ +

Parameters

+
    +
  • + +

    #Time time :

    + +
    • +
  • + +

    #string userFlag :

    + +
    • +
  • + +

    #boolean userFlagValue :

    + +
    • +
  • + +

    #string condition :

    + +
    • +
  • + +

    #Time duration :

    + +
    • +
  • + +

    #number lastWayPoint :

    + +

    return #DCSTask

    + +
    • +
+
+
+
+
+ + +GROUP:TaskControlled(DCSTask, DCSStopCondition) + +
+
+ +

Return a Controlled Task taking a Task and a TaskCondition

+ +

Parameters

+ +

Return value

+ +

#DCSTask:

+ + +
+
+
+
+ + +GROUP:TaskEmbarkToTransportAtVec2(Point, Radius) + +
+
+ +

Move to a defined Vec2 Point, and embark to a group when arrived within a defined Radius.

+ +

Parameters

+
    +
  • + +

    #Vec2 Point : +The point where to wait.

    + +
    • +
  • + +

    #number Radius : +The radius of the embarking zone around the Point.

    + +
    • +
+

Return value

+ +

#DCSTask: +The DCS task structure.

+ +
+
+
+
+ + +GROUP:TaskEmbarkingAtVec2(Point, Duration, EmbarkingGroup) + +
+
+ +

Move the group to a Vec2 Point, wait for a defined duration and embark a group.

+ +

Parameters

+
    +
  • + +

    #Vec2 Point : +The point where to wait.

    + +
    • +
  • + +

    #number Duration : +The duration in seconds to wait.

    + +
    • +
  • + +

    #GROUP EmbarkingGroup : +The group to be embarked.

    + +
    • +
+

Return value

+ +

#DCSTask: +The DCS task structure

+ +
+
+
+
+ + +GROUP:TaskHoldPosition(Duration) + +
+
+ +

Hold position at the current position of the first unit of the group.

+ +

Parameter

+
    +
  • + +

    #number Duration : +The maximum duration in seconds to hold the position.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskLandAtVec2(Point, Duration) + +
+
+ +

Land the group at a Vec2Point.

+ +

Parameters

+
    +
  • + +

    #Vec2 Point : +The point where to land.

    + +
    • +
  • + +

    #number Duration : +The duration in seconds to stay on the ground.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskLandAtZone(Zone, Duration) + +
+
+ +

Land the group at a @{Zone#ZONE).

+ +

Parameters

+
    +
  • + +

    Zone#ZONE Zone : +The zone where to land.

    + +
    • +
  • + +

    #number Duration : +The duration in seconds to stay on the ground.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskMission(TaskMission) + +
+
+ +

Return a Misson task from a mission template.

+ +

Parameter

+
    +
  • + +

    #table TaskMission : +A table containing the mission task.

    + +
    • +
+

Return value

+ +

#DCSTask:

+ + +
+
+
+
+ + +GROUP:TaskOrbitCircle(Altitude, Speed) + +
+
+ +

Orbit at the current position of the first unit of the group at a specified alititude

+ +

Parameters

+
    +
  • + +

    #number Altitude : +The altitude to hold the position.

    + +
    • +
  • + +

    #number Speed : +The speed flying when holding the position.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskOrbitCircleAtVec2(Point, Altitude, Speed) + +
+
+ +

Orbit at a specified position at a specified alititude during a specified duration with a specified speed.

+ +

Parameters

+
    +
  • + +

    #Vec2 Point : +The point to hold the position.

    + +
    • +
  • + +

    #number Altitude : +The altitude to hold the position.

    + +
    • +
  • + +

    #number Speed : +The speed flying when holding the position.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskRegisterWayPoint(WayPoint) + +
+
+ + + +

Parameter

+
    +
  • + +

    WayPoint :

    + +
    • +
+
+
+
+
+ + +GROUP:TaskRoute(Points) + +
+
+ +

Return a Misson task to follow a given route defined by Points.

+ +

Parameter

+
    +
  • + +

    #table Points : +A table of route points.

    + +
    • +
+

Return value

+ +

#DCSTask:

+ + +
+
+
+
+ + +GROUP:TaskRouteToVec3(Point, Speed) + +
+
+ +

Make the group to fly to a given point and hover.

+ +

Parameters

+
    +
  • + +

    #Vec3 Point : +The destination point.

    + +
    • +
  • + +

    #number Speed : +The speed to travel.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskRouteToZone(Zone, Randomize, Speed, Formation) + +
+
+ +

Route the group to a given zone.

+ + +

The group final destination point can be randomized. +A speed can be given in km/h. +A given formation can be given.

+ +

Parameters

+
    +
  • + +

    Zone#ZONE Zone : +The zone where to route to.

    + +
    • +
  • + +

    #boolean Randomize : +Defines whether to target point gets randomized within the Zone.

    + +
    • +
  • + +

    #number Speed : +The speed.

    + +
    • +
  • + +

    Base#FORMATION Formation : +The formation string.

    + +
    • +
+
+
+
+
+ + +GROUP:_GetController() + +
+
+ +

Get the controller for the GROUP.

+ +

Return value

+ +

Controller#Controller:

+ + +
+
+ +

Type Time

+ +

Type Unit

+ +

Type Vec2

+ +

Type Vec3

+

Field(s)

+
+
+ + + +Vec3.x + +
+
+ + + +
+
+
+
+ + + +Vec3.y + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Documentation/MISSION.html b/Documentation/MISSION.html new file mode 100644 index 000000000..b38c11c0f --- /dev/null +++ b/Documentation/MISSION.html @@ -0,0 +1,1643 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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.

+ +

Global(s)

+ + + + + + + + + + + + + + + + + +
MISSION + +
MISSIONSCHEDULER + +
TaskComplete + +
_TransportExecuteStage + +
+

Type MISSION

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MISSION.AddClient(CLIENT, self, Client) +

Register a new CLIENT to participate within the mission.

+
MISSION.AddGoalFunction(function, self, GoalFunction) +

Add a goal function to a MISSION.

+
MISSION:AddTask(Task, TaskNumber) + +
MISSION.ClassName + +
MISSION:Completed() +

Set a Mission to completed.

+
MISSION.FAILED + +
MISSION:Failed() +

Set a Mission to failed.

+
MISSION.FindClient(CLIENT, self, ClientName) +

Find a CLIENT object within the MISSION by its ClientName.

+
MISSION:GetTask(TaskNumber) + +
MISSION:GetTasks() +

Get all the TASKs from the Mission.

+
MISSION.GoalFunction + +
MISSION:IsCompleted() +

Returns if a Mission has completed.

+
MISSION:IsFailed() +

Returns if a Mission has failed.

+
MISSION:IsOngoing() +

Returns if a Mission is ongoing.

+
MISSION:IsPending() +

Returns if a Mission is pending.

+
MISSION:Meta() + +
MISSION.MissionCoalition + +
MISSION.MissionProgressTrigger + +
MISSION.MissionReportFlash + +
MISSION.MissionReportShow + +
MISSION.MissionReportTrigger + +
MISSION.MissionStatus + +
MISSION.MissionTimeInterval + +
MISSION.Name + +
MISSION.New(string, string, string, string, self, MissionName, MissionPriority, MissionBriefing, MissionCoalition) +

This is the main MISSION declaration method.

+
MISSION:Ongoing() +

Set a Mission to ongoing.

+
MISSION:Pending() +

Set a Mission to pending.

+
MISSION.REPEAT + +
MISSION:ReportToAll() +

Report the status of all MISSIONs to all active Clients.

+
MISSION:ReportTrigger() +

Handles the reporting.

+
MISSION.SUCCESS + +
MISSION.ShowBriefing(CLIENT, self, Client) +

Show the briefing of the MISSION to the CLIENT.

+
MISSION:StatusToClients() +

Send the status of the MISSION to all Clients.

+
MISSION._ActiveTasks + +
MISSION._Clients + +
MISSION._GoalTasks + +
MISSION._Tasks + +
+ +

Type MISSIONSCHEDULER

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MISSIONSCHEDULER.AddMission(Mission) +

This is the main MISSION declaration method.

+
MISSIONSCHEDULER.FindMission(MissionName) +

Find a MISSION within the MISSIONSCHEDULER.

+
MISSIONSCHEDULER.MissionCount + +
MISSIONSCHEDULER.Missions + +
MISSIONSCHEDULER.RemoveMission(MissionName) +

Remove a MISSION from the MISSIONSCHEDULER.

+
MISSIONSCHEDULER.ReportMenu() +

Enables a MENU option in the communications menu under F10 to control the status of the active missions.

+
MISSIONSCHEDULER.ReportMissionsFlash(TimeInterval) + +
MISSIONSCHEDULER.ReportMissionsHide(Prm) + +
MISSIONSCHEDULER.ReportMissionsShow() + +
MISSIONSCHEDULER.Scheduler() +

This is the main MISSIONSCHEDULER Scheduler function.

+
MISSIONSCHEDULER.SchedulerId + +
MISSIONSCHEDULER.Start() +

Start the MISSIONSCHEDULER.

+
MISSIONSCHEDULER.Stop() +

Stop the MISSIONSCHEDULER.

+
MISSIONSCHEDULER:Time(TimeSeconds, TimeIntervalShow, TimeShow) + +
MISSIONSCHEDULER.TimeIntervalCount + +
MISSIONSCHEDULER.TimeIntervalShow + +
MISSIONSCHEDULER.TimeSeconds + +
MISSIONSCHEDULER.TimeShow + +
+ +

Global(s)

+
+
+ + #MISSION + +MISSION + +
+
+ + + +
+
+
+
+ + #MISSIONSCHEDULER + +MISSIONSCHEDULER + +
+
+ + + +
+
+
+
+ + #boolean + +TaskComplete + +
+
+ + + + +

For each Client, check for each Task the state and evolve the mission. + This flag will indicate if the Task of the Client is Complete.

+ +
+
+
+
+ + + +_TransportExecuteStage + +
+
+ + + + +

_TransportExecuteStage: Defines the different stages of Transport unload/load execution. This table is internal and is used to control the validity of Transport load/unload timing.

+ +
    +
  • _TransportExecuteStage.EXECUTING
    • +
  • _TransportExecuteStage.SUCCESS
    • +
  • _TransportExecuteStage.FAILED
    • +
+ +

--

+ +
+
+

Type MISSION

+

Field(s)

+
+
+ + +MISSION.AddClient(CLIENT, self, Client) + +
+
+ +

Register a new CLIENT to participate within the mission.

+ +

Parameters

+
    +
  • + +

    CLIENT : +Client is the CLIENT object. The object must have been instantiated with CLIENT.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    Client :

    + +
    • +
+

Return value

+ + +

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.AddGoalFunction(function, self, GoalFunction) + +
+
+ +

Add a goal function to a MISSION.

+ + +

Goal functions are called when a TASK within a mission has been completed.

+ +

Parameters

+
    +
  • + +

    function : +GoalFunction 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.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalFunction :

    + +
    • +
+

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:AddTask(Task, TaskNumber) + +
+
+ + + +

Parameters

+
    +
  • + +

    Task :

    + +
    • +
  • + +

    TaskNumber :

    + +
    • +
+
+
+
+
+ + #string + +MISSION.ClassName + +
+
+ + + +
+
+
+
+ + +MISSION:Completed() + +
+
+ +

Set a Mission to completed.

+ +
+
+
+
+ + #number + +MISSION.FAILED + +
+
+ + + +
+
+
+
+ + +MISSION:Failed() + +
+
+ +

Set a Mission to failed.

+ +
+
+
+
+ + +MISSION.FindClient(CLIENT, self, ClientName) + +
+
+ +

Find a CLIENT object within the MISSION by its ClientName.

+ +

Parameters

+
    +
  • + +

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

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    ClientName :

    + +
    • +
+

Return value

+ + +

CLIENT

+ +

Usage:

+ 
-- Seach for Client "Bomber" within the Mission.
+local BomberClient = Mission:FindClient( "Bomber" )
+ +
+
+
+
+ + +MISSION:GetTask(TaskNumber) + +
+
+ + + +

Parameter

+
    +
  • + +

    TaskNumber :

    + +
    • +
+
+
+
+
+ + +MISSION:GetTasks() + +
+
+ +

Get all the TASKs from the Mission.

+ + +

This function is useful in GoalFunctions.

+ +

Return value

+ + +

{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() .. "%" )
+ +
+
+
+
+ + +MISSION.GoalFunction + +
+
+ + + +
+
+
+
+ + +MISSION:IsCompleted() + +
+
+ +

Returns if a Mission has completed.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + +MISSION:IsFailed() + +
+
+ +

Returns if a Mission has failed.

+ + +

treturn bool

+ +
+
+
+
+ + +MISSION:IsOngoing() + +
+
+ +

Returns if a Mission is ongoing.

+ + +

treturn bool

+ +
+
+
+
+ + +MISSION:IsPending() + +
+
+ +

Returns if a Mission is pending.

+ + +

treturn bool

+ +
+
+
+
+ + +MISSION:Meta() + +
+
+ + + +
+
+
+
+ + #string + +MISSION.MissionCoalition + +
+
+ + + +
+
+
+
+ + #number + +MISSION.MissionProgressTrigger + +
+
+ + + +
+
+
+
+ + #boolean + +MISSION.MissionReportFlash + +
+
+ + + +
+
+
+
+ + #boolean + +MISSION.MissionReportShow + +
+
+ + + +
+
+
+
+ + #number + +MISSION.MissionReportTrigger + +
+
+ + + +
+
+
+
+ + #string + +MISSION.MissionStatus + +
+
+ + + +
+
+
+
+ + #number + +MISSION.MissionTimeInterval + +
+
+ + + +
+
+
+
+ + #string + +MISSION.Name + +
+
+ + + +
+
+
+
+ + +MISSION.New(string, string, string, string, self, 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

+
    +
  • + +

    string : +MissionName is the name of the mission. This name will be used to reference the status of each mission by the players.

    + +
    • +
  • + +

    string : +MissionPriority 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.

    + +
    • +
  • + +

    string : +MissionBriefing is a string indicating the mission briefing to be shown when a player joins a CLIENT.

    + +
    • +
  • + +

    string : +MissionCoalition 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"...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    MissionName :

    + +
    • +
  • + +

    MissionPriority :

    + +
    • +
  • + +

    MissionBriefing :

    + +
    • +
  • + +

    MissionCoalition :

    + +
    • +
+

Return value

+ + +

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:Ongoing() + +
+
+ +

Set a Mission to ongoing.

+ +
+
+
+
+ + +MISSION:Pending() + +
+
+ +

Set a Mission to pending.

+ +
+
+
+
+ + #number + +MISSION.REPEAT + +
+
+ + + +
+
+
+
+ + +MISSION:ReportToAll() + +
+
+ +

Report the status of all MISSIONs to all active Clients.

+ +
+
+
+
+ + +MISSION:ReportTrigger() + +
+
+ +

Handles the reporting.

+ + +

After certain time intervals, a MISSION report MESSAGE will be shown to All Players.

+ +
+
+
+
+ + #number + +MISSION.SUCCESS + +
+
+ + + +
+
+
+
+ + +MISSION.ShowBriefing(CLIENT, self, Client) + +
+
+ +

Show the briefing of the MISSION to the CLIENT.

+ +

Parameters

+
    +
  • + +

    CLIENT : +Client to show briefing to.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    Client :

    + +
    • +
+

Return value

+ + +

CLIENT

+ +
+
+
+
+ + +MISSION:StatusToClients() + +
+
+ +

Send the status of the MISSION to all Clients.

+ +
+
+
+
+ + + +MISSION._ActiveTasks + +
+
+ + + +
+
+
+
+ + + +MISSION._Clients + +
+
+ + + +
+
+
+
+ + + +MISSION._GoalTasks + +
+
+ + + +
+
+
+
+ + + +MISSION._Tasks + +
+
+ + + +
+
+ +

Type 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.

+ +

Field(s)

+
+
+ + +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.

+ +

Parameter

+
    +
  • + +

    Mission : +is the MISSION object instantiated by MISSION.

    + +
    • +
+

Return value

+ + +

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.FindMission(MissionName) + +
+
+ +

Find a MISSION within the MISSIONSCHEDULER.

+ +

Parameter

+
    +
  • + +

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

    + +
    • +
+

Return value

+ + +

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' )
+ +
+
+
+
+ + #number + +MISSIONSCHEDULER.MissionCount + +
+
+ + + +
+
+
+
+ + + +MISSIONSCHEDULER.Missions + +
+
+ + + +
+
+
+
+ + +MISSIONSCHEDULER.RemoveMission(MissionName) + +
+
+ +

Remove a MISSION from the MISSIONSCHEDULER.

+ +

Parameter

+
    +
  • + +

    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.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.ReportMissionsFlash(TimeInterval) + +
+
+ + + + +

Internal function used by the MISSIONSCHEDULER menu.

+ +

Parameter

+
    +
  • + +

    TimeInterval :

    + +
    • +
+
+
+
+
+ + +MISSIONSCHEDULER.ReportMissionsHide(Prm) + +
+
+ + + + +

Internal function used by the MISSIONSCHEDULER menu.

+ +

Parameter

+
    +
  • + +

    Prm :

    + +
    • +
+
+
+
+
+ + +MISSIONSCHEDULER.ReportMissionsShow() + +
+
+ + + + +

Internal function used by the MISSIONSCHEDULER menu.

+ +
+
+
+
+ + +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.SchedulerId + +
+
+ + + +
+
+
+
+ + +MISSIONSCHEDULER.Start() + +
+
+ +

Start the MISSIONSCHEDULER.

+ +
+
+
+
+ + +MISSIONSCHEDULER.Stop() + +
+
+ +

Stop the MISSIONSCHEDULER.

+ +
+
+
+
+ + +MISSIONSCHEDULER:Time(TimeSeconds, TimeIntervalShow, TimeShow) + +
+
+ + + +

Parameters

+
    +
  • + +

    TimeSeconds :

    + +
    • +
  • + +

    TimeIntervalShow :

    + +
    • +
  • + +

    TimeShow :

    + +
    • +
+
+
+
+
+ + #number + +MISSIONSCHEDULER.TimeIntervalCount + +
+
+ + + +
+
+
+
+ + #number + +MISSIONSCHEDULER.TimeIntervalShow + +
+
+ + + +
+
+
+
+ + #number + +MISSIONSCHEDULER.TimeSeconds + +
+
+ + + +
+
+
+
+ + #number + +MISSIONSCHEDULER.TimeShow + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Documentation/MOVEMENT.html b/Documentation/MOVEMENT.html new file mode 100644 index 000000000..04511d6b9 --- /dev/null +++ b/Documentation/MOVEMENT.html @@ -0,0 +1,272 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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).

+ +

Global(s)

+ + + + + +
MOVEMENT + +
+

Type MOVEMENT

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MOVEMENT.ClassName + +
MOVEMENT:New(MovePrefixes, MoveMaximum) + +
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:ScheduleStart() +

Call this function to start the MOVEMENT scheduling.

+
MOVEMENT:ScheduleStop() +

Call this function to stop the MOVEMENT scheduling.

+
MOVEMENT:_Scheduler() +

This function is called automatically by the MOVEMENT scheduler.

+
+ +

Global(s)

+
+
+ + #MOVEMENT + +MOVEMENT + +
+
+ + + +
+
+

Type MOVEMENT

+

Field(s)

+
+
+ + #string + +MOVEMENT.ClassName + +
+
+ + + +
+
+
+
+ + +MOVEMENT:New(MovePrefixes, MoveMaximum) + +
+
+ + + +

Parameters

+
    +
  • + +

    MovePrefixes :

    + +
    • +
  • + +

    MoveMaximum :

    + +
    • +
+
+
+
+
+ + +MOVEMENT:OnBirth(event) + +
+
+ +

Captures the birth events when new Units were spawned.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +MOVEMENT:OnDeadOrCrash(event) + +
+
+ +

Captures the Dead or Crash events when Units crash or are destroyed.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +MOVEMENT:ScheduleStart() + +
+
+ +

Call this function to start the MOVEMENT scheduling.

+ +
+
+
+
+ + +MOVEMENT:ScheduleStop() + +
+
+ +

Call this function to stop the MOVEMENT scheduling.

+ +
+
+
+
+ + +MOVEMENT:_Scheduler() + +
+
+ +

This function is called automatically by the MOVEMENT scheduler.

+ + +

A new function is scheduled when MoveScheduled is true.

+ +
+
+ +
+ +
+ + diff --git a/Documentation/Menu.html b/Documentation/Menu.html new file mode 100644 index 000000000..ad32c2be9 --- /dev/null +++ b/Documentation/Menu.html @@ -0,0 +1,648 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Menu

+ +

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

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + +
COMMANDMENU + +
MENU + +
MENU_CLIENT + +
MENU_CLIENT_COMMAND + +
SUBMENU + +
+

Type COMMANDMENU

+ + + + + + + + + + + + + + + + + +
COMMANDMENU.ClassName + +
COMMANDMENU.CommandMenuArgument + +
COMMANDMENU.CommandMenuFunction + +
COMMANDMENU:New(MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument) + +
+ +

Type MENU

+ + + + + + + + + + + + + + + + + + + + + +
MENU.ClassName + +
MENU.MenuParentPath + +
MENU.MenuPath + +
MENU.MenuText + +
MENU:New(MenuText, MenuParentPath) + +
+ +

Type MENU_CLIENT

+ + + + + + + + + +
MENU_CLIENT.ClassName + +
MENU_CLIENT:New(MenuClient, MenuText, ParentMenu) +

Creates a new menu item for a group

+
+ +

Type MENU_CLIENT_COMMAND

+ + + + + + + + + + + + + +
MENU_CLIENT_COMMAND.ClassName + +
MENU_CLIENT_COMMAND:New(MenuClient, MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument) +

Creates a new radio command item for a group

+
MENU_CLIENT_COMMAND:Remove() + +
+ +

Type SUBMENU

+ + + + + + + + + +
SUBMENU.ClassName + +
SUBMENU:New(MenuText, ParentMenu) + +
+ +

Global(s)

+
+
+ + #COMMANDMENU + +COMMANDMENU + +
+
+ + + +
+
+
+
+ + #MENU + +MENU + +
+
+ + + +
+
+
+
+ + #MENU_CLIENT + +MENU_CLIENT + +
+
+ + + +
+
+
+
+ + #MENU_CLIENT_COMMAND + +MENU_CLIENT_COMMAND + +
+
+ + + +
+
+
+
+ + #SUBMENU + +SUBMENU + +
+
+ + + +
+
+

Type Menu

+ +

Type COMMANDMENU

+ +

The COMMANDMENU class

+ +

Field(s)

+
+
+ + #string + +COMMANDMENU.ClassName + +
+
+ + + +
+
+
+
+ + +COMMANDMENU.CommandMenuArgument + +
+
+ + + +
+
+
+
+ + +COMMANDMENU.CommandMenuFunction + +
+
+ + + +
+
+
+
+ + +COMMANDMENU:New(MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument) + +
+
+ + + +

Parameters

+
    +
  • + +

    MenuText :

    + +
    • +
  • + +

    ParentMenu :

    + +
    • +
  • + +

    CommandMenuFunction :

    + +
    • +
  • + +

    CommandMenuArgument :

    + +
    • +
+
+
+ +

Type MENU

+ +

The MENU class

+ +

Field(s)

+
+
+ + #string + +MENU.ClassName + +
+
+ + + +
+
+
+
+ + +MENU.MenuParentPath + +
+
+ + + +
+
+
+
+ + +MENU.MenuPath + +
+
+ + + +
+
+
+
+ + #string + +MENU.MenuText + +
+
+ + + +
+
+
+
+ + +MENU:New(MenuText, MenuParentPath) + +
+
+ + + +

Parameters

+
    +
  • + +

    MenuText :

    + +
    • +
  • + +

    MenuParentPath :

    + +
    • +
+
+
+ +

Type MENU_CLIENT

+ +

The MENU_CLIENT class

+ +

Field(s)

+
+
+ + #string + +MENU_CLIENT.ClassName + +
+
+ + + +
+
+
+
+ + +MENU_CLIENT:New(MenuClient, MenuText, ParentMenu) + +
+
+ +

Creates a new menu item for a group

+ +

Parameters

+
    +
  • + +

    Client#CLIENT MenuClient : +The Client owning the menu.

    + +
    • +
  • + +

    #string MenuText : +The text for the menu.

    + +
    • +
  • + +

    #table ParentMenu : +The parent menu.

    + +
    • +
+

Return value

+ +

#MENU_CLIENT: +self

+ +
+
+ +

Type MENU_CLIENT_COMMAND

+ +

The MENUCLIENTCOMMAND class

+ +

Field(s)

+
+
+ + #string + +MENU_CLIENT_COMMAND.ClassName + +
+
+ + + +
+
+
+
+ + +MENU_CLIENT_COMMAND:New(MenuClient, MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument) + +
+
+ +

Creates a new radio command item for a group

+ +

Parameters

+
    +
  • + +

    Client#CLIENT MenuClient : +The Client owning the menu.

    + +
    • +
  • + +

    MenuText : +The text for the menu.

    + +
    • +
  • + +

    ParentMenu : +The parent menu.

    + +
    • +
  • + +

    CommandMenuFunction : +A function that is called when the menu key is pressed.

    + +
    • +
  • + +

    CommandMenuArgument : +An argument for the function.

    + +
    • +
+

Return value

+ +

Menu#MENUCLIENTCOMMAND: +self

+ +
+
+
+
+ + +MENU_CLIENT_COMMAND:Remove() + +
+
+ + + +
+
+ +

Type SUBMENU

+ +

The SUBMENU class

+ +

Field(s)

+
+
+ + #string + +SUBMENU.ClassName + +
+
+ + + +
+
+
+
+ + +SUBMENU:New(MenuText, ParentMenu) + +
+
+ + + +

Parameters

+
    +
  • + +

    MenuText :

    + +
    • +
  • + +

    ParentMenu :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Documentation/Message.html b/Documentation/Message.html new file mode 100644 index 000000000..c3affb541 --- /dev/null +++ b/Documentation/Message.html @@ -0,0 +1,548 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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().

+ +

Global(s)

+ + + + + + + + + +
MESSAGE + +
MESSAGEQUEUE + +
+

Type MESSAGE

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MESSAGE.ClassName + +
MESSAGE.MessageCategory + +
MESSAGE.MessageID + +
MESSAGE:New(MessageText, MessageCategory, MessageDuration, MessageID) +

Creates a new MESSAGE object.

+
MESSAGE:ToAll() +

Sends a MESSAGE to all players.

+
MESSAGE:ToBlue() +

Sends a MESSAGE to the Blue coalition.

+
MESSAGE:ToClient(Client) +

Sends a MESSAGE to a Client Group.

+
MESSAGE:ToCoalition(CoalitionSide) +

Sends a MESSAGE to a Coalition.

+
MESSAGE:ToRed() +

Sends a MESSAGE to the Red Coalition.

+
+ +

Type MESSAGEQUEUE

+ + + + + + + + + + + + + + + + + +
MESSAGEQUEUE.ClientGroups + +
MESSAGEQUEUE.CoalitionSides + +
MESSAGEQUEUE:New(RefreshInterval) + +
MESSAGEQUEUE:_DisplayMessages() +

This function is called automatically by the MESSAGEQUEUE scheduler.

+
+ +

Global(s)

+
+
+ + #MESSAGE + +MESSAGE + +
+
+ + + +
+
+
+
+ + #MESSAGEQUEUE + +MESSAGEQUEUE + +
+
+ + + +
+
+

Type Message

+ +

Type MESSAGE

+ +

The MESSAGE class

+ +

Field(s)

+
+
+ + #string + +MESSAGE.ClassName + +
+
+ + + +
+
+
+
+ + #number + +MESSAGE.MessageCategory + +
+
+ + + +
+
+
+
+ + #number + +MESSAGE.MessageID + +
+
+ + + +
+
+
+
+ + +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

+
    +
  • + +

    #string MessageText : +is the text of the Message.

    + +
    • +
  • + +

    #string MessageCategory : +is a string expressing the Category of the Message. Messages are grouped on the display panel per Category to improve readability.

    + +
    • +
  • + +

    #number MessageDuration : +is a number in seconds of how long the MESSAGE should be shown on the display panel.

    + +
    • +
  • + +

    #string MessageID : +is a string expressing the ID of the Message.

    + +
    • +
+

Return value

+ +

#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:ToAll() + +
+
+ +

Sends a MESSAGE to all players.

+ +

Return value

+ +

#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()
+ +
+
+
+
+ + +MESSAGE:ToBlue() + +
+
+ +

Sends a MESSAGE to the Blue coalition.

+ +

Return value

+ +

#MESSAGE:

+ + +

Usage:

+ 
-- Send a message created with the @{New} method to the BLUE coalition.
+MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
+or
+MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
+or
+MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
+MessageBLUE:ToBlue()
+ +
+
+
+
+ + +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".

+ +

Parameter

+ +

Return value

+ +

#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.

+ +

Parameter

+
    +
  • + +

    CoalitionSide : +needs to be filled out by the defined structure of the standard scripting engine coalition.side.

    + +
    • +
+

Return value

+ +

#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:ToRed() + +
+
+ +

Sends a MESSAGE to the Red Coalition.

+ +

Return value

+ +

#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" ):ToRed()
+or
+MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
+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:ToRed()
+ +
+
+ +

Type MESSAGEQUEUE

+ +

The MESSAGEQUEUE class

+ +

Field(s)

+
+
+ + + +MESSAGEQUEUE.ClientGroups + +
+
+ + + +
+
+
+
+ + + +MESSAGEQUEUE.CoalitionSides + +
+
+ + + +
+
+
+
+ + +MESSAGEQUEUE:New(RefreshInterval) + +
+
+ + + +

Parameter

+
    +
  • + +

    RefreshInterval :

    + +
    • +
+
+
+
+
+ + +MESSAGEQUEUE:_DisplayMessages() + +
+
+ +

This function is called automatically by the MESSAGEQUEUE scheduler.

+ +
+
+ +
+ +
+ + diff --git a/Documentation/NOTASK.html b/Documentation/NOTASK.html new file mode 100644 index 000000000..c9fbd1694 --- /dev/null +++ b/Documentation/NOTASK.html @@ -0,0 +1,142 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module NOTASK

+ +

A NOTASK is a dummy activity...

+ + +

But it will show a Mission Briefing...

+ +

Global(s)

+ + + + + +
NOTASK + +
+

Type NOTASK

+ + + + + + + + + +
NOTASK.ClassName + +
NOTASK:New() +

Creates a new NOTASK.

+
+ +

Global(s)

+
+
+ + #NOTASK + +NOTASK + +
+
+ + + +
+
+

Type NOTASK

+

Field(s)

+
+
+ + #string + +NOTASK.ClassName + +
+
+ + + +
+
+
+
+ + +NOTASK:New() + +
+
+ +

Creates a new NOTASK.

+ +
+
+ +
+ +
+ + diff --git a/Documentation/PICKUPTASK.html b/Documentation/PICKUPTASK.html new file mode 100644 index 000000000..6e2783533 --- /dev/null +++ b/Documentation/PICKUPTASK.html @@ -0,0 +1,387 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module PICKUPTASK

+ +

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

+ +

Global(s)

+ + + + + +
PICKUPTASK + +
+

Type PICKUPTASK

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PICKUPTASK:AddCargoMenus(Client, Cargos, TransportRadius) + +
PICKUPTASK.ClassName + +
PICKUPTASK:FromZone(LandingZone) + +
PICKUPTASK.GoalVerb + +
PICKUPTASK:HasFailed(ClientDead) + +
PICKUPTASK:InitCargo(InitCargos) + +
PICKUPTASK:LoadCargo(LoadCargos) + +
PICKUPTASK.New(table, CARGO_TYPE, number, self, CargoType, OnBoardSide) +

Creates a new PICKUPTASK.

+
PICKUPTASK:RemoveCargoMenus(Client) + +
PICKUPTASK.TEXT + +
+ +

Global(s)

+
+
+ + #PICKUPTASK + +PICKUPTASK + +
+
+ + + +
+
+

Type PICKUPTASK

+

Field(s)

+
+
+ + +PICKUPTASK:AddCargoMenus(Client, Cargos, TransportRadius) + +
+
+ + + +

Parameters

+
    +
  • + +

    Client :

    + +
    • +
  • + +

    Cargos :

    + +
    • +
  • + +

    TransportRadius :

    + +
    • +
+
+
+
+
+ + #string + +PICKUPTASK.ClassName + +
+
+ + + +
+
+
+
+ + +PICKUPTASK:FromZone(LandingZone) + +
+
+ + + +

Parameter

+
    +
  • + +

    LandingZone :

    + +
    • +
+
+
+
+
+ + #string + +PICKUPTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +PICKUPTASK:HasFailed(ClientDead) + +
+
+ + + +

Parameter

+
    +
  • + +

    ClientDead :

    + +
    • +
+
+
+
+
+ + +PICKUPTASK:InitCargo(InitCargos) + +
+
+ + + +

Parameter

+
    +
  • + +

    InitCargos :

    + +
    • +
+
+
+
+
+ + +PICKUPTASK:LoadCargo(LoadCargos) + +
+
+ + + +

Parameter

+
    +
  • + +

    LoadCargos :

    + +
    • +
+
+
+
+
+ + +PICKUPTASK.New(table, CARGO_TYPE, number, self, CargoType, OnBoardSide) + +
+
+ +

Creates a new PICKUPTASK.

+ +

Parameters

+
    +
  • + +

    table : +string,...}|string LandingZones Table of Zone names where Cargo is to be loaded.

    + +
    • +
  • + +

    CARGO_TYPE : +CargoType Type of the Cargo. The type must be of the following Enumeration:..

    + +
    • +
  • + +

    number : +OnBoardSide Reflects from which side the cargo Group will be on-boarded on the Carrier.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    CargoType :

    + +
    • +
  • + +

    OnBoardSide :

    + +
    • +
+
+
+
+
+ + +PICKUPTASK:RemoveCargoMenus(Client) + +
+
+ + + +

Parameter

+
    +
  • + +

    Client :

    + +
    • +
+
+
+
+
+ + + +PICKUPTASK.TEXT + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Documentation/ROUTETASK.html b/Documentation/ROUTETASK.html new file mode 100644 index 000000000..f91dc77ba --- /dev/null +++ b/Documentation/ROUTETASK.html @@ -0,0 +1,194 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module ROUTETASK

+ +

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

+ +

Global(s)

+ + + + + +
ROUTETASK + +
+

Type ROUTETASK

+ + + + + + + + + + + + + +
ROUTETASK.ClassName + +
ROUTETASK.GoalVerb + +
ROUTETASK.New(table, string, self, LandingZones, TaskBriefing) +

Creates a new ROUTETASK.

+
+ +

Global(s)

+
+
+ + #ROUTETASK + +ROUTETASK + +
+
+ + + +
+
+

Type ROUTETASK

+

Field(s)

+
+
+ + #string + +ROUTETASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +ROUTETASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +ROUTETASK.New(table, string, self, LandingZones, TaskBriefing) + +
+
+ +

Creates a new ROUTETASK.

+ +

Parameters

+
    +
  • + +

    table : +sring,...}|string LandingZones Table of Zone Names where the target is located.

    + +
    • +
  • + +

    string : +TaskBriefing (optional) Defines a text describing the briefing of the task.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    LandingZones :

    + +
    • +
  • + +

    TaskBriefing :

    + +
    • +
+

Return value

+ + +

ROUTETASK

+ +
+
+ +
+ +
+ + diff --git a/Documentation/STAGE.html b/Documentation/STAGE.html new file mode 100644 index 000000000..4007d83f2 --- /dev/null +++ b/Documentation/STAGE.html @@ -0,0 +1,806 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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.

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CargoStatic + +
STAGE + +
STAGEARRIVE + +
STAGEBRIEF + +
STAGEDONE + +
STAGEGROUPSDESTROYED + +
STAGELANDED + +
STAGELANDING + +
STAGELOAD + +
STAGEROUTE + +
STAGESTART + +
STAGEUNLOAD + +
STAGE_CARGO_INIT + +
STAGE_CARGO_LOAD + +
_TransportStage + +
_TransportStageAction + +
_TransportStageTime + +
+

Type STAGE

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
STAGE.ClassName + +
STAGE:Execute(Mission, Client, Task) + +
STAGE:Executing(Mission, Client, Task) + +
STAGE.FREQUENCY + +
STAGE.Frequency + +
STAGE.MSG + +
STAGE.MessageCount + +
STAGE.MessageFlash + +
STAGE.MessageInterval + +
STAGE.MessageShow + +
STAGE.MessageShown + +
STAGE.Name + +
STAGE:New() + +
STAGE.StageType + +
STAGE:Validate(Mission, Client, Task) + +
STAGE.WaitTime + +
+ +

Global(s)

+
+
+ + + +CargoStatic + +
+
+ + + +
+
+
+
+ + #STAGE + +STAGE + +
+
+ + + +
+
+
+
+ + + +STAGEARRIVE + +
+
+ + + +
+
+
+
+ + + +STAGEBRIEF + +
+
+ + + +
+
+
+
+ + + +STAGEDONE + +
+
+ + + +
+
+
+
+ + + +STAGEGROUPSDESTROYED + +
+
+ + + +
+
+
+
+ + + +STAGELANDED + +
+
+ + + +
+
+
+
+ + + +STAGELANDING + +
+
+ + + +
+
+
+
+ + + +STAGELOAD + +
+
+ + + +
+
+
+
+ + + +STAGEROUTE + +
+
+ + + +
+
+
+
+ + + +STAGESTART + +
+
+ + + +
+
+
+
+ + + +STAGEUNLOAD + +
+
+ + + +
+
+
+
+ + + +STAGE_CARGO_INIT + +
+
+ + + +
+
+
+
+ + + +STAGE_CARGO_LOAD + +
+
+ + + +
+
+
+
+ + + +_TransportStage + +
+
+ + + + +

_TransportStage: Defines the different stages of which of transport missions can be in. This table is internal and is used to control the sequence of messages, actions and flow.

+ +
    +
  • _TransportStage.START
    • +
  • _TransportStage.ROUTE
    • +
  • _TransportStage.LAND
    • +
  • _TransportStage.EXECUTE
    • +
  • _TransportStage.DONE
    • +
  • _TransportStage.REMOVE + --
    • +
+ +
+
+
+
+ + + +_TransportStageAction + +
+
+ + + +
+
+
+
+ + + +_TransportStageTime + +
+
+ + + +
+
+

Type STAGE

+

Field(s)

+
+
+ + #string + +STAGE.ClassName + +
+
+ + + +
+
+
+
+ + +STAGE:Execute(Mission, Client, Task) + +
+
+ + + +

Parameters

+
    +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
  • + +

    Task :

    + +
    • +
+
+
+
+
+ + +STAGE:Executing(Mission, Client, Task) + +
+
+ + + +

Parameters

+
    +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
  • + +

    Task :

    + +
    • +
+
+
+
+
+ + + +STAGE.FREQUENCY + +
+
+ + + +
+
+
+
+ + #number + +STAGE.Frequency + +
+
+ + + +
+
+
+
+ + + +STAGE.MSG + +
+
+ + + +
+
+
+
+ + #number + +STAGE.MessageCount + +
+
+ + + +
+
+
+
+ + #boolean + +STAGE.MessageFlash + +
+
+ + + +
+
+
+
+ + #number + +STAGE.MessageInterval + +
+
+ + + +
+
+
+
+ + #boolean + +STAGE.MessageShow + +
+
+ + + +
+
+
+
+ + + +STAGE.MessageShown + +
+
+ + + +
+
+
+
+ + #string + +STAGE.Name + +
+
+ + + +
+
+
+
+ + +STAGE:New() + +
+
+ + + +
+
+
+
+ + #string + +STAGE.StageType + +
+
+ + + +
+
+
+
+ + +STAGE:Validate(Mission, Client, Task) + +
+
+ + + +

Parameters

+
    +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
  • + +

    Task :

    + +
    • +
+
+
+
+
+ + #number + +STAGE.WaitTime + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Documentation/Sead.html b/Documentation/Sead.html new file mode 100644 index 000000000..625a35b22 --- /dev/null +++ b/Documentation/Sead.html @@ -0,0 +1,247 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Sead

+ +

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

+ +

Global(s)

+ + + + + +
SEAD + +
+

Type SEAD

+ + + + + + + + + + + + + + + + + + + + + +
SEAD.ClassName + +
SEAD:EventShot(event) +

Detects if an SA site was shot with an anti radiation missile.

+
SEAD.New(table, self, SEADGroupPrefixes) +

Creates the main object which is handling defensive actions for SA sites or moving SA vehicles.

+
SEAD.SEADGroupPrefixes + +
SEAD.TargetSkill + +
+ +

Global(s)

+
+
+ + #SEAD + +SEAD + +
+
+ + + +
+
+

Type Sead

+ +

Type SEAD

+ +

The SEAD class

+ +

Field(s)

+
+
+ + #string + +SEAD.ClassName + +
+
+ + + +
+
+
+
+ + +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.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +SEAD.New(table, self, 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

+
    +
  • + +

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

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SEADGroupPrefixes :

    + +
    • +
+

Return value

+ + +

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.SEADGroupPrefixes + +
+
+ + + +
+
+
+
+ + + +SEAD.TargetSkill + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Documentation/Spawn.html b/Documentation/Spawn.html new file mode 100644 index 000000000..88743780c --- /dev/null +++ b/Documentation/Spawn.html @@ -0,0 +1,1773 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Spawn

+ +

Dynamic spawning of groups (and units).

+ + +

The SPAWN class allows to spawn dynamically new groups, based on pre-defined initialization settings, modifying the behaviour when groups are spawned. +For each group to be spawned, within the mission editor, a group has to be created with the "late activation flag" set. We call this group the "Spawn Template" of the SPAWN object. +A reference to this Spawn Template needs to be provided when constructing the SPAWN object, by indicating the name of the group within the mission editor in the constructor methods.

+ +

Within the SPAWN object, there is an internal index that keeps track of which group from the internal group list was spawned. +When new groups get spawned by using the SPAWN functions (see below), it will be validated whether the Limits (SPAWN.Limit) of the SPAWN object are not reached. +When all is valid, a new group will be created by the spawning methods, and the internal index will be increased with 1.

+ +

Regarding the name of new spawned groups, a SpawnPrefix will be assigned for each new group created. +If you want to have the Spawn Template name to be used as the SpawnPrefix name, use the SPAWN.New constructor. +However, when the SPAWN.NewWithAlias constructor was used, the Alias name will define the SpawnPrefix name. +Groups will follow the following naming structure when spawned at run-time:

+ +
    +
  1. Spawned groups will have the name SpawnPrefix#ggg, where ggg is a counter from 0 to 999.
    2. +
  2. Spawned units will have the name SpawnPrefix#ggg-uu, where uu is a counter from 0 to 99 for each new spawned unit belonging to the group.
    3. +
+ +

Some additional notes that need to be remembered:

+ +
    +

  • Templates are actually groups defined within the mission editor, with the flag "Late Activation" set. As such, these groups are never used within the mission, but are used by the #SPAWN module.

    • +

  • It is important to defined BEFORE you spawn new groups, a proper initialization of the SPAWN instance is done with the options you want to use.

    • +

  • When designing a mission, NEVER name groups using a "#" within the name of the group Spawn Template(s), or the SPAWN module logic won't work anymore.

    • +

  • SPAWN object construction methods:

    +

    Create a new SPAWN object with the SPAWN.New or the SPAWN.NewWithAlias methods:

    • +

  • SPAWN.New: Creates a new SPAWN object taking the name of the group that functions as the Template.

    • +
+ +

It is important to understand how the SPAWN class works internally. The SPAWN object created will contain internally a list of groups that will be spawned and that are already spawned. +The initialization functions will modify this list of groups so that when a group gets spawned, ALL information is already prepared when spawning. This is done for performance reasons. +So in principle, the group list will contain all parameters and configurations after initialization, and when groups get actually spawned, this spawning can be done quickly and efficient.

+ +
    +

  1. SPAWN object initialization methods:

    +

    A spawn object will behave differently based on the usage of initialization methods:

    2. +

  2. SPAWN.Limit: Limits the amount of groups that can be alive at the same time and that can be dynamically spawned.

    3. +

  3. SPAWN.RandomizeRoute: Randomize the routes of spawned groups.

    4. +

  4. SPAWN.RandomizeTemplate: Randomize the group templates so that when a new group is spawned, a random group template is selected from one of the templates defined.

    5. +

  5. SPAWN.Uncontrolled: Spawn plane groups uncontrolled.

    6. +

  6. SPAWN.Array: Make groups visible before they are actually activated, and order these groups like a batallion in an array.

    7. +

  7. SPAWN.Repeat: Re-spawn groups when they land at the home base. Similar functions are SPAWN.RepeatOnLanding and SPAWN.RepeatOnEngineShutDown.

    8. +

  8. SPAWN object spawning methods:

    +

    Groups can be spawned at different times and methods:

    9. +

  9. SPAWN.Spawn: Spawn one new group based on the last spawned index.

    10. +

  10. SPAWN.ReSpawn: Re-spawn a group based on a given index.

    11. +

  11. SPAWN.SpawnScheduled: Spawn groups at scheduled but randomized intervals. You can use SPAWN.SpawnScheduleStart and SPAWN.SpawnScheduleStop to start and stop the schedule respectively.

    12. +

  12. SPAWN.SpawnFromUnit: Spawn a new group taking the position of a UNIT.

    13. +

  13. SPAWN.SpawnInZone: Spawn a new group in a ZONE.

    14. +
+ +

Note that SPAWN.Spawn and SPAWN.ReSpawn return a GROUP#GROUP.New object, that contains a reference to the DCSGroup object. +You can use the GROUP object to do further actions with the DCSGroup.

+ +
    +
  1. SPAWN object cleaning: +
    + Sometimes, it will occur during a mission run-time, that ground or especially air objects get damaged, and will while being damged stop their activities, while remaining alive. + In such cases, the SPAWN object will just sit there and wait until that group gets destroyed, but most of the time it won't, + and it may occur that no new groups are or can be spawned as limits are reached. + To prevent this, a SPAWN.CleanUp initialization method has been defined that will silently monitor the status of each spawned group. + Once a group has a velocity = 0, and has been waiting for a defined interval, that group will be cleaned or removed from run-time. + There is a catch however :-) If a damaged group has returned to an airbase within the coalition, that group will not be considered as "lost"... + In such a case, when the inactive group is cleaned, a new group will Re-spawned automatically. + This models AI that has succesfully returned to their airbase, to restart their combat activities. + Check the SPAWN.CleanUp for further info.
    2. +
+ + +

Global(s)

+ + + + + +
SPAWN + +
+

Type SPAWN

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SPAWN:Array(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY) +

Makes the groups visible before start (like a batallion).

+
SPAWN.ClassName + +
SPAWN:CleanUp(SpawnCleanUpInterval) +

CleanUp groups when they are still alive, but inactive.

+
SPAWN:GetFirstAliveGroup(SpawnCursor) +

Find the first alive group.

+
SPAWN:GetGroupFromIndex(SpawnIndex) +

Get the group from an index.

+
SPAWN:GetLastAliveGroup() +

Find the last alive group during runtime.

+
SPAWN:GetNextAliveGroup(SpawnCursor) +

Find the next alive group.

+
SPAWN:GetSpawnIndexFromGroup(SpawnGroup) +

Get the index from a given group.

+
SPAWN:Limit(SpawnMaxUnitsAlive, SpawnMaxGroups) +

Limits the Maximum amount of Units that can be alive at the same time, and the maximum amount of groups that can be spawned.

+
SPAWN:New(SpawnTemplatePrefix) +

Creates the main object to spawn a GROUP defined in the DCS ME.

+
SPAWN:NewWithAlias(SpawnTemplatePrefix, SpawnAliasPrefix) +

Creates a new SPAWN instance to create new groups based on the defined template and using a new alias for each new group.

+
SPAWN:RandomizeRoute(SpawnStartPoint, SpawnEndPoint, SpawnRadius) +

Randomizes the defined route of the SpawnTemplatePrefix group in the ME.

+
SPAWN:RandomizeTemplate(SpawnTemplatePrefixTable) +

This function is rather complicated to understand.

+
SPAWN:ReSpawn(SpawnIndex) +

Will re-spawn a group based on a given index.

+
SPAWN:Repeat() +

For planes and helicopters, when these groups 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 runtime environment.

+
SPAWN:RepeatOnEngineShutDown() +

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

+
SPAWN:RepeatOnLanding() + +
SPAWN:Spawn() +

Will re-spawn a group based on a given index.

+
SPAWN:SpawnFromUnit(HostUnit, OuterRadius, InnerRadius, SpawnIndex) +

Will spawn a group from a hosting unit.

+
SPAWN:SpawnGroupName(SpawnIndex) +

Will return the SpawnGroupName either with with a specific count number or without any count.

+
SPAWN:SpawnInZone(Zone, SpawnIndex) +

Will spawn a Group within a given ZONE.

+
SPAWN:SpawnScheduleStart() +

Will start the spawning scheduler.

+
SPAWN:SpawnScheduleStop() +

Will stop the scheduled spawning scheduler.

+
SPAWN:SpawnScheduled(SpawnTime, SpawnTimeVariation) +

Spawns new groups at varying time intervals.

+
SPAWN:SpawnWithIndex(SpawnIndex) +

Will spawn a group with a specified index number.

+
SPAWN:UnControlled() +

Will spawn a plane group in uncontrolled mode...

+
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:_GetGroupFromDCSUnit(DCSUnit) +

Return the group within the SpawnGroups collection with input a DCSUnit.

+
SPAWN:_GetGroupIndexFromDCSUnit(DCSUnit) +

Get the group index from a DCSUnit.

+
SPAWN:_GetLastIndex() +

Return the last maximum index that can be used.

+
SPAWN:_GetPrefixFromDCSUnit(DCSUnit) +

Return the prefix of a DCSUnit.

+
SPAWN:_GetSpawnIndex(SpawnIndex) +

Get the next index of the groups to be spawned.

+
SPAWN:_GetTemplate(SpawnTemplatePrefix) +

Gets the Group Template from the ME environment definition.

+
SPAWN:_InitializeSpawnGroups(SpawnIndex) +

Initalize the SpawnGroups collection.

+
SPAWN:_OnBirth(event) + +
SPAWN:_OnDeadOrCrash(event) +

Obscolete

+
SPAWN:_OnLand(event) +

Will detect AIR Units landing...

+
SPAWN:_OnTakeOff(event) +

Will detect AIR Units taking off...

+
SPAWN:_Prepare(SpawnTemplatePrefix, SpawnIndex) +

Prepares the new Group Template.

+
SPAWN:_RandomizeRoute(SpawnIndex) +

Internal function randomizing the routes.

+
SPAWN:_RandomizeTemplate(SpawnIndex) + +
SPAWN:_Scheduler() +

This function is called automatically by the Spawning scheduler.

+
SPAWN:_SpawnCleanUpScheduler() + +
SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) + +
+ +

Global(s)

+
+
+ + #SPAWN + +SPAWN + +
+
+ + + +
+
+

Type Spawn

+ +

Type SPAWN

+ +

SPAWN Class

+ +

Field(s)

+
+
+ + +SPAWN:Array(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY) + +
+
+ +

Makes the groups visible before start (like a batallion).

+ + +

The method will take the position of the group as the first position in the array.

+ +

Parameters

+
    +
  • + +

    #number SpawnAngle :

    +
        The angle in degrees how the groups and each unit of the group will be positioned.
+
    + +
    • +
  • + +

    #number SpawnWidth :

    +
         The amount of Groups that will be positioned on the X axis.
+
    + +
    • +
  • + +

    #number SpawnDeltaX :

    +
       The space between each Group on the X-axis.
+
    + +
    • +
  • + +

    #number SpawnDeltaY :

    +
         The space between each Group on the Y-axis.
+
    + +
    • +
+

Return value

+ +

#SPAWN: +self

+ +

Usage:

+ 
-- Define an array of Groups.
+Spawn_BE_Ground = SPAWN:New( 'BE Ground' ):Limit( 2, 24 ):Visible( 90, "Diamond", 10, 100, 50 )
+ +
+
+
+
+ + +SPAWN.ClassName + +
+
+ + + +
+
+
+
+ + +SPAWN:CleanUp(SpawnCleanUpInterval) + +
+
+ +

CleanUp groups when they are still alive, but inactive.

+ + +

When groups are still alive and have become inactive due to damage and are unable to contribute anything, then this group will be removed at defined intervals in seconds.

+ +

Parameter

+
    +
  • + +

    #string SpawnCleanUpInterval : +The interval to check for inactive groups within seconds.

    + +
    • +
+

Return value

+ +

#SPAWN: +self

+ +

Usage:

+ 
Spawn_Helicopter:CleanUp( 20 )  -- CleanUp the spawning of the helicopters every 20 seconds when they become inactive.
+ +
+
+
+
+ + +SPAWN:GetFirstAliveGroup(SpawnCursor) + +
+
+ +

Find the first alive group.

+ +

Parameter

+
    +
  • + +

    #number SpawnCursor : +A number holding the index from where to find the first group from.

    + +
    • +
+

Return values

+
    +
  1. + +

    GROUP#GROUP, #number: +The group found, the new index where the group was found.

    + +
    2. +
  2. + +

    #nil, #nil: +When no group is found, #nil is returned.

    + +
    3. +
+
+
+
+
+ + +SPAWN:GetGroupFromIndex(SpawnIndex) + +
+
+ +

Get the group from an index.

+ + +

Returns the group from the SpawnGroups list. +If no index is given, it will return the first group in the list.

+ +

Parameter

+
    +
  • + +

    #number SpawnIndex : +The index of the group to return.

    + +
    • +
+

Return value

+ +

GROUP#GROUP:

+ + +
+
+
+
+ + +SPAWN:GetLastAliveGroup() + +
+
+ +

Find the last alive group during runtime.

+ +
+
+
+
+ + +SPAWN:GetNextAliveGroup(SpawnCursor) + +
+
+ +

Find the next alive group.

+ +

Parameter

+
    +
  • + +

    #number SpawnCursor : +A number holding the last found previous index.

    + +
    • +
+

Return values

+
    +
  1. + +

    GROUP#GROUP, #number: +The group found, the new index where the group was found.

    + +
    2. +
  2. + +

    #nil, #nil: +When no group is found, #nil is returned.

    + +
    3. +
+
+
+
+
+ + +SPAWN:GetSpawnIndexFromGroup(SpawnGroup) + +
+
+ +

Get the index from a given group.

+ + +

The function will search the name of the group for a #, and will return the number behind the #-mark.

+ +

Parameter

+
    +
  • + +

    SpawnGroup :

    + +
    • +
+
+
+
+
+ + +SPAWN:Limit(SpawnMaxUnitsAlive, SpawnMaxGroups) + +
+
+ +

Limits the Maximum amount of Units that can be alive at the same time, and the maximum amount of groups that can be spawned.

+ + +

Note that this method is exceptionally important to balance 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... +When a SPAWN.New is executed and the limit of the amount of units alive is reached, then no new spawn will happen of the group, until some of these units of the spawn object will be destroyed.

+ +

Parameters

+
    +
  • + +

    #number SpawnMaxUnitsAlive : +The maximum amount of units that can be alive at runtime.

    + +
    • +
  • + +

    #number SpawnMaxGroups : +The maximum amount of groups that can be spawned. When the limit is reached, then no more actual 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 defines that there are no maximum group limits, but there are limits on the maximum of units that can be alive at the same time.

    + +
    • +
+

Return value

+ +

#SPAWN: +self

+ +

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:New(SpawnTemplatePrefix) + +
+
+ +

Creates the main object to spawn a GROUP defined in the DCS ME.

+ +

Parameter

+
    +
  • + +

    #string SpawnTemplatePrefix : +is the name of the Group in the ME that defines the Template. Each new group will have the name starting with SpawnTemplatePrefix.

    + +
    • +
+

Return value

+ +

#SPAWN:

+ + +

Usages:

+
    + 
  • -- NATO helicopters engaging in the battle field.
+Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' )
    • + 
  • local Plane = SPAWN:New( "Plane" ) -- Creates a new local variable that can initiate new planes with the name "Plane#ddd" using the template "Plane" as defined within the ME.
    • +
+ +
+
+
+
+ + +SPAWN:NewWithAlias(SpawnTemplatePrefix, SpawnAliasPrefix) + +
+
+ +

Creates a new SPAWN instance to create new groups based on the defined template and using a new alias for each new group.

+ +

Parameters

+
    +
  • + +

    #string SpawnTemplatePrefix : +is the name of the Group in the ME that defines the Template.

    + +
    • +
  • + +

    #string SpawnAliasPrefix : +is the name that will be given to the Group at runtime.

    + +
    • +
+

Return value

+ +

#SPAWN:

+ + +

Usages:

+
    + 
  • -- NATO helicopters engaging in the battle field.
+Spawn_BE_KA50 = SPAWN:NewWithAlias( 'BE KA-50@RAMP-Ground Defense', 'Helicopter Attacking a City' )
    • + 
  • local PlaneWithAlias = SPAWN:NewWithAlias( "Plane", "Bomber" ) -- Creates a new local variable that can instantiate new planes with the name "Bomber#ddd" using the template "Plane" as defined within the ME.
    • +
+ +
+
+
+
+ + +SPAWN:RandomizeRoute(SpawnStartPoint, SpawnEndPoint, SpawnRadius) + +
+
+ +

Randomizes the defined route of the SpawnTemplatePrefix group in the ME.

+ + +

This is very useful to define extra variation of the behaviour of groups.

+ +

Parameters

+
    +
  • + +

    #number SpawnStartPoint : +is the waypoint where the randomization begins. +Note that the StartPoint = 0 equaling the point where the group is spawned.

    + +
    • +
  • + +

    #number SpawnEndPoint : +is the waypoint where the randomization ends counting backwards. +This parameter is useful to avoid randomization to end at a waypoint earlier than the last waypoint on the route.

    + +
    • +
  • + +

    #number SpawnRadius : +is the radius in meters in which the randomization of the new waypoints, with the original waypoint of the original template located in the middle ...

    + +
    • +
+

Return value

+ +

#SPAWN:

+ + +

Usage:

+ 
-- NATO helicopters engaging in the battle field. 
+-- The KA-50 has waypoints Start point ( =0 or SP ), 1, 2, 3, 4, End point (= 5 or 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 radius of 2000 meters.
+Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):RandomizeRoute( 2, 2, 2000 )
+ +
+
+
+
+ + +SPAWN:RandomizeTemplate(SpawnTemplatePrefixTable) + +
+
+ +

This function is rather complicated to understand.

+ + +

But I'll try to explain. +This function becomes useful when you need to spawn groups with random templates of groups defined within the mission editor, +but they will all follow the same Template route and have the same prefix name. +In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.

+ +

Parameter

+
    +
  • + +

    #string SpawnTemplatePrefixTable : +A table with the names of the groups defined within the mission editor, from which one will be choosen when a new group will be spawned.

    + +
    • +
+

Return value

+ +

#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' SpawnTemplatePrefixes.
+-- 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:ReSpawn(SpawnIndex) + +
+
+ +

Will re-spawn a group based on a given index.

+ + +

Note: Uses DATABASE module defined in MOOSE.

+ +

Parameter

+
    +
  • + +

    #string SpawnIndex : +The index of the group to be spawned.

    + +
    • +
+

Return value

+ +

GROUP#GROUP: +The group that was spawned. You can use this group for further actions.

+ +
+
+
+
+ + +SPAWN:Repeat() + +
+
+ +

For planes and helicopters, when these groups 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 runtime environment.

+ + +

This function is used to re-spawn automatically (so no extra call is needed anymore) the same group after it has 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 re-spawn from the original airbase where it took off. +So ensure that the routes for groups that respawn, always return to the original airbase, or players may get confused ...

+ +

Return value

+ +

#SPAWN: +self

+ +

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:RepeatOnEngineShutDown() + +
+
+ +

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

+ +

Return value

+ + +

SPAWN

+ +
+
+
+
+ + +SPAWN:RepeatOnLanding() + +
+
+ + + +
+
+
+
+ + +SPAWN:Spawn() + +
+
+ +

Will re-spawn a group based on a given index.

+ + +

Note: Uses DATABASE module defined in MOOSE.

+ +

Return value

+ +

GROUP#GROUP: +The group that was spawned. You can use this group for further actions.

+ +
+
+
+
+ + +SPAWN:SpawnFromUnit(HostUnit, OuterRadius, InnerRadius, SpawnIndex) + +
+
+ +

Will spawn a group from a hosting unit.

+ + +

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. +Note that each point in the route assigned to the spawning group is reset to the point of the spawn. +You can use the returned group to further define the route to be followed.

+ +

Parameters

+
    +
  • + +

    Unit#UNIT HostUnit : +The air or ground unit dropping or unloading the group.

    + +
    • +
  • + +

    #number OuterRadius : +The outer radius in meters where the new group will be spawned.

    + +
    • +
  • + +

    #number InnerRadius : +The inner radius in meters where the new group will NOT be spawned.

    + +
    • +
  • + +

    #number SpawnIndex : +(Optional) The index which group to spawn within the given zone.

    + +
    • +
+

Return values

+
    +
  1. + +

    Group#GROUP: +that was spawned.

    + +
    2. +
  2. + +

    #nil: +Nothing was spawned.

    + +
    3. +
+
+
+
+
+ + +SPAWN:SpawnGroupName(SpawnIndex) + +
+
+ +

Will return the SpawnGroupName either with with a specific count number or without any count.

+ +

Parameter

+
    +
  • + +

    #number SpawnIndex : +Is the number of the Group that is to be spawned.

    + +
    • +
+

Return value

+ + +

string SpawnGroupName

+ +
+
+
+
+ + +SPAWN:SpawnInZone(Zone, SpawnIndex) + +
+
+ +

Will spawn a Group within a given ZONE.

+ +

Parameters

+
    +
  • + +

    #ZONE Zone : +The zone where the group is to be spawned.

    + +
    • +
  • + +

    #number SpawnIndex : +(Optional) The index which group to spawn within the given zone.

    + +
    • +
+

Return values

+
    +
  1. + +

    GROUP#GROUP: +that was spawned.

    + +
    2. +
  2. + +

    #nil: +when nothing was spawned.

    + +
    3. +
+
+
+
+
+ + +SPAWN:SpawnScheduleStart() + +
+
+ +

Will start the spawning scheduler.

+ + +

Note: This function is called automatically when SPAWN.Scheduled is called.

+ +
+
+
+
+ + +SPAWN:SpawnScheduleStop() + +
+
+ +

Will stop the scheduled spawning scheduler.

+ +
+
+
+
+ + +SPAWN:SpawnScheduled(SpawnTime, SpawnTimeVariation) + +
+
+ +

Spawns new groups at 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

+
    +
  • + +

    #number SpawnTime : +The time interval defined in seconds between each new spawn of new groups.

    + +
    • +
  • + +

    #number SpawnTimeVariation : +The variation to be applied on the defined time interval between each new spawn. +The variation is a number between 0 and 1, representing the %-tage of variation to be applied on the time interval.

    + +
    • +
+

Return value

+ +

#SPAWN: +self

+ +

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:SpawnWithIndex(SpawnIndex) + +
+
+ +

Will spawn a group with a specified index number.

+ + +

Uses DATABASE global object defined in MOOSE.

+ +

Parameter

+
    +
  • + +

    SpawnIndex :

    + +
    • +
+

Return value

+ +

GROUP#GROUP: +The group that was spawned. You can use this group for further actions.

+ +
+
+
+
+ + +SPAWN:UnControlled() + +
+
+ +

Will spawn a plane group in uncontrolled mode...

+ + +

This will be similar to the uncontrolled flag setting in the ME.

+ +

Return value

+ +

#SPAWN: +self

+ +
+
+
+
+ + +SPAWN:_GetGroupCategoryID(SpawnPrefix) + +
+
+ +

Gets the CategoryID of the Group with the given SpawnPrefix

+ +

Parameter

+
    +
  • + +

    SpawnPrefix :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetGroupCoalitionID(SpawnPrefix) + +
+
+ +

Gets the CoalitionID of the Group with the given SpawnPrefix

+ +

Parameter

+
    +
  • + +

    SpawnPrefix :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetGroupCountryID(SpawnPrefix) + +
+
+ +

Gets the CountryID of the Group with the given SpawnPrefix

+ +

Parameter

+
    +
  • + +

    SpawnPrefix :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetGroupFromDCSUnit(DCSUnit) + +
+
+ +

Return the group within the SpawnGroups collection with input a DCSUnit.

+ +

Parameter

+
    +
  • + +

    DCSUnit :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetGroupIndexFromDCSUnit(DCSUnit) + +
+
+ +

Get the group index from a DCSUnit.

+ + +

The method will search for a #-mark, and will return the index behind the #-mark of the DCSUnit. +It will return nil of no prefix was found.

+ +

Parameter

+
    +
  • + +

    DCSUnit : +The DCS unit to be searched.

    + +
    • +
+

Return values

+
    +
  1. + +

    #string: +The prefix

    + +
    2. +
  2. + +

    #nil: +Nothing found

    + +
    3. +
+
+
+
+
+ + +SPAWN:_GetLastIndex() + +
+
+ +

Return the last maximum index that can be used.

+ +
+
+
+
+ + +SPAWN:_GetPrefixFromDCSUnit(DCSUnit) + +
+
+ +

Return the prefix of a DCSUnit.

+ + +

The method will search for a #-mark, and will return the text before the #-mark. +It will return nil of no prefix was found.

+ +

Parameter

+
    +
  • + +

    DCSUnit : +The DCS unit to be searched.

    + +
    • +
+

Return values

+
    +
  1. + +

    #string: +The prefix

    + +
    2. +
  2. + +

    #nil: +Nothing found

    + +
    3. +
+
+
+
+
+ + +SPAWN:_GetSpawnIndex(SpawnIndex) + +
+
+ +

Get the next index of the groups to be spawned.

+ + +

This function is complicated, as it is used at several spaces.

+ +

Parameter

+
    +
  • + +

    SpawnIndex :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetTemplate(SpawnTemplatePrefix) + +
+
+ +

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.

+ +

Parameter

+
    +
  • + +

    SpawnTemplatePrefix :

    + +
    • +
+
+
+
+
+ + +SPAWN:_InitializeSpawnGroups(SpawnIndex) + +
+
+ +

Initalize the SpawnGroups collection.

+ +

Parameter

+
    +
  • + +

    SpawnIndex :

    + +
    • +
+
+
+
+
+ + +SPAWN:_OnBirth(event) + +
+
+ + + + +

TODO Need to delete this... _Database does this now ...

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +SPAWN:_OnDeadOrCrash(event) + +
+
+ +

Obscolete

+ +

Parameter

+
    +
  • + +

    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.

+ +

Parameter

+
    +
  • + +

    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.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +SPAWN:_Prepare(SpawnTemplatePrefix, SpawnIndex) + +
+
+ +

Prepares the new Group Template.

+ +

Parameters

+
    +
  • + +

    SpawnTemplatePrefix :

    + +
    • +
  • + +

    SpawnIndex :

    + +
    • +
+
+
+
+
+ + +SPAWN:_RandomizeRoute(SpawnIndex) + +
+
+ +

Internal function randomizing the routes.

+ +

Parameter

+
    +
  • + +

    #number SpawnIndex : +The index of the group to be spawned.

    + +
    • +
+

Return value

+ +

#SPAWN:

+ + +
+
+
+
+ + +SPAWN:_RandomizeTemplate(SpawnIndex) + +
+
+ + + +

Parameter

+
    +
  • + +

    SpawnIndex :

    + +
    • +
+
+
+
+
+ + +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.

+ +
+
+
+
+ + +SPAWN:_SpawnCleanUpScheduler() + +
+
+ + + +
+
+
+
+ + +SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) + +
+
+ + + +

Parameters

+
    +
  • + +

    SpawnIndex :

    + +
    • +
  • + +

    SpawnRootX :

    + +
    • +
  • + +

    SpawnRootY :

    + +
    • +
  • + +

    SpawnX :

    + +
    • +
  • + +

    SpawnY :

    + +
    • +
  • + +

    SpawnAngle :

    + +
    • +
+
+
+ +

Type ZONE

+ +
+ +
+ + diff --git a/Documentation/StaticObject.html b/Documentation/StaticObject.html new file mode 100644 index 000000000..7851f3a23 --- /dev/null +++ b/Documentation/StaticObject.html @@ -0,0 +1,239 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module StaticObject

+ + + +

Global(s)

+ + + + + +
StaticObject + +
+

Type StaticObject

+ + + + + + + + + + + + + + + + + + + + + +
StaticObject.Desc +

Descriptor of StaticObject and Unit are equal. StaticObject is just a passive variant of Unit.

+
StaticObject.ID +

Identifier of a StaticObject. It assigned to an StaticObject by the Mission Editor automatically.

+
StaticObject.getByName(name) +

Returns static object by its name.

+
StaticObject:getDesc() +

Returns descriptor of the StaticObject.

+
StaticObject:getID() +

returns identifier of the static object.

+
+ +

Global(s)

+
+
+ + #StaticObject + +StaticObject + +
+
+ + + +
+
+

Type DCSStaticObject

+ +

Type StaticObject

+ +

Represents static object added in the Mission Editor.

+ +

Field(s)

+
+
+ + #StaticObject.Desc + +StaticObject.Desc + +
+
+ +

Descriptor of StaticObject and Unit are equal. StaticObject is just a passive variant of Unit.

+ +
+
+
+
+ + #StaticObject.ID + +StaticObject.ID + +
+
+ +

Identifier of a StaticObject. It assigned to an StaticObject by the Mission Editor automatically.

+ +
+
+
+
+ + +StaticObject.getByName(name) + +
+
+ +

Returns static object by its name.

+ + +

If no static object found nil will be returned.

+ +

Parameter

+
    +
  • + +

    #string name : +Name of static object to find.

    + +
    • +
+

Return value

+ +

#StaticObject:

+ + +
+
+
+
+ + +StaticObject:getDesc() + +
+
+ +

Returns descriptor of the StaticObject.

+ +

Return value

+ +

#StaticObject.Desc:

+ + +
+
+
+
+ + +StaticObject:getID() + +
+
+ +

returns identifier of the static object.

+ +

Return value

+ +

#StaticObject.ID:

+ + +
+
+ +

Type StaticObject.Desc

+ +

StaticObject descriptor.

+ + +

Airdromes are unique and their types are unique, but helipads and ships are not always unique and may have the same type.

+ + +

Type StaticObject.ID

+ +
+ +
+ + diff --git a/Documentation/TASK.html b/Documentation/TASK.html new file mode 100644 index 000000000..38a0ede12 --- /dev/null +++ b/Documentation/TASK.html @@ -0,0 +1,1667 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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.

+ +

Global(s)

+ + + + + +
TASK + +
+

Type TASK

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TASK.ActiveStage + +
TASK.AddFlareBlue(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a BLUE FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddFlareGreen(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a GREEN FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddFlareOrange(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, an ORANGE FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddFlareRed(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a RED FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddFlareWhite(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a WHITE FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddGoalCompletion(string, string, number, self, GoalVerb, GoalTask, GoalIncrease) +

Adds an Additional Goal for the TASK to be achieved.

+
TASK:AddSignal(SignalUnitNames, SignalType, SignalColor, SignalHeight) +

Work function to set signal events within a TASK.

+
TASK.AddSmokeBlue(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a BLUE SMOKE will be fired by an optional SignalUnitNames.

+
TASK.AddSmokeGreen(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a GREEN SMOKE will be fired by an optional SignalUnitNames.

+
TASK.AddSmokeOrange(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, an ORANGE SMOKE will be fired by an optional SignalUnitNames.

+
TASK.AddSmokeRed(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a RED SMOKE will be fired by an optional SignalUnitNames.

+
TASK.AddSmokeWhite(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a WHITE SMOKE will be fired by an optional SignalUnitNames.

+
TASK.Cargos + +
TASK.ClassName + +
TASK:Done() +

Sets a TASK to status Done.

+
TASK:Failed() +

Sets a TASK to status failed.

+
TASK.GetGoalCompletion(?, self, GoalVerb) +

Returns if the additional Goal for the TASK was completed.

+
TASK.GetGoalCount(?, self, GoalVerb) +

Gets the total of Goals currently achieved within the TASK of the GoalVerb.

+
TASK.GetGoalPercentage(?, self, GoalVerb) +

Gets the percentage of Goals currently achieved within the TASK of the GoalVerb.

+
TASK:GetGoalProgress() +

Get progress of a TASK.

+
TASK.GetGoalTotal(?, self, GoalVerb) +

Gets the total of Goals to be achieved within the TASK of the GoalVerb.

+
TASK:GetGoals() +

Returns the Goals of a TASK

+
TASK.Goal(?, self, GoalVerb) +

Returns if a TASK has Goal(s).

+
TASK.GoalTasks + +
TASK.IncreaseGoalCount(number, ?, self, GoalCountIncrease, GoalVerb) +

Increments the total of Goals currently achieved within the TASK of the GoalVerb, with the given GoalCountIncrease.

+
TASK:Init() + +
TASK:IsDone() +

Returns if a TASK is done.

+
TASK:IsFailed() +

Returns if a TASk has failed.

+
TASK:IsGoalReached() +

Returns if all the Goals of the TASK were achieved.

+
TASK.LandingZones + +
TASK.MenuAction(Parameter) + +
TASK.Mission + +
TASK.Name + +
TASK:New() +

Instantiates a new TASK Base.

+
TASK:Reset(Mission, Client) + +
TASK.SIGNAL + +
TASK.SetGoalCount(number, ?, self, GoalCount, GoalVerb) +

Sets the total of Goals currently achieved within the TASK of the GoalVerb.

+
TASK.SetGoalTotal(number, ?, self, GoalTotal, GoalVerb) +

Sets the total Goals to be achieved of the Goal Name

+
TASK:SetStage(StageSequenceIncrement) + +
TASK.ShowGoalProgress(MISSION, CLIENT, self, Mission, Client) +

Show progress of a TASK.

+
TASK.Stage + +
TASK:StageExecute() + +
TASK.Stages + +
TASK.TaskDone + +
TASK.TaskFailed + +
+ +

Global(s)

+
+
+ + #TASK + +TASK + +
+
+ + + +
+
+

Type TASK

+ +

The TASK class

+ +

Field(s)

+
+
+ + #number + +TASK.ActiveStage + +
+
+ + + +
+
+
+
+ + +TASK.AddFlareBlue(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a BLUE FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddFlareGreen(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a GREEN FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddFlareOrange(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, an ORANGE FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddFlareRed(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a RED FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddFlareWhite(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a WHITE FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddGoalCompletion(string, string, number, self, GoalVerb, GoalTask, GoalIncrease) + +
+
+ +

Adds an Additional Goal for the TASK to be achieved.

+ +

Parameters

+
    +
  • + +

    string : +GoalVerb is the name of the Goal of the TASK.

    + +
    • +
  • + +

    string : +GoalTask is a text describing the Goal of the TASK to be achieved.

    + +
    • +
  • + +

    number : +GoalIncrease is a number by which the Goal achievement is increasing.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
  • + +

    GoalTask :

    + +
    • +
  • + +

    GoalIncrease :

    + +
    • +
+
+
+
+
+ + +TASK:AddSignal(SignalUnitNames, SignalType, SignalColor, SignalHeight) + +
+
+ +

Work function to set signal events within a TASK.

+ +

Parameters

+
    +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalType :

    + +
    • +
  • + +

    SignalColor :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeBlue(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a BLUE SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeGreen(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a GREEN SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeOrange(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, an ORANGE SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeRed(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a RED SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeWhite(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a WHITE SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + + +TASK.Cargos + +
+
+ + + +
+
+
+
+ + #string + +TASK.ClassName + +
+
+ + + +
+
+
+
+ + +TASK:Done() + +
+
+ +

Sets a TASK to status Done.

+ +
+
+
+
+ + +TASK:Failed() + +
+
+ +

Sets a TASK to status failed.

+ +
+
+
+
+ + +TASK.GetGoalCompletion(?, self, GoalVerb) + +
+
+ +

Returns if the additional Goal for the TASK was completed.

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

string Goals

+ +
+
+
+
+ + +TASK.GetGoalCount(?, self, GoalVerb) + +
+
+ +

Gets the total of Goals currently achieved within the TASK of the GoalVerb.

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK.GetGoalPercentage(?, self, GoalVerb) + +
+
+ +

Gets the percentage of Goals currently achieved within the TASK of the GoalVerb.

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK:GetGoalProgress() + +
+
+ +

Get progress of a TASK.

+ +

Return value

+ + +

string GoalsText

+ +
+
+
+
+ + +TASK.GetGoalTotal(?, self, GoalVerb) + +
+
+ +

Gets the total of Goals to be achieved within the TASK of the GoalVerb.

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+
+
+
+
+ + +TASK:GetGoals() + +
+
+ +

Returns the Goals of a TASK

+ +

Return value

+ + +

@table Goals

+ +
+
+
+
+ + +TASK.Goal(?, self, GoalVerb) + +
+
+ +

Returns if a TASK has Goal(s).

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

bool

+ +
+
+
+
+ + + +TASK.GoalTasks + +
+
+ + + +
+
+
+
+ + +TASK.IncreaseGoalCount(number, ?, self, GoalCountIncrease, GoalVerb) + +
+
+ +

Increments the total of Goals currently achieved within the TASK of the GoalVerb, with the given GoalCountIncrease.

+ +

Parameters

+
    +
  • + +

    number : +GoalCountIncrease is the number of new Goals achieved within the TASK.

    + +
    • +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalCountIncrease :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK:Init() + +
+
+ + + +
+
+
+
+ + +TASK:IsDone() + +
+
+ +

Returns if a TASK is done.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + +TASK:IsFailed() + +
+
+ +

Returns if a TASk has failed.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + +TASK:IsGoalReached() + +
+
+ +

Returns if all the Goals of the TASK were achieved.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + + +TASK.LandingZones + +
+
+ + + +
+
+
+
+ + +TASK.MenuAction(Parameter) + +
+
+ + + +

Parameter

+
    +
  • + +

    Parameter :

    + +
    • +
+
+
+
+
+ + + +TASK.Mission + +
+
+ + + +
+
+
+
+ + #string + +TASK.Name + +
+
+ + + +
+
+
+
+ + +TASK:New() + +
+
+ +

Instantiates a new TASK Base.

+ + +

Should never be used. Interface Class.

+ +

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK:Reset(Mission, Client) + +
+
+ + + +

Parameters

+
    +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
+
+
+
+
+ + + +TASK.SIGNAL + +
+
+ + + + +

Defines the different signal types with a Task.

+ +
+
+
+
+ + +TASK.SetGoalCount(number, ?, self, GoalCount, GoalVerb) + +
+
+ +

Sets the total of Goals currently achieved within the TASK of the GoalVerb.

+ +

Parameters

+
    +
  • + +

    number : +GoalCount is the total number of Goals achieved within the TASK.

    + +
    • +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalCount :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK.SetGoalTotal(number, ?, self, GoalTotal, GoalVerb) + +
+
+ +

Sets the total Goals to be achieved of the Goal Name

+ +

Parameters

+
    +
  • + +

    number : +GoalTotal is the number of times the GoalVerb needs to be achieved.

    + +
    • +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalTotal :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+
+
+
+
+ + +TASK:SetStage(StageSequenceIncrement) + +
+
+ + + +

Parameter

+
    +
  • + +

    StageSequenceIncrement :

    + +
    • +
+
+
+
+
+ + +TASK.ShowGoalProgress(MISSION, CLIENT, self, Mission, Client) + +
+
+ +

Show progress of a TASK.

+ +

Parameters

+
    +
  • + +

    MISSION :

    +
    Mission         Group structure describing the Mission.
+
    + +
    • +
  • + +

    CLIENT : +Client Group structure describing the Client.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
+
+
+
+
+ + + +TASK.Stage + +
+
+ + + +
+
+
+
+ + +TASK:StageExecute() + +
+
+ + + +
+
+
+
+ + + +TASK.Stages + +
+
+ + + +
+
+
+
+ + #boolean + +TASK.TaskDone + +
+
+ + + +
+
+
+
+ + #boolean + +TASK.TaskFailed + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Documentation/Unit.html b/Documentation/Unit.html new file mode 100644 index 000000000..01c4800cd --- /dev/null +++ b/Documentation/Unit.html @@ -0,0 +1,394 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Unit

+ +

UNIT Classes

+ +

Global(s)

+ + + + + +
UNIT + +
+

Type UNIT

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNIT.CategoryName + +
UNIT.ClassName + +
UNIT:GetCallSign() + +
UNIT:GetCategoryName() + +
UNIT:GetDCSUnit() + +
UNIT:GetID() + +
UNIT:GetName() + +
UNIT:GetPointVec2() + +
UNIT:GetPositionVec3() + +
UNIT:GetPrefix() + +
UNIT:GetTypeName() + +
UNIT:IsAlive() + +
UNIT:New(DCSUnit) + +
UNIT:OtherUnitInRadius(AwaitUnit, Radius) + +
+ +

Global(s)

+
+
+ + #UNIT + +UNIT + +
+
+ + + +
+
+

Type Unit

+ +

Type UNIT

+ +

The UNIT class

+ +

Field(s)

+
+
+ + + +UNIT.CategoryName + +
+
+ + + +
+
+
+
+ + #string + +UNIT.ClassName + +
+
+ + + +
+
+
+
+ + +UNIT:GetCallSign() + +
+
+ + + +
+
+
+
+ + +UNIT:GetCategoryName() + +
+
+ + + +
+
+
+
+ + +UNIT:GetDCSUnit() + +
+
+ + + +
+
+
+
+ + +UNIT:GetID() + +
+
+ + + +
+
+
+
+ + +UNIT:GetName() + +
+
+ + + +
+
+
+
+ + +UNIT:GetPointVec2() + +
+
+ + + +
+
+
+
+ + +UNIT:GetPositionVec3() + +
+
+ + + +
+
+
+
+ + +UNIT:GetPrefix() + +
+
+ + + +
+
+
+
+ + +UNIT:GetTypeName() + +
+
+ + + +
+
+
+
+ + +UNIT:IsAlive() + +
+
+ + + +
+
+
+
+ + +UNIT:New(DCSUnit) + +
+
+ + + +

Parameter

+
    +
  • + +

    DCSUnit :

    + +
    • +
+
+
+
+
+ + +UNIT:OtherUnitInRadius(AwaitUnit, Radius) + +
+
+ + + +

Parameters

+
    +
  • + +

    AwaitUnit :

    + +
    • +
  • + +

    Radius :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Documentation/Zone.html b/Documentation/Zone.html new file mode 100644 index 000000000..e25e53527 --- /dev/null +++ b/Documentation/Zone.html @@ -0,0 +1,209 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Zone

+ +

ZONE Classes

+ +

Global(s)

+ + + + + +
ZONE + +
+

Type ZONE

+ + + + + + + + + + + + + + + + + + + + + +
ZONE.ClassName + +
ZONE:GetPointVec2() + +
ZONE:GetRadius() + +
ZONE:GetRandomPoint() + +
ZONE:New(ZoneName) + +
+ +

Global(s)

+
+
+ + #ZONE + +ZONE + +
+
+ + + +
+
+

Type Zone

+ +

Type ZONE

+ +

The ZONE class

+ +

Field(s)

+
+
+ + #string + +ZONE.ClassName + +
+
+ + + +
+
+
+
+ + +ZONE:GetPointVec2() + +
+
+ + + +
+
+
+
+ + +ZONE:GetRadius() + +
+
+ + + +
+
+
+
+ + +ZONE:GetRandomPoint() + +
+
+ + + +
+
+
+
+ + +ZONE:New(ZoneName) + +
+
+ + + +

Parameter

+
    +
  • + +

    ZoneName :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Documentation/env.html b/Documentation/env.html new file mode 100644 index 000000000..f8a687299 --- /dev/null +++ b/Documentation/env.html @@ -0,0 +1,95 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module env

+ + + +

Global(s)

+ + + + + +
env + +
+

Global(s)

+
+
+ + #env + +env + +
+
+ + + +
+
+

Type env

+ +
+ +
+ + diff --git a/Documentation/index.html b/Documentation/index.html new file mode 100644 index 000000000..b9bcd75f4 --- /dev/null +++ b/Documentation/index.html @@ -0,0 +1,296 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Base +

BASE The base class for all the classes defined within MOOSE.

+
CARGO +

CARGO Classes

+
CLEANUP +

CLEANUP Classes

+
Client +

CLIENT Classes

+
DCSAirbase + +
DCSCoalitionObject + +
DCSController + +
DCSGroup + +
DCSObject + +
DCSTypes + +
DCSUnit + +
DCStimer + +
DEPLOYTASK +

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

+
DESTROYBASETASK +

A DESTROYBASETASK will monitor the destruction of Groups and Units.

+
DESTROYGROUPSTASK +

DESTROYGROUPSTASK

+
DESTROYRADARSTASK +

Task class to destroy radar installations.

+
DESTROYUNITTYPESTASK +

Set TASK to destroy certain unit types.

+
Database +

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

+
Escort +

Taking the lead of AI escorting your flight.

+
GOHOMETASK +

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

+
Group +

A GROUP class abstraction of a DCSGroup class.

+
MISSION +

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

+
MOVEMENT +

Limit the simultaneous movement of Groups within a running Mission.

+
Menu +

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

+
Message +

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

+
NOTASK +

A NOTASK is a dummy activity...

+
PICKUPTASK +

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

+
ROUTETASK +

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

+
STAGE +

Stages within a TASK within a MISSION.

+
Sead +

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

+
Spawn +

Dynamic spawning of groups (and units).

+
StaticObject + +
TASK +

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

+
Unit +

UNIT Classes

+
Zone +

ZONE Classes

+
env + +
land + +
routines +

Various routines

+
+
+ +
+ + diff --git a/Documentation/land.html b/Documentation/land.html new file mode 100644 index 000000000..7a1f06f49 --- /dev/null +++ b/Documentation/land.html @@ -0,0 +1,257 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module land

+ + + +

Global(s)

+ + + + + +
land + +
+

Type land

+ + + + + + + + + +
land.SurfaceType + +
land.getHeight(point) +

Returns altitude MSL of the point.

+
+ +

Type land.SurfaceType

+ + + + + + + + + + + + + + + + + + + + + +
land.SurfaceType.LAND + +
land.SurfaceType.ROAD + +
land.SurfaceType.RUNWAY + +
land.SurfaceType.SHALLOW_WATER + +
land.SurfaceType.WATER + +
+ +

Global(s)

+
+
+ + #land + +land + +
+
+ + + +
+
+

Type land

+

Field(s)

+
+
+ + #land.SurfaceType + +land.SurfaceType + +
+
+ + + +
+
+
+
+ + +land.getHeight(point) + +
+
+ +

Returns altitude MSL of the point.

+ +

Parameter

+
    +
  • + +

    #Vec2 point : +point on the ground.

    + +
    • +
+

Return value

+ +

DCSTypes#Distance:

+ + +
+
+ +

Type Vec2

+ +

Type land.SurfaceType

+

Field(s)

+
+
+ + +land.SurfaceType.LAND + +
+
+ + + +
+
+
+
+ + +land.SurfaceType.ROAD + +
+
+ + + +
+
+
+
+ + +land.SurfaceType.RUNWAY + +
+
+ + + +
+
+
+
+ + +land.SurfaceType.SHALLOW_WATER + +
+
+ + + +
+
+
+
+ + +land.SurfaceType.WATER + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Documentation/routines.html b/Documentation/routines.html new file mode 100644 index 000000000..5252b8954 --- /dev/null +++ b/Documentation/routines.html @@ -0,0 +1,1199 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module routines

+ +

Various routines

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alive + +
ChooseInfantry(TeleportPrefixTable, TeleportMax) + +
EscortCarrier(CarrierGroup, EscortPrefix, EscortLastWayPoint, EscortEngagementDistanceMax, EscortTargetTypes) + +
EscortCount + +
EscortMissionName + +
GetUnitHeight(CheckUnit) + +
GroupAlive(groupName) + +
LandCarrier(CarrierGroup, LandingZonePrefix) + +
MessageToAll(MsgText, MsgTime, MsgName) + +
MessageToBlue(MsgText, MsgTime, MsgName) + +
MessageToUnit(UnitName, MsgText, MsgTime, MsgName) + +
MusicRegister(SndRef, SndFile, SndTime) + +
MusicReset(flg) + +
MusicToPlayer(SndRef, PlayerName, SndContinue) + +
PlaneActivate(groupNameFormat, flg) + +
PlayerGroup + +
SendMessageToCarrier(CarrierGroup, CarrierMessage) + +
SpawnSettings + +
SpawnedInfantry + +
Su34AttackCarlVinson(groupName) + +
Su34AttackNorth(groupName) + +
Su34AttackWest(groupName) + +
Su34Destroyed(groupName) + +
Su34Hold(groupName) + +
Su34IsDead() + +
Su34Menu(groupName) + +
Su34MenuPath + +
Su34Menus + +
Su34Orbit(groupName) + +
Su34OverviewStatus() + +
Su34RTB(groupName) + +
Su34Status + +
Su34TakeOff(groupName) + +
TeleportPrefixTableCount + +
TeleportPrefixTableIndex + +
UpdateBoardMsg() + +
_MusicTable + +
boardMsgAll + +
boardMsgRed + +
getCarrierHeight(CarrierGroup) + +
lookup_table + +
routines + +
spairs(t, order) + +
+

Global(s)

+
+
+ + + +Alive + +
+
+ + + +
+
+
+
+ + +ChooseInfantry(TeleportPrefixTable, TeleportMax) + +
+
+ + + +

Parameters

+
    +
  • + +

    TeleportPrefixTable :

    + +
    • +
  • + +

    TeleportMax :

    + +
    • +
+
+
+
+
+ + +EscortCarrier(CarrierGroup, EscortPrefix, EscortLastWayPoint, EscortEngagementDistanceMax, EscortTargetTypes) + +
+
+ + + +

Parameters

+
    +
  • + +

    CarrierGroup :

    + +
    • +
  • + +

    EscortPrefix :

    + +
    • +
  • + +

    EscortLastWayPoint :

    + +
    • +
  • + +

    EscortEngagementDistanceMax :

    + +
    • +
  • + +

    EscortTargetTypes :

    + +
    • +
+
+
+
+
+ + #number + +EscortCount + +
+
+ + + +
+
+
+
+ + + +EscortMissionName + +
+
+ + + +
+
+
+
+ + +GetUnitHeight(CheckUnit) + +
+
+ + + +

Parameter

+
    +
  • + +

    CheckUnit :

    + +
    • +
+
+
+
+
+ + +GroupAlive(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +LandCarrier(CarrierGroup, LandingZonePrefix) + +
+
+ + + +

Parameters

+
    +
  • + +

    CarrierGroup :

    + +
    • +
  • + +

    LandingZonePrefix :

    + +
    • +
+
+
+
+
+ + +MessageToAll(MsgText, MsgTime, MsgName) + +
+
+ + + +

Parameters

+
    +
  • + +

    MsgText :

    + +
    • +
  • + +

    MsgTime :

    + +
    • +
  • + +

    MsgName :

    + +
    • +
+
+
+
+
+ + +MessageToBlue(MsgText, MsgTime, MsgName) + +
+
+ + + +

Parameters

+
    +
  • + +

    MsgText :

    + +
    • +
  • + +

    MsgTime :

    + +
    • +
  • + +

    MsgName :

    + +
    • +
+
+
+
+
+ + +MessageToUnit(UnitName, MsgText, MsgTime, MsgName) + +
+
+ + + +

Parameters

+
    +
  • + +

    UnitName :

    + +
    • +
  • + +

    MsgText :

    + +
    • +
  • + +

    MsgTime :

    + +
    • +
  • + +

    MsgName :

    + +
    • +
+
+
+
+
+ + +MusicRegister(SndRef, SndFile, SndTime) + +
+
+ + + +

Parameters

+
    +
  • + +

    SndRef :

    + +
    • +
  • + +

    SndFile :

    + +
    • +
  • + +

    SndTime :

    + +
    • +
+
+
+
+
+ + +MusicReset(flg) + +
+
+ + + +

Parameter

+
    +
  • + +

    flg :

    + +
    • +
+
+
+
+
+ + +MusicToPlayer(SndRef, PlayerName, SndContinue) + +
+
+ + + +

Parameters

+
    +
  • + +

    SndRef :

    + +
    • +
  • + +

    PlayerName :

    + +
    • +
  • + +

    SndContinue :

    + +
    • +
+
+
+
+
+ + +PlaneActivate(groupNameFormat, flg) + +
+
+ + + +

Parameters

+
    +
  • + +

    groupNameFormat :

    + +
    • +
  • + +

    flg :

    + +
    • +
+
+
+
+
+ + + +PlayerGroup + +
+
+ + + +
+
+
+
+ + +SendMessageToCarrier(CarrierGroup, CarrierMessage) + +
+
+ + + +

Parameters

+
    +
  • + +

    CarrierGroup :

    + +
    • +
  • + +

    CarrierMessage :

    + +
    • +
+
+
+
+
+ + + +SpawnSettings + +
+
+ + + +
+
+
+
+ + #number + +SpawnedInfantry + +
+
+ + + +
+
+
+
+ + +Su34AttackCarlVinson(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34AttackNorth(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34AttackWest(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34Destroyed(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34Hold(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34IsDead() + +
+
+ + + +
+
+
+
+ + +Su34Menu(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + + +Su34MenuPath + +
+
+ + + +
+
+
+
+ + #number + +Su34Menus + +
+
+ + + +
+
+
+
+ + +Su34Orbit(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34OverviewStatus() + +
+
+ + + +
+
+
+
+ + +Su34RTB(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + + +Su34Status + +
+
+ + + +
+
+
+
+ + +Su34TakeOff(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +TeleportPrefixTableCount + +
+
+ + + +
+
+
+
+ + + +TeleportPrefixTableIndex + +
+
+ + + +
+
+
+
+ + +UpdateBoardMsg() + +
+
+ + + +
+
+
+
+ + + +_MusicTable + +
+
+ + + +
+
+
+
+ + + +boardMsgAll + +
+
+ + + +
+
+
+
+ + + +boardMsgRed + +
+
+ + + +
+
+
+
+ + +getCarrierHeight(CarrierGroup) + +
+
+ + + +

Parameter

+
    +
  • + +

    CarrierGroup :

    + +
    • +
+
+
+
+
+ + + +lookup_table + +
+
+ + + +
+
+
+
+ + + +routines + +
+
+ + + +
+
+
+
+ + +spairs(t, order) + +
+
+ + + +

Parameters

+
    +
  • + +

    t :

    + +
    • +
  • + +

    order :

    + +
    • +
+
+
+

Type routines

+ +
+ +
+ + diff --git a/Documentation/stylesheet.css b/Documentation/stylesheet.css new file mode 100644 index 000000000..1b82635b5 --- /dev/null +++ b/Documentation/stylesheet.css @@ -0,0 +1,269 @@ +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: bullet; + 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; } + +body, p, td, th { font-size: .95em; line-height: 1.2em;} + +p, ul { margin: 10px 0 0 10px;} + +strong { font-weight: bold;} + +em { font-style: italic;} + +h1 { + font-size: 1.5em; + margin: 25px 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; +} + +p:first-child { + margin-top: 0px; +} + +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; + 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: 18em; + vertical-align: top; + background-color: #f0f0f0; + overflow: scroll; + position: fixed; + height:100%; +} + +#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: 18em; + padding: 1em; + 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; } +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; } +table.function_list td.summary { width: 100%; } + +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;} + diff --git a/DCS/DCSAirbase.doclua b/Moose/DCS/DCSAirbase.lua similarity index 100% rename from DCS/DCSAirbase.doclua rename to Moose/DCS/DCSAirbase.lua diff --git a/DCS/DCSCoalitionObject.doclua b/Moose/DCS/DCSCoalitionObject.lua similarity index 100% rename from DCS/DCSCoalitionObject.doclua rename to Moose/DCS/DCSCoalitionObject.lua diff --git a/DCS/DCSController.doclua b/Moose/DCS/DCSController.lua similarity index 100% rename from DCS/DCSController.doclua rename to Moose/DCS/DCSController.lua diff --git a/DCS/DCSGroup.doclua b/Moose/DCS/DCSGroup.lua similarity index 100% rename from DCS/DCSGroup.doclua rename to Moose/DCS/DCSGroup.lua diff --git a/DCS/DCSObject.doclua b/Moose/DCS/DCSObject.lua similarity index 100% rename from DCS/DCSObject.doclua rename to Moose/DCS/DCSObject.lua diff --git a/DCS/DCSStaticObject.doclua b/Moose/DCS/DCSStaticObject.lua similarity index 100% rename from DCS/DCSStaticObject.doclua rename to Moose/DCS/DCSStaticObject.lua diff --git a/DCS/DCSTask.doclua b/Moose/DCS/DCSTask.lua similarity index 85% rename from DCS/DCSTask.doclua rename to Moose/DCS/DCSTask.lua index 3d57efca1..9c24ea895 100644 --- a/DCS/DCSTask.doclua +++ b/Moose/DCS/DCSTask.lua @@ -1,3 +1,5 @@ +--- @module DCSTask + --- @type DCSTask -- @field #string id diff --git a/DCS/DCSTime.doclua b/Moose/DCS/DCSTime.lua similarity index 100% rename from DCS/DCSTime.doclua rename to Moose/DCS/DCSTime.lua diff --git a/DCS/DCSTypes.doclua b/Moose/DCS/DCSTypes.lua similarity index 99% rename from DCS/DCSTypes.doclua rename to Moose/DCS/DCSTypes.lua index 6be092099..ae23eb737 100644 --- a/DCS/DCSTypes.doclua +++ b/Moose/DCS/DCSTypes.lua @@ -1,5 +1,5 @@ ------------------------------------------------------------------------------- ---- @module DCSTypes +-- @module DCSTypes --- Time is given in seconds. diff --git a/DCS/DCSUnit.doclua b/Moose/DCS/DCSUnit.lua similarity index 100% rename from DCS/DCSUnit.doclua rename to Moose/DCS/DCSUnit.lua diff --git a/DCS/DCSenv.doclua b/Moose/DCS/DCSenv.lua similarity index 100% rename from DCS/DCSenv.doclua rename to Moose/DCS/DCSenv.lua diff --git a/DCS/DCSland.doclua b/Moose/DCS/DCSland.lua similarity index 100% rename from DCS/DCSland.doclua rename to Moose/DCS/DCSland.lua diff --git a/DCS/DCStimer.doclua b/Moose/DCS/DCStimer.lua similarity index 100% rename from DCS/DCStimer.doclua rename to Moose/DCS/DCStimer.lua diff --git a/Moose/Escort.lua b/Moose/Escort.lua index 8f80d421a..07f710f44 100644 --- a/Moose/Escort.lua +++ b/Moose/Escort.lua @@ -1,6 +1,6 @@ --- Taking the lead of AI escorting your flight. -- The ESCORT class allows you to interact with escoring AI on your flight and take the lead. --- +-- @module Escort -- -- diff --git a/Moose/docs/Base.html b/Moose/docs/Base.html new file mode 100644 index 000000000..d8ceac6fc --- /dev/null +++ b/Moose/docs/Base.html @@ -0,0 +1,744 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Base

+ +

BASE The base class for all the classes defined within MOOSE.

+ +

Global(s)

+ + + + + + + + + +
BASE + +
FORMATION + +
+

Type BASE

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BASE:AddEvent(Event, EventFunction) + +
BASE.ClassID +

The ID number of the class.

+
BASE.ClassName +

The name of the class.

+
BASE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) + +
BASE:CreateEventCrash(EventTime, Initiator) + +
BASE:DisableEvents() + +
BASE:E(Arguments) + +
BASE:EnableEvents() + +
BASE.Events + +
BASE:F(Arguments) + +
BASE:F2(Arguments) + +
BASE:F3(Arguments) + +
BASE:GetClassID() +

Get the ClassID of the class instance.

+
BASE:GetClassName() +

Get the ClassName of the class instance.

+
BASE:GetClassNameAndID() +

Get the ClassName + ClassID of the class instance.

+
BASE.Inherit(Child, Parent, self) +

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

+
BASE.Inherited(Child, self) +

This is the worker method to retrieve the Parent class.

+
BASE:New() + +
BASE:T(Arguments) + +
BASE:T2(Arguments) + +
BASE:T3(Arguments) + +
BASE:onEvent(event) + +
+ +

Type FORMATION

+ + + + + +
FORMATION.Cone +

A cone formation.

+
+ +

Global(s)

+
+
+ + #BASE + +BASE + +
+
+ + + +
+
+
+
+ + #FORMATION + +FORMATION + +
+
+ + + +
+
+

Type Base

+ +

Type BASE

+ +

The BASE Class

+ +

Field(s)

+
+
+ + +BASE:AddEvent(Event, EventFunction) + +
+
+ + + +

Parameters

+
    +
  • + +

    Event :

    + +
    • +
  • + +

    EventFunction :

    + +
    • +
+
+
+
+
+ + +BASE.ClassID + +
+
+ +

The ID number of the class.

+ +
+
+
+
+ + +BASE.ClassName + +
+
+ +

The name of the class.

+ +
+
+
+
+ + +BASE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) + +
+
+ + + +

Parameters

+
    +
  • + +

    EventTime :

    + +
    • +
  • + +

    Initiator :

    + +
    • +
  • + +

    IniUnitName :

    + +
    • +
  • + +

    place :

    + +
    • +
  • + +

    subplace :

    + +
    • +
+
+
+
+
+ + +BASE:CreateEventCrash(EventTime, Initiator) + +
+
+ + + +

Parameters

+
    +
  • + +

    EventTime :

    + +
    • +
  • + +

    Initiator :

    + +
    • +
+
+
+
+
+ + +BASE:DisableEvents() + +
+
+ + + +
+
+
+
+ + +BASE:E(Arguments) + +
+
+ + + + +

Log an exception

+ +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:EnableEvents() + +
+
+ + + +
+
+
+
+ + + +BASE.Events + +
+
+ + + +
+
+
+
+ + +BASE:F(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:F2(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:F3(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:GetClassID() + +
+
+ +

Get the ClassID of the class instance.

+ +

Return value

+ +

#string: +The ClassID of the class instance.

+ +
+
+
+
+ + +BASE:GetClassName() + +
+
+ +

Get the ClassName of the class instance.

+ +

Return value

+ +

#string: +The ClassName of the class instance.

+ +
+
+
+
+ + +BASE:GetClassNameAndID() + +
+
+ +

Get the ClassName + ClassID of the class instance.

+ + +

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

+ +

Return value

+ +

#string: +The ClassName + ClassID of the class instance.

+ +
+
+
+
+ + +BASE.Inherit(Child, Parent, self) + +
+
+ +

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

+ +

Parameters

+
    +
  • + +

    Child : +is the Child class that inherits.

    + +
    • +
  • + +

    Parent : +is the Parent class that the Child inherits from.

    + +
    • +
  • + +

    self :

    + +
    • +
+

Return value

+ + +

Child

+ +
+
+
+
+ + +BASE.Inherited(Child, self) + +
+
+ +

This is the worker method to retrieve the Parent class.

+ +

Parameters

+
    +
  • + +

    #BASE Child : +is the Child class from which the Parent class needs to be retrieved.

    + +
    • +
  • + +

    self :

    + +
    • +
+

Return value

+ +

#BASE:

+ + +
+
+
+
+ + +BASE:New() + +
+
+ + + +
+
+
+
+ + +BASE:T(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:T2(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:T3(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:onEvent(event) + +
+
+ + + +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+ +

Type FORMATION

+ +

The Formation Class

+ +

Field(s)

+
+
+ + +FORMATION.Cone + +
+
+ +

A cone formation.

+ +
+
+ +
+ +
+ + diff --git a/Moose/docs/CARGO.html b/Moose/docs/CARGO.html new file mode 100644 index 000000000..d1327bed9 --- /dev/null +++ b/Moose/docs/CARGO.html @@ -0,0 +1,203 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module CARGO

+ +

CARGO Classes

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CARGO + +
CARGOS + +
CARGO_GROUP + +
CARGO_PACKAGE + +
CARGO_SLINGLOAD + +
CARGO_ZONE + +
CargoStatic + +
+

Global(s)

+
+
+ + + +CARGO + +
+
+ + + +
+
+
+
+ + + +CARGOS + +
+
+ + + +
+
+
+
+ + + +CARGO_GROUP + +
+
+ + + +
+
+
+
+ + + +CARGO_PACKAGE + +
+
+ + + +
+
+
+
+ + + +CARGO_SLINGLOAD + +
+
+ + + +
+
+
+
+ + + +CARGO_ZONE + +
+
+ + + +
+
+
+
+ + + +CargoStatic + +
+
+ + + +
+
+

Type CARGO

+ +
+ +
+ + diff --git a/Moose/docs/CLEANUP.html b/Moose/docs/CLEANUP.html new file mode 100644 index 000000000..0acffd34f --- /dev/null +++ b/Moose/docs/CLEANUP.html @@ -0,0 +1,485 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module CLEANUP

+ +

CLEANUP Classes

+ +

Global(s)

+ + + + + + + + + +
CLEANUP + +
CleanUpSurfaceTypeText + +
+

Type CLEANUP

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CLEANUP.ClassName + +
CLEANUP.CleanUpList + +
CLEANUP:New(ZoneNames, TimeInterval) + +
CLEANUP.TimeInterval + +
CLEANUP.ZoneNames + +
CLEANUP:_AddForCleanUp(CleanUpUnit, CleanUpUnitName) + +
CLEANUP:_DestroyGroup(GroupObject, CleanUpGroupName) +

Destroys a group from the simulator, but checks first if it is still existing!

+
CLEANUP:_DestroyMissile(MissileObject) +

Destroys a missile from the simulator, but checks first if it is still existing!

+
CLEANUP:_DestroyUnit(CleanUpUnit, CleanUpUnitName) +

Destroys a unit from the simulator, but checks first if it is still existing!

+
CLEANUP:_EventAddForCleanUp(event) +

Detects if the Unit has an SEVENTENGINESHUTDOWN or an SEVENT_HIT within the given ZoneNames.

+
CLEANUP:_EventCrash(event) +

Detects if an SA site was shot with an anti radiation missile.

+
CLEANUP:_EventHitCleanUp(event) +

Detects if the Unit has an SEVENTHIT within the given ZoneNames.

+
CLEANUP:_EventShot(event) +

Detects if an SA site was shot with an anti radiation missile.

+
CLEANUP:_Scheduler() +

At the defined time interval, CleanUp the Groups within the CleanUpList.

+
+ +

Global(s)

+
+
+ + #CLEANUP + +CLEANUP + +
+
+ + + +
+
+
+
+ + + +CleanUpSurfaceTypeText + +
+
+ + + +
+
+

Type CLEANUP

+ +

The CLEANUP class.

+ +

Field(s)

+
+
+ + #string + +CLEANUP.ClassName + +
+
+ + + +
+
+
+
+ + + +CLEANUP.CleanUpList + +
+
+ + + +
+
+
+
+ + +CLEANUP:New(ZoneNames, TimeInterval) + +
+
+ + + +

Parameters

+
    +
  • + +

    ZoneNames :

    + +
    • +
  • + +

    TimeInterval :

    + +
    • +
+
+
+
+
+ + #number + +CLEANUP.TimeInterval + +
+
+ + + +
+
+
+
+ + + +CLEANUP.ZoneNames + +
+
+ + + +
+
+
+
+ + +CLEANUP:_AddForCleanUp(CleanUpUnit, CleanUpUnitName) + +
+
+ + + +

Parameters

+
    +
  • + +

    CleanUpUnit :

    + +
    • +
  • + +

    CleanUpUnitName :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_DestroyGroup(GroupObject, CleanUpGroupName) + +
+
+ +

Destroys a group from the simulator, but checks first if it is still existing!

+ +

Parameters

+
    +
  • + +

    GroupObject :

    + +
    • +
  • + +

    CleanUpGroupName :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_DestroyMissile(MissileObject) + +
+
+ +

Destroys a missile from the simulator, but checks first if it is still existing!

+ +

Parameter

+
    +
  • + +

    MissileObject :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_DestroyUnit(CleanUpUnit, CleanUpUnitName) + +
+
+ +

Destroys a unit from the simulator, but checks first if it is still existing!

+ +

Parameters

+
    +
  • + +

    CleanUpUnit :

    + +
    • +
  • + +

    CleanUpUnitName :

    + +
    • +
+
+
+
+
+ + +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.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_EventCrash(event) + +
+
+ +

Detects if an SA site was shot with an anti radiation missile.

+ + +

In this case, take evasive actions based on the skill level set within the ME.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_EventHitCleanUp(event) + +
+
+ +

Detects if the Unit has an SEVENTHIT within the given ZoneNames.

+ + +

If this is the case, destroy the unit.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_EventShot(event) + +
+
+ +

Detects if an SA site was shot with an anti radiation missile.

+ + +

In this case, take evasive actions based on the skill level set within the ME.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_Scheduler() + +
+
+ +

At the defined time interval, CleanUp the Groups within the CleanUpList.

+ +
+
+ +
+ +
+ + diff --git a/Moose/docs/Client.html b/Moose/docs/Client.html new file mode 100644 index 000000000..65a5da0f9 --- /dev/null +++ b/Moose/docs/Client.html @@ -0,0 +1,943 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Client

+ +

CLIENT Classes

+ +

Global(s)

+ + + + + + + + + +
CLIENT + +
ClientGroupUnit + +
+

Type CLIENT

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CLIENT.AddBriefing(string, self, ClientBriefing) +

AddBriefing adds a briefing to a Client when a Player joins a Mission.

+
CLIENT:Alive(CallBack) +

Checks for a client alive event and calls a function on a continuous basis.

+
CLIENT.AliveCheckFunction + +
CLIENT.ClassName + +
CLIENT.ClientAlive + +
CLIENT.ClientAlive2 + +
CLIENT.ClientBriefingShown + +
CLIENT.ClientCallBack + +
CLIENT.ClientName + +
CLIENT:ClientPosition() +

Returns the Position of the CLIENT.

+
CLIENT.ClientTransport + +
CLIENT:GetAltitude() +

Returns the altitude of the CLIENT.

+
CLIENT:GetClientGroupDCSUnit() +

Returns the DCSUnit of the CLIENT.

+
CLIENT:GetClientGroupID() + +
CLIENT:GetClientGroupName() + +
CLIENT:GetClientGroupUnit() +

Returns the Unit of the CLIENT.

+
CLIENT:GetDCSGroup() +

Return the DCSGroup of a Client.

+
CLIENT:GetPointVec2() +

Returns the Point of the CLIENT.

+
CLIENT:GetUnit() + +
CLIENT:IsAlive(Returns) +

Checks if client is alive and returns true or false.

+
CLIENT:IsTransport() +

IsTransport returns if a Client is a transport.

+
CLIENT.Message(string, number, string, string, number, self, Message, MessageDuration, MessageId, MessageCategory, MessageInterval) +

Message is the key Message driver for the CLIENT class.

+
CLIENT.Messages + +
CLIENT:New(ClientName, ClientBriefing) +

Use this method to register new Clients within the MOF.

+
CLIENT.ONBOARDSIDE + +
CLIENT.Reset(string, self, ClientName) +

Resets a CLIENT.

+
CLIENT:ShowCargo() +

ShowCargo shows the CARGO within the CLIENT to the Player.

+
CLIENT.SwitchMessages(PrmTable) +

SwitchMessages is a local function called by the DCS World Menu system to switch off messages.

+
CLIENT:Transport() +

Transport defines that the Client is a Transport.

+
CLIENT:_AliveCheckCallBack() + +
CLIENT._Menus + +
CLIENT._Tasks + +
+ +

Global(s)

+
+
+ + #CLIENT + +CLIENT + +
+
+ + + +
+
+
+
+ + + +ClientGroupUnit + +
+
+ + + +
+
+

Type Client

+ +

Type CLIENT

+ +

The CLIENT class

+ +

Field(s)

+
+
+ + +CLIENT.AddBriefing(string, self, ClientBriefing) + +
+
+ +

AddBriefing adds a briefing to a Client when a Player joins a Mission.

+ +

Parameters

+
    +
  • + +

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

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    ClientBriefing :

    + +
    • +
+

Return value

+ + +

CLIENT

+ +
+
+
+
+ + +CLIENT:Alive(CallBack) + +
+
+ +

Checks for a client alive event and calls a function on a continuous basis.

+ +

Parameter

+
    +
  • + +

    #function CallBack : +Function.

    + +
    • +
+
+
+
+
+ + + +CLIENT.AliveCheckFunction + +
+
+ + + +
+
+
+
+ + #string + +CLIENT.ClassName + +
+
+ + + +
+
+
+
+ + #boolean + +CLIENT.ClientAlive + +
+
+ + + +
+
+
+
+ + #boolean + +CLIENT.ClientAlive2 + +
+
+ + + +
+
+
+
+ + #boolean + +CLIENT.ClientBriefingShown + +
+
+ + + +
+
+
+
+ + + +CLIENT.ClientCallBack + +
+
+ + + +
+
+
+
+ + +CLIENT.ClientName + +
+
+ + + +
+
+
+
+ + +CLIENT:ClientPosition() + +
+
+ +

Returns the Position of the CLIENT.

+ +

Return value

+ +

DCSTypes#Position:

+ + +
+
+
+
+ + #boolean + +CLIENT.ClientTransport + +
+
+ + + +
+
+
+
+ + +CLIENT:GetAltitude() + +
+
+ +

Returns the altitude of the CLIENT.

+ +

Return value

+ +

DCSTypes#Distance:

+ + +
+
+
+
+ + +CLIENT:GetClientGroupDCSUnit() + +
+
+ +

Returns the DCSUnit of the CLIENT.

+ +

Return value

+ + +

DCSUnit

+ +
+
+
+
+ + +CLIENT:GetClientGroupID() + +
+
+ + + +
+
+
+
+ + +CLIENT:GetClientGroupName() + +
+
+ + + +
+
+
+
+ + +CLIENT:GetClientGroupUnit() + +
+
+ +

Returns the Unit of the CLIENT.

+ +

Return value

+ +

Unit#UNIT:

+ + +
+
+
+
+ + +CLIENT:GetDCSGroup() + +
+
+ +

Return the DCSGroup of a Client.

+ + +

This function is modified to deal with a couple of bugs in DCS 1.5.3

+ +

Return value

+ +

DCSGroup#Group:

+ + +
+
+
+
+ + +CLIENT:GetPointVec2() + +
+
+ +

Returns the Point of the CLIENT.

+ +

Return value

+ +

DCSTypes#Vec2:

+ + +
+
+
+
+ + +CLIENT:GetUnit() + +
+
+ + + +
+
+
+
+ + +CLIENT:IsAlive(Returns) + +
+
+ +

Checks if client is alive and returns true or false.

+ +

Parameter

+
    +
  • + +

    #boolean Returns : +true if client is alive.

    + +
    • +
+
+
+
+
+ + +CLIENT:IsTransport() + +
+
+ +

IsTransport returns if a Client is a transport.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + +CLIENT.Message(string, number, string, string, number, self, 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

+
    +
  • + +

    string : +Message is the text describing the message.

    + +
    • +
  • + +

    number : +MessageDuration is the duration in seconds that the Message should be displayed.

    + +
    • +
  • + +

    string : +MessageId is a text identifying the Message in the MessageQueue. The Message system overwrites Messages with the same MessageId

    + +
    • +
  • + +

    string : +MessageCategory is the category of the message (the title).

    + +
    • +
  • + +

    number : +MessageInterval is the interval in seconds between the display of the Message when the CLIENT is in the air.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    Message :

    + +
    • +
  • + +

    MessageDuration :

    + +
    • +
  • + +

    MessageId :

    + +
    • +
  • + +

    MessageCategory :

    + +
    • +
  • + +

    MessageInterval :

    + +
    • +
+
+
+
+
+ + + +CLIENT.Messages + +
+
+ + + +
+
+
+
+ + +CLIENT:New(ClientName, ClientBriefing) + +
+
+ +

Use this method to register new Clients within the MOF.

+ +

Parameters

+
    +
  • + +

    #string ClientName : +Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client.

    + +
    • +
  • + +

    #string ClientBriefing : +Text that describes the briefing of the mission when a Player logs into the Client.

    + +
    • +
+

Return value

+ +

#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.ONBOARDSIDE + +
+
+ + + +
+
+
+
+ + +CLIENT.Reset(string, self, ClientName) + +
+
+ +

Resets a CLIENT.

+ +

Parameters

+
    +
  • + +

    string : +ClientName Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    ClientName :

    + +
    • +
+
+
+
+
+ + +CLIENT:ShowCargo() + +
+
+ +

ShowCargo shows the CARGO within the CLIENT to the Player.

+ + +

The CARGO is shown throught the MESSAGE system of DCS World.

+ +
+
+
+
+ + +CLIENT.SwitchMessages(PrmTable) + +
+
+ +

SwitchMessages is a local function called by the DCS World Menu system to switch off messages.

+ +

Parameter

+
    +
  • + +

    PrmTable :

    + +
    • +
+
+
+
+
+ + +CLIENT:Transport() + +
+
+ +

Transport defines that the Client is a Transport.

+ +

Return value

+ + +

CLIENT

+ +
+
+
+
+ + +CLIENT:_AliveCheckCallBack() + +
+
+ + + +
+
+
+
+ + + +CLIENT._Menus + +
+
+ + + +
+
+
+
+ + + +CLIENT._Tasks + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Moose/docs/DEPLOYTASK.html b/Moose/docs/DEPLOYTASK.html new file mode 100644 index 000000000..aeb95153b --- /dev/null +++ b/Moose/docs/DEPLOYTASK.html @@ -0,0 +1,367 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DEPLOYTASK

+ +

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

+ +

Global(s)

+ + + + + +
DEPLOYTASK + +
+

Type DEPLOYTASK

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DEPLOYTASK:AddCargoMenus(Client, Cargos, TransportRadius) + +
DEPLOYTASK.ClassName + +
DEPLOYTASK.GoalVerb + +
DEPLOYTASK:InitCargo(InitCargos) + +
DEPLOYTASK:LoadCargo(LoadCargos) + +
DEPLOYTASK.New(CargoType) +

Creates a new DEPLOYTASK object, which models the sequence of STAGEs to unload a cargo.

+
DEPLOYTASK:RemoveCargoMenus(Client) + +
DEPLOYTASK.SetCargoTargetZoneName(string, self, TargetZoneName) +

When the cargo is unloaded, it will move to the target zone name.

+
DEPLOYTASK.TEXT + +
DEPLOYTASK:ToZone(LandingZone) + +
+ +

Global(s)

+
+
+ + #DEPLOYTASK + +DEPLOYTASK + +
+
+ + + +
+
+

Type DEPLOYTASK

+ +

A DeployTask

+ +

Field(s)

+
+
+ + +DEPLOYTASK:AddCargoMenus(Client, Cargos, TransportRadius) + +
+
+ + + +

Parameters

+
    +
  • + +

    Client :

    + +
    • +
  • + +

    Cargos :

    + +
    • +
  • + +

    TransportRadius :

    + +
    • +
+
+
+
+
+ + #string + +DEPLOYTASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +DEPLOYTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DEPLOYTASK:InitCargo(InitCargos) + +
+
+ + + +

Parameter

+
    +
  • + +

    InitCargos :

    + +
    • +
+
+
+
+
+ + +DEPLOYTASK:LoadCargo(LoadCargos) + +
+
+ + + +

Parameter

+
    +
  • + +

    LoadCargos :

    + +
    • +
+
+
+
+
+ + +DEPLOYTASK.New(CargoType) + +
+
+ +

Creates a new DEPLOYTASK object, which models the sequence of STAGEs to unload a cargo.

+ +

Parameter

+
    +
  • + +

    #string CargoType : +Type of the Cargo.

    + +
    • +
+

Return value

+ +

#DEPLOYTASK: +The created DeployTask

+ +
+
+
+
+ + +DEPLOYTASK:RemoveCargoMenus(Client) + +
+
+ + + +

Parameter

+
    +
  • + +

    Client :

    + +
    • +
+
+
+
+
+ + +DEPLOYTASK.SetCargoTargetZoneName(string, self, TargetZoneName) + +
+
+ +

When the cargo is unloaded, it will move to the target zone name.

+ +

Parameters

+
    +
  • + +

    string : +TargetZoneName Name of the Zone to where the Cargo should move after unloading.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    TargetZoneName :

    + +
    • +
+
+
+
+
+ + + +DEPLOYTASK.TEXT + +
+
+ + + +
+
+
+
+ + +DEPLOYTASK:ToZone(LandingZone) + +
+
+ + + +

Parameter

+
    +
  • + +

    LandingZone :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Moose/docs/DESTROYBASETASK.html b/Moose/docs/DESTROYBASETASK.html new file mode 100644 index 000000000..994753ee6 --- /dev/null +++ b/Moose/docs/DESTROYBASETASK.html @@ -0,0 +1,325 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DESTROYBASETASK

+ +

A DESTROYBASETASK will monitor the destruction of Groups and Units.

+ + +

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

+ +

Global(s)

+ + + + + +
DESTROYBASETASK + +
+

Type DESTROYBASETASK

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DESTROYBASETASK.ClassName + +
DESTROYBASETASK.DestroyPercentage + +
DESTROYBASETASK.Destroyed + +
DESTROYBASETASK.EventDead(event, self) +

Handle the SEVENTDEAD events to validate the destruction of units for the task monitoring.

+
DESTROYBASETASK.GoalVerb + +
DESTROYBASETASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupPrefixes, DestroyPercentage) +

Creates a new DESTROYBASETASK.

+
DESTROYBASETASK.ReportGoalProgress(DestroyGroup, DestroyUnit, self) +

Validate task completeness of DESTROYBASETASK.

+
+ +

Global(s)

+
+
+ + #DESTROYBASETASK + +DESTROYBASETASK + +
+
+ + + +
+
+

Type DESTROYBASETASK

+ +

The DESTROYBASETASK class

+ +

Field(s)

+
+
+ + #string + +DESTROYBASETASK.ClassName + +
+
+ + + +
+
+
+
+ + #number + +DESTROYBASETASK.DestroyPercentage + +
+
+ + + +
+
+
+
+ + #number + +DESTROYBASETASK.Destroyed + +
+
+ + + +
+
+
+
+ + +DESTROYBASETASK.EventDead(event, self) + +
+
+ +

Handle the SEVENTDEAD events to validate the destruction of units for the task monitoring.

+ +

Parameters

+
    +
  • + +

    event :

    +
        Event structure of DCS world.
+
    + +
    • +
  • + +

    self :

    + +
    • +
+
+
+
+
+ + #string + +DESTROYBASETASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DESTROYBASETASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupPrefixes, DestroyPercentage) + +
+
+ +

Creates a new DESTROYBASETASK.

+ +

Parameters

+
    +
  • + +

    string : +DestroyGroupType Text describing the group to be destroyed. f.e. "Radar Installations", "Ships", "Vehicles", "Command Centers".

    + +
    • +
  • + +

    string : +DestroyUnitType Text describing the unit types to be destroyed. f.e. "SA-6", "Row Boats", "Tanks", "Tents".

    + +
    • +
  • + +

    table : +string,...} DestroyGroupPrefixes Table of Prefixes of the Groups to be destroyed before task is completed.

    + +
    • +
  • + +

    ? : +umber DestroyPercentage 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.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroupType :

    + +
    • +
  • + +

    DestroyUnitType :

    + +
    • +
  • + +

    DestroyGroupPrefixes :

    + +
    • +
  • + +

    DestroyPercentage :

    + +
    • +
+

Return value

+ + +

DESTROYBASETASK

+ +
+
+
+
+ + +DESTROYBASETASK.ReportGoalProgress(DestroyGroup, DestroyUnit, self) + +
+
+ +

Validate task completeness of DESTROYBASETASK.

+ +

Parameters

+
    +
  • + +

    DestroyGroup :

    +
        Group structure describing the group to be evaluated.
+
    + +
    • +
  • + +

    DestroyUnit :

    +
        Unit structure describing the Unit to be evaluated.
+
    + +
    • +
  • + +

    self :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Moose/docs/DESTROYGROUPSTASK.html b/Moose/docs/DESTROYGROUPSTASK.html new file mode 100644 index 000000000..4f7b31928 --- /dev/null +++ b/Moose/docs/DESTROYGROUPSTASK.html @@ -0,0 +1,249 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DESTROYGROUPSTASK

+ +

DESTROYGROUPSTASK

+ +

Global(s)

+ + + + + +
DESTROYGROUPSTASK + +
+

Type DESTROYGROUPSTASK

+ + + + + + + + + + + + + + + + + +
DESTROYGROUPSTASK.ClassName + +
DESTROYGROUPSTASK.GoalVerb + +
DESTROYGROUPSTASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyPercentage) +

Creates a new DESTROYGROUPSTASK.

+
DESTROYGROUPSTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) +

Report Goal Progress.

+
+ +

Global(s)

+
+
+ + #DESTROYGROUPSTASK + +DESTROYGROUPSTASK + +
+
+ + + +
+
+

Type DESTROYGROUPSTASK

+

Field(s)

+
+
+ + #string + +DESTROYGROUPSTASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +DESTROYGROUPSTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DESTROYGROUPSTASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyPercentage) + +
+
+ +

Creates a new DESTROYGROUPSTASK.

+ +

Parameters

+
    +
  • + +

    string : +DestroyGroupType String describing the group to be destroyed.

    + +
    • +
  • + +

    string : +DestroyUnitType String describing the unit to be destroyed.

    + +
    • +
  • + +

    table : +string,...} DestroyGroupNames Table of string containing the name of the groups to be destroyed before task is completed.

    + +
    • +
  • + +

    ? : +umber DestroyPercentage 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. +-@return DESTROYGROUPSTASK

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroupType :

    + +
    • +
  • + +

    DestroyUnitType :

    + +
    • +
  • + +

    DestroyGroupNames :

    + +
    • +
  • + +

    DestroyPercentage :

    + +
    • +
+
+
+
+
+ + +DESTROYGROUPSTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) + +
+
+ +

Report Goal Progress.

+ +

Parameters

+
    +
  • + +

    Group : +DestroyGroup Group structure describing the group to be evaluated.

    + +
    • +
  • + +

    Unit : +DestroyUnit Unit structure describing the Unit to be evaluated.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroup :

    + +
    • +
  • + +

    DestroyUnit :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Moose/docs/DESTROYRADARSTASK.html b/Moose/docs/DESTROYRADARSTASK.html new file mode 100644 index 000000000..c4b394646 --- /dev/null +++ b/Moose/docs/DESTROYRADARSTASK.html @@ -0,0 +1,220 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DESTROYRADARSTASK

+ +

Task class to destroy radar installations.

+ +

Global(s)

+ + + + + +
DESTROYRADARSTASK + +
+

Type DESTROYRADARSTASK

+ + + + + + + + + + + + + + + + + +
DESTROYRADARSTASK.ClassName + +
DESTROYRADARSTASK.GoalVerb + +
DESTROYRADARSTASK.New(table, self, DestroyGroupNames) +

Creates a new DESTROYRADARSTASK.

+
DESTROYRADARSTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) +

Report Goal Progress.

+
+ +

Global(s)

+
+
+ + #DESTROYRADARSTASK + +DESTROYRADARSTASK + +
+
+ + + +
+
+

Type DESTROYRADARSTASK

+

Field(s)

+
+
+ + #string + +DESTROYRADARSTASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +DESTROYRADARSTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DESTROYRADARSTASK.New(table, self, DestroyGroupNames) + +
+
+ +

Creates a new DESTROYRADARSTASK.

+ +

Parameters

+
    +
  • + +

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

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroupNames :

    + +
    • +
+

Return value

+ + +

DESTROYRADARSTASK

+ +
+
+
+
+ + +DESTROYRADARSTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) + +
+
+ +

Report Goal Progress.

+ +

Parameters

+
    +
  • + +

    Group : +DestroyGroup Group structure describing the group to be evaluated.

    + +
    • +
  • + +

    Unit : +DestroyUnit Unit structure describing the Unit to be evaluated.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroup :

    + +
    • +
  • + +

    DestroyUnit :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Moose/docs/DESTROYUNITTYPESTASK.html b/Moose/docs/DESTROYUNITTYPESTASK.html new file mode 100644 index 000000000..e8518007f --- /dev/null +++ b/Moose/docs/DESTROYUNITTYPESTASK.html @@ -0,0 +1,253 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DESTROYUNITTYPESTASK

+ +

Set TASK to destroy certain unit types.

+ +

Global(s)

+ + + + + +
DESTROYUNITTYPESTASK + +
+

Type DESTROYUNITTYPESTASK

+ + + + + + + + + + + + + + + + + +
DESTROYUNITTYPESTASK.ClassName + +
DESTROYUNITTYPESTASK.GoalVerb + +
DESTROYUNITTYPESTASK.New(string, string, table, string, self, DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyUnitTypes) +

Creates a new DESTROYUNITTYPESTASK.

+
DESTROYUNITTYPESTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) +

Report Goal Progress.

+
+ +

Global(s)

+
+
+ + #DESTROYUNITTYPESTASK + +DESTROYUNITTYPESTASK + +
+
+ + + +
+
+

Type DESTROYUNITTYPESTASK

+

Field(s)

+
+
+ + #string + +DESTROYUNITTYPESTASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +DESTROYUNITTYPESTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DESTROYUNITTYPESTASK.New(string, string, table, string, self, DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyUnitTypes) + +
+
+ +

Creates a new DESTROYUNITTYPESTASK.

+ +

Parameters

+
    +
  • + +

    string : +DestroyGroupType String describing the group to be destroyed. f.e. "Radar Installations", "Fleet", "Batallion", "Command Centers".

    + +
    • +
  • + +

    string : +DestroyUnitType String describing the unit to be destroyed. f.e. "radars", "ships", "tanks", "centers".

    + +
    • +
  • + +

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

    + +
    • +
  • + +

    string : +DestroyUnitTypes Table of string containing the type names of the units to achieve mission success.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroupType :

    + +
    • +
  • + +

    DestroyUnitType :

    + +
    • +
  • + +

    DestroyGroupNames :

    + +
    • +
  • + +

    DestroyUnitTypes :

    + +
    • +
+

Return value

+ + +

DESTROYUNITTYPESTASK

+ +
+
+
+
+ + +DESTROYUNITTYPESTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) + +
+
+ +

Report Goal Progress.

+ +

Parameters

+
    +
  • + +

    Group : +DestroyGroup Group structure describing the group to be evaluated.

    + +
    • +
  • + +

    Unit : +DestroyUnit Unit structure describing the Unit to be evaluated.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroup :

    + +
    • +
  • + +

    DestroyUnit :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Moose/docs/Database.html b/Moose/docs/Database.html new file mode 100644 index 000000000..533ff293a --- /dev/null +++ b/Moose/docs/Database.html @@ -0,0 +1,995 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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).

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ClientGroup + +
DATABASE + +
DATABASECategory + +
DATABASECoalition + +
InitGroup + +
InitUnitDesc + +
LogClose() + +
TargetGroup + +
TargetUnitDesc + +
nHours + +
nMins + +
nSecs + +
+

Type DATABASE

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DATABASE.ActivePlayers + +
DATABASE.ClassName + +
DATABASE.ClientsByID + +
DATABASE.ClientsByName + +
DATABASE:GetStatusGroup(GroupName) +

Get a status to a Group within the Database, this to check crossing events for example.

+
DATABASE.Groups + +
DATABASE.NavPoints + +
DATABASE:New() +

Creates a new DATABASE Object to administer the Groups defined and alive within the DCSRTE.

+
DATABASE:OnDeadOrCrash(event) +

Track DCSRTE DEAD or CRASH events for the internal scoring.

+
DATABASE:OnHit(event) + +
DATABASE.Players + +
DATABASE:ReportScoreAll() + +
DATABASE:ReportScorePlayer() + +
DATABASE:ScoreAdd(PlayerName, ScoreType, ScoreTimes, ScoreAmount, PlayerUnitName, PlayerUnitCoalition, PlayerUnitCategory, PlayerUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType) + +
DATABASE:ScoreMenu() + +
DATABASE:ScoreOpen() + +
DATABASE:SecondsToClock(sSeconds) + +
DATABASE:SetStatusGroup(GroupName, Status) +

Set a status to a Group within the Database, this to check crossing events for example.

+
DATABASE:Spawn(SpawnTemplate) +

Instantiate new Groups within the DCSRTE.

+
DATABASE.Statics + +
DATABASE.Units + +
DATABASE:_AddMissionScore(MissionName, Score) +

Registers Mission Scores for possible multiple players that contributed in the Mission.

+
DATABASE:_AddMissionTaskScore(PlayerUnit, MissionName, Score) +

Registers Scores the players completing a Mission Task.

+
DATABASE:_AddPlayerFromUnit(UnitData) +

Add a new player entering a Unit.

+
DATABASE:_FollowPlayers() +

Follows new players entering Clients within the DCSRTE.

+
DATABASE:_RegisterGroup(GroupTemplate) +

Registers new Group Templates within the DATABASE Object.

+
+ +

Global(s)

+
+
+ + + +ClientGroup + +
+
+ + + +
+
+
+
+ + #DATABASE + +DATABASE + +
+
+ + + +
+
+
+
+ + + +DATABASECategory + +
+
+ + + +
+
+
+
+ + + +DATABASECoalition + +
+
+ + + +
+
+
+
+ + + +InitGroup + +
+
+ + + +
+
+
+
+ + + +InitUnitDesc + +
+
+ + + +
+
+
+
+ + +LogClose() + +
+
+ + + +
+
+
+
+ + + +TargetGroup + +
+
+ + + +
+
+
+
+ + + +TargetUnitDesc + +
+
+ + + +
+
+
+
+ + + +nHours + +
+
+ + + +
+
+
+
+ + + +nMins + +
+
+ + + +
+
+
+
+ + + +nSecs + +
+
+ + + +
+
+

Type Database

+ +

Type DATABASE

+ +

The DATABASE class

+ +

Field(s)

+
+
+ + + +DATABASE.ActivePlayers + +
+
+ + + +
+
+
+
+ + #string + +DATABASE.ClassName + +
+
+ + + +
+
+
+
+ + + +DATABASE.ClientsByID + +
+
+ + + +
+
+
+
+ + + +DATABASE.ClientsByName + +
+
+ + + +
+
+
+
+ + +DATABASE:GetStatusGroup(GroupName) + +
+
+ +

Get a status to a Group within the Database, this to check crossing events for example.

+ +

Parameter

+
    +
  • + +

    GroupName :

    + +
    • +
+
+
+
+
+ + + +DATABASE.Groups + +
+
+ + + +
+
+
+
+ + + +DATABASE.NavPoints + +
+
+ + + +
+
+
+
+ + +DATABASE:New() + +
+
+ +

Creates a new DATABASE Object to administer the Groups defined and alive within the DCSRTE.

+ +

Return value

+ + +

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:OnDeadOrCrash(event) + +
+
+ +

Track DCSRTE DEAD or CRASH events for the internal scoring.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +DATABASE:OnHit(event) + +
+
+ + + +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + + +DATABASE.Players + +
+
+ + + +
+
+
+
+ + +DATABASE:ReportScoreAll() + +
+
+ + + +
+
+
+
+ + +DATABASE:ReportScorePlayer() + +
+
+ + + +
+
+
+
+ + +DATABASE:ScoreAdd(PlayerName, ScoreType, ScoreTimes, ScoreAmount, PlayerUnitName, PlayerUnitCoalition, PlayerUnitCategory, PlayerUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType) + +
+
+ + + +

Parameters

+
    +
  • + +

    PlayerName :

    + +
    • +
  • + +

    ScoreType :

    + +
    • +
  • + +

    ScoreTimes :

    + +
    • +
  • + +

    ScoreAmount :

    + +
    • +
  • + +

    PlayerUnitName :

    + +
    • +
  • + +

    PlayerUnitCoalition :

    + +
    • +
  • + +

    PlayerUnitCategory :

    + +
    • +
  • + +

    PlayerUnitType :

    + +
    • +
  • + +

    TargetUnitName :

    + +
    • +
  • + +

    TargetUnitCoalition :

    + +
    • +
  • + +

    TargetUnitCategory :

    + +
    • +
  • + +

    TargetUnitType :

    + +
    • +
+
+
+
+
+ + +DATABASE:ScoreMenu() + +
+
+ + + +
+
+
+
+ + +DATABASE:ScoreOpen() + +
+
+ + + +
+
+
+
+ + +DATABASE:SecondsToClock(sSeconds) + +
+
+ + + +

Parameter

+
    +
  • + +

    sSeconds :

    + +
    • +
+
+
+
+
+ + +DATABASE:SetStatusGroup(GroupName, Status) + +
+
+ +

Set a status to a Group within the Database, this to check crossing events for example.

+ +

Parameters

+
    +
  • + +

    GroupName :

    + +
    • +
  • + +

    Status :

    + +
    • +
+
+
+
+
+ + +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.

+ +

Parameter

+
    +
  • + +

    SpawnTemplate :

    + +
    • +
+
+
+
+
+ + + +DATABASE.Statics + +
+
+ + + +
+
+
+
+ + + +DATABASE.Units + +
+
+ + + +
+
+
+
+ + +DATABASE:_AddMissionScore(MissionName, Score) + +
+
+ +

Registers Mission Scores for possible multiple players that contributed in the Mission.

+ +

Parameters

+
    +
  • + +

    MissionName :

    + +
    • +
  • + +

    Score :

    + +
    • +
+
+
+
+
+ + +DATABASE:_AddMissionTaskScore(PlayerUnit, MissionName, Score) + +
+
+ +

Registers Scores the players completing a Mission Task.

+ +

Parameters

+
    +
  • + +

    PlayerUnit :

    + +
    • +
  • + +

    MissionName :

    + +
    • +
  • + +

    Score :

    + +
    • +
+
+
+
+
+ + +DATABASE:_AddPlayerFromUnit(UnitData) + +
+
+ +

Add a new player entering a Unit.

+ +

Parameter

+
    +
  • + +

    UnitData :

    + +
    • +
+
+
+
+
+ + +DATABASE:_FollowPlayers() + +
+
+ +

Follows new players entering Clients within the DCSRTE.

+ +
+
+
+
+ + +DATABASE:_RegisterGroup(GroupTemplate) + +
+
+ +

Registers new Group Templates within the DATABASE Object.

+ +

Parameter

+
    +
  • + +

    GroupTemplate :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Moose/docs/GOHOMETASK.html b/Moose/docs/GOHOMETASK.html new file mode 100644 index 000000000..606359a73 --- /dev/null +++ b/Moose/docs/GOHOMETASK.html @@ -0,0 +1,151 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module GOHOMETASK

+ +

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

+ +

Global(s)

+ + + + + +
GOHOMETASK + +
+

Type GOHOMETASK

+ + + + + + + + + +
GOHOMETASK.ClassName + +
GOHOMETASK.New(table, self, LandingZones) +

Creates a new GOHOMETASK.

+
+ +

Global(s)

+
+
+ + #GOHOMETASK + +GOHOMETASK + +
+
+ + + +
+
+

Type GOHOMETASK

+

Field(s)

+
+
+ + #string + +GOHOMETASK.ClassName + +
+
+ + + +
+
+
+
+ + +GOHOMETASK.New(table, self, LandingZones) + +
+
+ +

Creates a new GOHOMETASK.

+ +

Parameters

+
    +
  • + +

    table : +string,...}|string LandingZones Table of Landing Zone names where Home(s) are located.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    LandingZones :

    + +
    • +
+

Return value

+ + +

GOHOMETASK

+ +
+
+ +
+ +
+ + diff --git a/Moose/docs/Group.html b/Moose/docs/Group.html new file mode 100644 index 000000000..bdc4e2a1c --- /dev/null +++ b/Moose/docs/Group.html @@ -0,0 +1,2151 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Group

+ +

A GROUP class abstraction of a DCSGroup class.

+ + +

The GROUP class will take an abstraction of the DCSGroup class, providing more methods that can be done with a GROUP.

+ +

Global(s)

+ + + + + +
GROUP + +
+

Type DCSGroup

+ + + + + +
DCSGroup.id_ +

The ID of the group in DCS

+
+ +

Type GROUP

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
GROUP:Activate() +

Activates a GROUP.

+
GROUP:AllOnGround() +

Returns if all units of the group are on the ground or landed.

+
GROUP.ClassName + +
GROUP.Controller +

The controller of the group.

+
GROUP:CopyRoute(Begin, End, Randomize, Radius) +

Return the route of a group by using the Database#DATABASE class.

+
GROUP.DCSGroup +

The DCS group class.

+
GROUP:Destroy() +

Destroy a GROUP +Note that this destroy method also raises a destroy event at run-time.

+
GROUP.FindGroup(Group, DCSGroup) +

Find the created GROUP using the DCSGroup ID.

+
GROUP:GetCallsign() +

Gets the callsign of the fist unit of the group.

+
GROUP:GetDCSGroup() +

Gets the DCSGroup of the GROUP.

+
GROUP:GetDCSUnit(UnitNumber) +

Gets the DCS Unit of the GROUP.

+
GROUP:GetDetectedTargets() + +
GROUP:GetID() +

Gets the ID of the GROUP.

+
GROUP:GetMaxHeight() +

Returns the current maximum height of the group.

+
GROUP:GetMaxVelocity() +

Returns the current maximum velocity of the group.

+
GROUP:GetMinHeight() +

Returns the current minimum height of the group.

+
GROUP:GetName() +

Gets the name of the GROUP.

+
GROUP:GetPointVec2() +

Gets the current Point of the GROUP in VEC3 format.

+
GROUP:GetPositionVec3() +

Gets the current Point of the GROUP in VEC3 format.

+
GROUP:GetTaskMission() +

Return the mission template of the group.

+
GROUP:GetTaskRoute() +

Return the mission route of the group.

+
GROUP:GetTypeName() +

Gets the type name of the group.

+
GROUP:GetUnit(UnitNumber) +

Gets the DCS Unit.

+
GROUP.GroupID +

the ID of the group.

+
GROUP.GroupName +

The name of the group.

+
GROUP:IsAir() +

Returns if the group is of an air category.

+
GROUP:IsAlive() +

Returns if the group is alive.

+
GROUP:IsTargetDetected(DCSObject) + +
GROUP:Message(Message, Duration) +

Returns a message for a coalition or a client.

+
GROUP:MessageToAll(Message, Duration) +

Send a message to all coalitions.

+
GROUP:MessageToBlue(Message, Duration) +

Send a message to the blue coalition.

+
GROUP:MessageToClient(Message, Duration, Client) +

Send a message to a client.

+
GROUP:MessageToRed(Message, Duration) +

Send a message to the red coalition.

+
GROUP:New(DCSGroup) +

Create a new GROUP from a DCSGroup

+
GROUP:NewFromDCSUnit(DCSUnit) +

Create a new GROUP from an existing DCSUnit in the mission.

+
GROUP:NewFromName(GroupName) +

Create a new GROUP from an existing group name.

+
GROUP:OptionROEHoldFire() +

Holding weapons.

+
GROUP:OptionROEOpenFire() +

Openfire.

+
GROUP:OptionROEReturnFire() +

Return fire.

+
GROUP:OptionROEWeaponFree() +

Weapon free.

+
GROUP:OptionROTEvadeFire() +

Evade fire.

+
GROUP:OptionROTNoReaction() +

No evasion on enemy threats.

+
GROUP:OptionROTPassiveDefense() +

Evasion passive defense.

+
GROUP:OptionROTVertical() +

Vertical manoeuvres.

+
GROUP:PopCurrentTask() +

Popping current Task from the group.

+
GROUP:PushTask(DCSTask) +

Pushing Task on the queue from the group.

+
GROUP:RegisterWayPoint(WayPoint) + +
GROUP:Route(GoPoints) +

Make the group to follow a given route.

+
GROUP:SetTask(DCSTask) +

Clearing the Task Queue and Setting the Task on the queue from the group.

+
GROUP:TaskAttackUnit(The, AttackUnit) +

Attack the Unit.

+
GROUP:TaskCondition(time, userFlag, userFlagValue, condition, duration, lastWayPoint) +

Return a condition section for a controlled task

+
GROUP:TaskControlled(DCSTask, DCSStopCondition) +

Return a Controlled Task taking a Task and a TaskCondition

+
GROUP:TaskEmbarkToTransportAtVec2(Point, Radius) +

Move to a defined Vec2 Point, and embark to a group when arrived within a defined Radius.

+
GROUP:TaskEmbarkingAtVec2(Point, Duration, EmbarkingGroup) +

Move the group to a Vec2 Point, wait for a defined duration and embark a group.

+
GROUP:TaskHoldPosition(Duration) +

Hold position at the current position of the first unit of the group.

+
GROUP:TaskLandAtVec2(Point, Duration) +

Land the group at a Vec2Point.

+
GROUP:TaskLandAtZone(Zone, Duration) +

Land the group at a @{Zone#ZONE).

+
GROUP:TaskMission(TaskMission) +

Return a Misson task from a mission template.

+
GROUP:TaskOrbitCircle(Altitude, Speed) +

Orbit at the current position of the first unit of the group at a specified alititude

+
GROUP:TaskOrbitCircleAtVec2(Point, Altitude, Speed) +

Orbit at a specified position at a specified alititude during a specified duration with a specified speed.

+
GROUP:TaskRegisterWayPoint(WayPoint) + +
GROUP:TaskRoute(Points) +

Return a Misson task to follow a given route defined by Points.

+
GROUP:TaskRouteToVec3(Point, Speed) +

Make the group to fly to a given point and hover.

+
GROUP:TaskRouteToZone(Zone, Randomize, Speed, Formation) +

Route the group to a given zone.

+
GROUP:_GetController() +

Get the controller for the GROUP.

+
+ +

Type Vec3

+ + + + + + + + + +
Vec3.x + +
Vec3.y + +
+ +

Global(s)

+
+
+ + #GROUP + +GROUP + +
+
+ + + +
+
+

Type Group

+ +

Type DCSGroup

+ +

A DCSGroup

+ +

Field(s)

+
+
+ + +DCSGroup.id_ + +
+
+ +

The ID of the group in DCS

+ +
+
+ +

Type DCSStopCondition

+ +

Type DCSTask

+ +

Type Duration

+ +

Type GROUP

+ +

The GROUP class

+ +

Field(s)

+
+
+ + +GROUP:Activate() + +
+
+ +

Activates a GROUP.

+ +
+
+
+
+ + +GROUP:AllOnGround() + +
+
+ +

Returns if all units of the group are on the ground or landed.

+ + +

If all units of this group are on the ground, this function will return true, otherwise false.

+ +

Return value

+ +

#boolean: +All units on the ground result.

+ +
+
+
+
+ + #string + +GROUP.ClassName + +
+
+ + + +
+
+
+
+ + #table + +GROUP.Controller + +
+
+ +

The controller of the group.

+ +
+
+
+
+ + +GROUP:CopyRoute(Begin, End, Randomize, Radius) + +
+
+ +

Return the route of a group by using the Database#DATABASE class.

+ +

Parameters

+
    +
  • + +

    #number Begin : +The route point from where the copy will start. The base route point is 0.

    + +
    • +
  • + +

    #number End : +The route point where the copy will end. The End point is the last point - the End point. The last point has base 0.

    + +
    • +
  • + +

    #boolean Randomize : +Randomization of the route, when true.

    + +
    • +
  • + +

    #number Radius : +When randomization is on, the randomization is within the radius.

    + +
    • +
+
+
+
+
+ + DCSGroup#Group + +GROUP.DCSGroup + +
+
+ +

The DCS group class.

+ +
+
+
+
+ + +GROUP:Destroy() + +
+
+ +

Destroy a GROUP +Note that this destroy method also raises a destroy event at run-time.

+ + +

So all event listeners will catch the destroy event of this GROUP.

+ +
+
+
+
+ + +GROUP.FindGroup(Group, DCSGroup) + +
+
+ +

Find the created GROUP using the DCSGroup ID.

+ + +

If a GROUP was created with the DCSGroupID, the the GROUP instance will be returned. +Otherwise nil will be returned.

+ +

Parameters

+ +

Return value

+ +

#GROUP:

+ + +
+
+
+
+ + +GROUP:GetCallsign() + +
+
+ +

Gets the callsign of the fist unit of the group.

+ +

Return value

+ +

#string: +The callsign of the first unit of the group.

+ +
+
+
+
+ + +GROUP:GetDCSGroup() + +
+
+ +

Gets the DCSGroup of the GROUP.

+ +

Return value

+ +

#Group: +The DCSGroup.

+ +
+
+
+
+ + +GROUP:GetDCSUnit(UnitNumber) + +
+
+ +

Gets the DCS Unit of the GROUP.

+ +

Parameter

+
    +
  • + +

    #number UnitNumber : +The unit index to be returned from the GROUP.

    + +
    • +
+

Return value

+ +

#Unit: +The DCS Unit.

+ +
+
+
+
+ + +GROUP:GetDetectedTargets() + +
+
+ + + +
+
+
+
+ + +GROUP:GetID() + +
+
+ +

Gets the ID of the GROUP.

+ +

Return value

+ +

#number: +The ID of the GROUP.

+ +
+
+
+
+ + +GROUP:GetMaxHeight() + +
+
+ +

Returns the current maximum height of the group.

+ + +

Each unit within the group gets evaluated, and the maximum height (= the unit which is the highest elevated) is returned.

+ +

Return value

+ +

#number: +Maximum height found.

+ +
+
+
+
+ + +GROUP:GetMaxVelocity() + +
+
+ +

Returns the current maximum velocity of the group.

+ + +

Each unit within the group gets evaluated, and the maximum velocity (= the unit which is going the fastest) is returned.

+ +

Return value

+ +

#number: +Maximum velocity found.

+ +
+
+
+
+ + +GROUP:GetMinHeight() + +
+
+ +

Returns the current minimum height of the group.

+ + +

Each unit within the group gets evaluated, and the minimum height (= the unit which is the lowest elevated) is returned.

+ +

Return value

+ +

#number: +Minimum height found.

+ +
+
+
+
+ + +GROUP:GetName() + +
+
+ +

Gets the name of the GROUP.

+ +

Return value

+ +

#string: +The name of the GROUP.

+ +
+
+
+
+ + +GROUP:GetPointVec2() + +
+
+ +

Gets the current Point of the GROUP in VEC3 format.

+ +

Return value

+ +

#Vec3: +Current x,y and z position of the group.

+ +
+
+
+
+ + +GROUP:GetPositionVec3() + +
+
+ +

Gets the current Point of the GROUP in VEC3 format.

+ +

Return value

+ +

#Vec3: +Current Vec3 position of the group.

+ +
+
+
+
+ + +GROUP:GetTaskMission() + +
+
+ +

Return the mission template of the group.

+ +

Return value

+ +

#table: +The MissionTemplate

+ +
+
+
+
+ + +GROUP:GetTaskRoute() + +
+
+ +

Return the mission route of the group.

+ +

Return value

+ +

#table: +The mission route defined by points.

+ +
+
+
+
+ + +GROUP:GetTypeName() + +
+
+ +

Gets the type name of the group.

+ +

Return value

+ +

#string: +The type name of the group.

+ +
+
+
+
+ + +GROUP:GetUnit(UnitNumber) + +
+
+ +

Gets the DCS Unit.

+ +

Parameter

+
    +
  • + +

    #number UnitNumber : +The number of the Unit to be returned.

    + +
    • +
+

Return value

+ +

Unit#UNIT: +The DCS Unit.

+ +
+
+
+
+ + #number + +GROUP.GroupID + +
+
+ +

the ID of the group.

+ +
+
+
+
+ + #string + +GROUP.GroupName + +
+
+ +

The name of the group.

+ +
+
+
+
+ + +GROUP:IsAir() + +
+
+ +

Returns if the group is of an air category.

+ + +

If the group is a helicopter or a plane, then this method will return true, otherwise false.

+ +

Return value

+ +

#boolean: +Air category evaluation result.

+ +
+
+
+
+ + +GROUP:IsAlive() + +
+
+ +

Returns if the group is alive.

+ + +

When the group exists at run-time, this method will return true, otherwise false.

+ +

Return value

+ +

#boolean: +Alive result.

+ +
+
+
+
+ + +GROUP:IsTargetDetected(DCSObject) + +
+
+ + + +

Parameter

+
    +
  • + +

    DCSObject :

    + +
    • +
+
+
+
+
+ + +GROUP:Message(Message, Duration) + +
+
+ +

Returns a message for a coalition or a client.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
+

Return value

+ +

Message#MESSAGE:

+ + +
+
+
+
+ + +GROUP:MessageToAll(Message, Duration) + +
+
+ +

Send a message to all coalitions.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
+
+
+
+
+ + +GROUP:MessageToBlue(Message, Duration) + +
+
+ +

Send a message to the blue coalition.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
+
+
+
+
+ + +GROUP:MessageToClient(Message, Duration, Client) + +
+
+ +

Send a message to a client.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
  • + +

    Client#CLIENT Client : +The client object receiving the message.

    + +
    • +
+
+
+
+
+ + +GROUP:MessageToRed(Message, Duration) + +
+
+ +

Send a message to the red coalition.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
+
+
+
+
+ + +GROUP:New(DCSGroup) + +
+
+ +

Create a new GROUP from a DCSGroup

+ +

Parameter

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:NewFromDCSUnit(DCSUnit) + +
+
+ +

Create a new GROUP from an existing DCSUnit in the mission.

+ +

Parameter

+
    +
  • + +

    DCSUnit : +The DCSUnit.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:NewFromName(GroupName) + +
+
+ +

Create a new GROUP from an existing group name.

+ +

Parameter

+
    +
  • + +

    GroupName : +The name of the DCS Group.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROEHoldFire() + +
+
+ +

Holding weapons.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROEOpenFire() + +
+
+ +

Openfire.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROEReturnFire() + +
+
+ +

Return fire.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROEWeaponFree() + +
+
+ +

Weapon free.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROTEvadeFire() + +
+
+ +

Evade fire.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROTNoReaction() + +
+
+ +

No evasion on enemy threats.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROTPassiveDefense() + +
+
+ +

Evasion passive defense.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROTVertical() + +
+
+ +

Vertical manoeuvres.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:PopCurrentTask() + +
+
+ +

Popping current Task from the group.

+ +

Return value

+ +

Group#GROUP: +self

+ +
+
+
+
+ + +GROUP:PushTask(DCSTask) + +
+
+ +

Pushing Task on the queue from the group.

+ +

Parameter

+
    +
  • + +

    DCSTask :

    + +
    • +
+

Return value

+ +

Group#GROUP: +self

+ +
+
+
+
+ + +GROUP:RegisterWayPoint(WayPoint) + +
+
+ + + +

Parameter

+
    +
  • + +

    WayPoint :

    + +
    • +
+
+
+
+
+ + +GROUP:Route(GoPoints) + +
+
+ +

Make the group to follow a given route.

+ +

Parameter

+
    +
  • + +

    #table GoPoints : +A table of Route Points.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:SetTask(DCSTask) + +
+
+ +

Clearing the Task Queue and Setting the Task on the queue from the group.

+ +

Parameter

+
    +
  • + +

    DCSTask :

    + +
    • +
+

Return value

+ +

Group#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskAttackUnit(The, AttackUnit) + +
+
+ +

Attack the Unit.

+ +

Parameters

+
    +
  • + +

    Unit#UNIT The : +unit.

    + +
    • +
  • + +

    AttackUnit :

    + +
    • +
+

Return value

+ +

#DCSTask: +The DCS task structure.

+ +
+
+
+
+ + +GROUP:TaskCondition(time, userFlag, userFlagValue, condition, duration, lastWayPoint) + +
+
+ +

Return a condition section for a controlled task

+ +

Parameters

+
    +
  • + +

    #Time time :

    + +
    • +
  • + +

    #string userFlag :

    + +
    • +
  • + +

    #boolean userFlagValue :

    + +
    • +
  • + +

    #string condition :

    + +
    • +
  • + +

    #Time duration :

    + +
    • +
  • + +

    #number lastWayPoint :

    + +

    return #DCSTask

    + +
    • +
+
+
+
+
+ + +GROUP:TaskControlled(DCSTask, DCSStopCondition) + +
+
+ +

Return a Controlled Task taking a Task and a TaskCondition

+ +

Parameters

+ +

Return value

+ +

#DCSTask:

+ + +
+
+
+
+ + +GROUP:TaskEmbarkToTransportAtVec2(Point, Radius) + +
+
+ +

Move to a defined Vec2 Point, and embark to a group when arrived within a defined Radius.

+ +

Parameters

+
    +
  • + +

    #Vec2 Point : +The point where to wait.

    + +
    • +
  • + +

    #number Radius : +The radius of the embarking zone around the Point.

    + +
    • +
+

Return value

+ +

#DCSTask: +The DCS task structure.

+ +
+
+
+
+ + +GROUP:TaskEmbarkingAtVec2(Point, Duration, EmbarkingGroup) + +
+
+ +

Move the group to a Vec2 Point, wait for a defined duration and embark a group.

+ +

Parameters

+
    +
  • + +

    #Vec2 Point : +The point where to wait.

    + +
    • +
  • + +

    #number Duration : +The duration in seconds to wait.

    + +
    • +
  • + +

    #GROUP EmbarkingGroup : +The group to be embarked.

    + +
    • +
+

Return value

+ +

#DCSTask: +The DCS task structure

+ +
+
+
+
+ + +GROUP:TaskHoldPosition(Duration) + +
+
+ +

Hold position at the current position of the first unit of the group.

+ +

Parameter

+
    +
  • + +

    #number Duration : +The maximum duration in seconds to hold the position.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskLandAtVec2(Point, Duration) + +
+
+ +

Land the group at a Vec2Point.

+ +

Parameters

+
    +
  • + +

    #Vec2 Point : +The point where to land.

    + +
    • +
  • + +

    #number Duration : +The duration in seconds to stay on the ground.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskLandAtZone(Zone, Duration) + +
+
+ +

Land the group at a @{Zone#ZONE).

+ +

Parameters

+
    +
  • + +

    Zone#ZONE Zone : +The zone where to land.

    + +
    • +
  • + +

    #number Duration : +The duration in seconds to stay on the ground.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskMission(TaskMission) + +
+
+ +

Return a Misson task from a mission template.

+ +

Parameter

+
    +
  • + +

    #table TaskMission : +A table containing the mission task.

    + +
    • +
+

Return value

+ +

#DCSTask:

+ + +
+
+
+
+ + +GROUP:TaskOrbitCircle(Altitude, Speed) + +
+
+ +

Orbit at the current position of the first unit of the group at a specified alititude

+ +

Parameters

+
    +
  • + +

    #number Altitude : +The altitude to hold the position.

    + +
    • +
  • + +

    #number Speed : +The speed flying when holding the position.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskOrbitCircleAtVec2(Point, Altitude, Speed) + +
+
+ +

Orbit at a specified position at a specified alititude during a specified duration with a specified speed.

+ +

Parameters

+
    +
  • + +

    #Vec2 Point : +The point to hold the position.

    + +
    • +
  • + +

    #number Altitude : +The altitude to hold the position.

    + +
    • +
  • + +

    #number Speed : +The speed flying when holding the position.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskRegisterWayPoint(WayPoint) + +
+
+ + + +

Parameter

+
    +
  • + +

    WayPoint :

    + +
    • +
+
+
+
+
+ + +GROUP:TaskRoute(Points) + +
+
+ +

Return a Misson task to follow a given route defined by Points.

+ +

Parameter

+
    +
  • + +

    #table Points : +A table of route points.

    + +
    • +
+

Return value

+ +

#DCSTask:

+ + +
+
+
+
+ + +GROUP:TaskRouteToVec3(Point, Speed) + +
+
+ +

Make the group to fly to a given point and hover.

+ +

Parameters

+
    +
  • + +

    #Vec3 Point : +The destination point.

    + +
    • +
  • + +

    #number Speed : +The speed to travel.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskRouteToZone(Zone, Randomize, Speed, Formation) + +
+
+ +

Route the group to a given zone.

+ + +

The group final destination point can be randomized. +A speed can be given in km/h. +A given formation can be given.

+ +

Parameters

+
    +
  • + +

    Zone#ZONE Zone : +The zone where to route to.

    + +
    • +
  • + +

    #boolean Randomize : +Defines whether to target point gets randomized within the Zone.

    + +
    • +
  • + +

    #number Speed : +The speed.

    + +
    • +
  • + +

    Base#FORMATION Formation : +The formation string.

    + +
    • +
+
+
+
+
+ + +GROUP:_GetController() + +
+
+ +

Get the controller for the GROUP.

+ +

Return value

+ +

Controller#Controller:

+ + +
+
+ +

Type Time

+ +

Type Unit

+ +

Type Vec2

+ +

Type Vec3

+

Field(s)

+
+
+ + + +Vec3.x + +
+
+ + + +
+
+
+
+ + + +Vec3.y + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Moose/docs/MISSION.html b/Moose/docs/MISSION.html new file mode 100644 index 000000000..0768489e5 --- /dev/null +++ b/Moose/docs/MISSION.html @@ -0,0 +1,1631 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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.

+ +

Global(s)

+ + + + + + + + + + + + + + + + + +
MISSION + +
MISSIONSCHEDULER + +
TaskComplete + +
_TransportExecuteStage + +
+

Type MISSION

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MISSION.AddClient(CLIENT, self, Client) +

Register a new CLIENT to participate within the mission.

+
MISSION.AddGoalFunction(function, self, GoalFunction) +

Add a goal function to a MISSION.

+
MISSION:AddTask(Task, TaskNumber) + +
MISSION.ClassName + +
MISSION:Completed() +

Set a Mission to completed.

+
MISSION.FAILED + +
MISSION:Failed() +

Set a Mission to failed.

+
MISSION.FindClient(CLIENT, self, ClientName) +

Find a CLIENT object within the MISSION by its ClientName.

+
MISSION:GetTask(TaskNumber) + +
MISSION:GetTasks() +

Get all the TASKs from the Mission.

+
MISSION.GoalFunction + +
MISSION:IsCompleted() +

Returns if a Mission has completed.

+
MISSION:IsFailed() +

Returns if a Mission has failed.

+
MISSION:IsOngoing() +

Returns if a Mission is ongoing.

+
MISSION:IsPending() +

Returns if a Mission is pending.

+
MISSION:Meta() + +
MISSION.MissionCoalition + +
MISSION.MissionProgressTrigger + +
MISSION.MissionReportFlash + +
MISSION.MissionReportShow + +
MISSION.MissionReportTrigger + +
MISSION.MissionStatus + +
MISSION.MissionTimeInterval + +
MISSION.Name + +
MISSION.New(string, string, string, string, self, MissionName, MissionPriority, MissionBriefing, MissionCoalition) +

This is the main MISSION declaration method.

+
MISSION:Ongoing() +

Set a Mission to ongoing.

+
MISSION:Pending() +

Set a Mission to pending.

+
MISSION.REPEAT + +
MISSION:ReportToAll() +

Report the status of all MISSIONs to all active Clients.

+
MISSION:ReportTrigger() +

Handles the reporting.

+
MISSION.SUCCESS + +
MISSION.ShowBriefing(CLIENT, self, Client) +

Show the briefing of the MISSION to the CLIENT.

+
MISSION:StatusToClients() +

Send the status of the MISSION to all Clients.

+
MISSION._ActiveTasks + +
MISSION._Clients + +
MISSION._GoalTasks + +
MISSION._Tasks + +
+ +

Type MISSIONSCHEDULER

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MISSIONSCHEDULER.AddMission(Mission) +

This is the main MISSION declaration method.

+
MISSIONSCHEDULER.FindMission(MissionName) +

Find a MISSION within the MISSIONSCHEDULER.

+
MISSIONSCHEDULER.MissionCount + +
MISSIONSCHEDULER.Missions + +
MISSIONSCHEDULER.RemoveMission(MissionName) +

Remove a MISSION from the MISSIONSCHEDULER.

+
MISSIONSCHEDULER.ReportMenu() +

Enables a MENU option in the communications menu under F10 to control the status of the active missions.

+
MISSIONSCHEDULER.ReportMissionsFlash(TimeInterval) + +
MISSIONSCHEDULER.ReportMissionsHide(Prm) + +
MISSIONSCHEDULER.ReportMissionsShow() + +
MISSIONSCHEDULER.Scheduler() +

This is the main MISSIONSCHEDULER Scheduler function.

+
MISSIONSCHEDULER.SchedulerId + +
MISSIONSCHEDULER.Start() +

Start the MISSIONSCHEDULER.

+
MISSIONSCHEDULER.Stop() +

Stop the MISSIONSCHEDULER.

+
MISSIONSCHEDULER:Time(TimeSeconds, TimeIntervalShow, TimeShow) + +
MISSIONSCHEDULER.TimeIntervalCount + +
MISSIONSCHEDULER.TimeIntervalShow + +
MISSIONSCHEDULER.TimeSeconds + +
MISSIONSCHEDULER.TimeShow + +
+ +

Global(s)

+
+
+ + #MISSION + +MISSION + +
+
+ + + +
+
+
+
+ + #MISSIONSCHEDULER + +MISSIONSCHEDULER + +
+
+ + + +
+
+
+
+ + #boolean + +TaskComplete + +
+
+ + + + +

For each Client, check for each Task the state and evolve the mission. + This flag will indicate if the Task of the Client is Complete.

+ +
+
+
+
+ + + +_TransportExecuteStage + +
+
+ + + + +

_TransportExecuteStage: Defines the different stages of Transport unload/load execution. This table is internal and is used to control the validity of Transport load/unload timing.

+ +
    +
  • _TransportExecuteStage.EXECUTING
    • +
  • _TransportExecuteStage.SUCCESS
    • +
  • _TransportExecuteStage.FAILED
    • +
+ +

--

+ +
+
+

Type MISSION

+

Field(s)

+
+
+ + +MISSION.AddClient(CLIENT, self, Client) + +
+
+ +

Register a new CLIENT to participate within the mission.

+ +

Parameters

+
    +
  • + +

    CLIENT : +Client is the CLIENT object. The object must have been instantiated with CLIENT.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    Client :

    + +
    • +
+

Return value

+ + +

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.AddGoalFunction(function, self, GoalFunction) + +
+
+ +

Add a goal function to a MISSION.

+ + +

Goal functions are called when a TASK within a mission has been completed.

+ +

Parameters

+
    +
  • + +

    function : +GoalFunction 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.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalFunction :

    + +
    • +
+

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:AddTask(Task, TaskNumber) + +
+
+ + + +

Parameters

+
    +
  • + +

    Task :

    + +
    • +
  • + +

    TaskNumber :

    + +
    • +
+
+
+
+
+ + #string + +MISSION.ClassName + +
+
+ + + +
+
+
+
+ + +MISSION:Completed() + +
+
+ +

Set a Mission to completed.

+ +
+
+
+
+ + #number + +MISSION.FAILED + +
+
+ + + +
+
+
+
+ + +MISSION:Failed() + +
+
+ +

Set a Mission to failed.

+ +
+
+
+
+ + +MISSION.FindClient(CLIENT, self, ClientName) + +
+
+ +

Find a CLIENT object within the MISSION by its ClientName.

+ +

Parameters

+
    +
  • + +

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

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    ClientName :

    + +
    • +
+

Return value

+ + +

CLIENT

+ +

Usage:

+ 
-- Seach for Client "Bomber" within the Mission.
+local BomberClient = Mission:FindClient( "Bomber" )
+ +
+
+
+
+ + +MISSION:GetTask(TaskNumber) + +
+
+ + + +

Parameter

+
    +
  • + +

    TaskNumber :

    + +
    • +
+
+
+
+
+ + +MISSION:GetTasks() + +
+
+ +

Get all the TASKs from the Mission.

+ + +

This function is useful in GoalFunctions.

+ +

Return value

+ + +

{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() .. "%" )
+ +
+
+
+
+ + +MISSION.GoalFunction + +
+
+ + + +
+
+
+
+ + +MISSION:IsCompleted() + +
+
+ +

Returns if a Mission has completed.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + +MISSION:IsFailed() + +
+
+ +

Returns if a Mission has failed.

+ + +

treturn bool

+ +
+
+
+
+ + +MISSION:IsOngoing() + +
+
+ +

Returns if a Mission is ongoing.

+ + +

treturn bool

+ +
+
+
+
+ + +MISSION:IsPending() + +
+
+ +

Returns if a Mission is pending.

+ + +

treturn bool

+ +
+
+
+
+ + +MISSION:Meta() + +
+
+ + + +
+
+
+
+ + #string + +MISSION.MissionCoalition + +
+
+ + + +
+
+
+
+ + #number + +MISSION.MissionProgressTrigger + +
+
+ + + +
+
+
+
+ + #boolean + +MISSION.MissionReportFlash + +
+
+ + + +
+
+
+
+ + #boolean + +MISSION.MissionReportShow + +
+
+ + + +
+
+
+
+ + #number + +MISSION.MissionReportTrigger + +
+
+ + + +
+
+
+
+ + #string + +MISSION.MissionStatus + +
+
+ + + +
+
+
+
+ + #number + +MISSION.MissionTimeInterval + +
+
+ + + +
+
+
+
+ + #string + +MISSION.Name + +
+
+ + + +
+
+
+
+ + +MISSION.New(string, string, string, string, self, 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

+
    +
  • + +

    string : +MissionName is the name of the mission. This name will be used to reference the status of each mission by the players.

    + +
    • +
  • + +

    string : +MissionPriority 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.

    + +
    • +
  • + +

    string : +MissionBriefing is a string indicating the mission briefing to be shown when a player joins a CLIENT.

    + +
    • +
  • + +

    string : +MissionCoalition 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"...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    MissionName :

    + +
    • +
  • + +

    MissionPriority :

    + +
    • +
  • + +

    MissionBriefing :

    + +
    • +
  • + +

    MissionCoalition :

    + +
    • +
+

Return value

+ + +

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:Ongoing() + +
+
+ +

Set a Mission to ongoing.

+ +
+
+
+
+ + +MISSION:Pending() + +
+
+ +

Set a Mission to pending.

+ +
+
+
+
+ + #number + +MISSION.REPEAT + +
+
+ + + +
+
+
+
+ + +MISSION:ReportToAll() + +
+
+ +

Report the status of all MISSIONs to all active Clients.

+ +
+
+
+
+ + +MISSION:ReportTrigger() + +
+
+ +

Handles the reporting.

+ + +

After certain time intervals, a MISSION report MESSAGE will be shown to All Players.

+ +
+
+
+
+ + #number + +MISSION.SUCCESS + +
+
+ + + +
+
+
+
+ + +MISSION.ShowBriefing(CLIENT, self, Client) + +
+
+ +

Show the briefing of the MISSION to the CLIENT.

+ +

Parameters

+
    +
  • + +

    CLIENT : +Client to show briefing to.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    Client :

    + +
    • +
+

Return value

+ + +

CLIENT

+ +
+
+
+
+ + +MISSION:StatusToClients() + +
+
+ +

Send the status of the MISSION to all Clients.

+ +
+
+
+
+ + + +MISSION._ActiveTasks + +
+
+ + + +
+
+
+
+ + + +MISSION._Clients + +
+
+ + + +
+
+
+
+ + + +MISSION._GoalTasks + +
+
+ + + +
+
+
+
+ + + +MISSION._Tasks + +
+
+ + + +
+
+ +

Type 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.

+ +

Field(s)

+
+
+ + +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.

+ +

Parameter

+
    +
  • + +

    Mission : +is the MISSION object instantiated by MISSION.

    + +
    • +
+

Return value

+ + +

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.FindMission(MissionName) + +
+
+ +

Find a MISSION within the MISSIONSCHEDULER.

+ +

Parameter

+
    +
  • + +

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

    + +
    • +
+

Return value

+ + +

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' )
+ +
+
+
+
+ + #number + +MISSIONSCHEDULER.MissionCount + +
+
+ + + +
+
+
+
+ + + +MISSIONSCHEDULER.Missions + +
+
+ + + +
+
+
+
+ + +MISSIONSCHEDULER.RemoveMission(MissionName) + +
+
+ +

Remove a MISSION from the MISSIONSCHEDULER.

+ +

Parameter

+
    +
  • + +

    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.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.ReportMissionsFlash(TimeInterval) + +
+
+ + + + +

Internal function used by the MISSIONSCHEDULER menu.

+ +

Parameter

+
    +
  • + +

    TimeInterval :

    + +
    • +
+
+
+
+
+ + +MISSIONSCHEDULER.ReportMissionsHide(Prm) + +
+
+ + + + +

Internal function used by the MISSIONSCHEDULER menu.

+ +

Parameter

+
    +
  • + +

    Prm :

    + +
    • +
+
+
+
+
+ + +MISSIONSCHEDULER.ReportMissionsShow() + +
+
+ + + + +

Internal function used by the MISSIONSCHEDULER menu.

+ +
+
+
+
+ + +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.SchedulerId + +
+
+ + + +
+
+
+
+ + +MISSIONSCHEDULER.Start() + +
+
+ +

Start the MISSIONSCHEDULER.

+ +
+
+
+
+ + +MISSIONSCHEDULER.Stop() + +
+
+ +

Stop the MISSIONSCHEDULER.

+ +
+
+
+
+ + +MISSIONSCHEDULER:Time(TimeSeconds, TimeIntervalShow, TimeShow) + +
+
+ + + +

Parameters

+
    +
  • + +

    TimeSeconds :

    + +
    • +
  • + +

    TimeIntervalShow :

    + +
    • +
  • + +

    TimeShow :

    + +
    • +
+
+
+
+
+ + #number + +MISSIONSCHEDULER.TimeIntervalCount + +
+
+ + + +
+
+
+
+ + #number + +MISSIONSCHEDULER.TimeIntervalShow + +
+
+ + + +
+
+
+
+ + #number + +MISSIONSCHEDULER.TimeSeconds + +
+
+ + + +
+
+
+
+ + #number + +MISSIONSCHEDULER.TimeShow + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Moose/docs/MOVEMENT.html b/Moose/docs/MOVEMENT.html new file mode 100644 index 000000000..dfedfc71d --- /dev/null +++ b/Moose/docs/MOVEMENT.html @@ -0,0 +1,260 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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).

+ +

Global(s)

+ + + + + +
MOVEMENT + +
+

Type MOVEMENT

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MOVEMENT.ClassName + +
MOVEMENT:New(MovePrefixes, MoveMaximum) + +
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:ScheduleStart() +

Call this function to start the MOVEMENT scheduling.

+
MOVEMENT:ScheduleStop() +

Call this function to stop the MOVEMENT scheduling.

+
MOVEMENT:_Scheduler() +

This function is called automatically by the MOVEMENT scheduler.

+
+ +

Global(s)

+
+
+ + #MOVEMENT + +MOVEMENT + +
+
+ + + +
+
+

Type MOVEMENT

+

Field(s)

+
+
+ + #string + +MOVEMENT.ClassName + +
+
+ + + +
+
+
+
+ + +MOVEMENT:New(MovePrefixes, MoveMaximum) + +
+
+ + + +

Parameters

+
    +
  • + +

    MovePrefixes :

    + +
    • +
  • + +

    MoveMaximum :

    + +
    • +
+
+
+
+
+ + +MOVEMENT:OnBirth(event) + +
+
+ +

Captures the birth events when new Units were spawned.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +MOVEMENT:OnDeadOrCrash(event) + +
+
+ +

Captures the Dead or Crash events when Units crash or are destroyed.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +MOVEMENT:ScheduleStart() + +
+
+ +

Call this function to start the MOVEMENT scheduling.

+ +
+
+
+
+ + +MOVEMENT:ScheduleStop() + +
+
+ +

Call this function to stop the MOVEMENT scheduling.

+ +
+
+
+
+ + +MOVEMENT:_Scheduler() + +
+
+ +

This function is called automatically by the MOVEMENT scheduler.

+ + +

A new function is scheduled when MoveScheduled is true.

+ +
+
+ +
+ +
+ + diff --git a/Moose/docs/Menu.html b/Moose/docs/Menu.html new file mode 100644 index 000000000..1c44af660 --- /dev/null +++ b/Moose/docs/Menu.html @@ -0,0 +1,636 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Menu

+ +

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

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + +
COMMANDMENU + +
MENU + +
MENU_CLIENT + +
MENU_CLIENT_COMMAND + +
SUBMENU + +
+

Type COMMANDMENU

+ + + + + + + + + + + + + + + + + +
COMMANDMENU.ClassName + +
COMMANDMENU.CommandMenuArgument + +
COMMANDMENU.CommandMenuFunction + +
COMMANDMENU:New(MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument) + +
+ +

Type MENU

+ + + + + + + + + + + + + + + + + + + + + +
MENU.ClassName + +
MENU.MenuParentPath + +
MENU.MenuPath + +
MENU.MenuText + +
MENU:New(MenuText, MenuParentPath) + +
+ +

Type MENU_CLIENT

+ + + + + + + + + +
MENU_CLIENT.ClassName + +
MENU_CLIENT:New(MenuClient, MenuText, ParentMenu) +

Creates a new menu item for a group

+
+ +

Type MENU_CLIENT_COMMAND

+ + + + + + + + + + + + + +
MENU_CLIENT_COMMAND.ClassName + +
MENU_CLIENT_COMMAND:New(MenuClient, MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument) +

Creates a new radio command item for a group

+
MENU_CLIENT_COMMAND:Remove() + +
+ +

Type SUBMENU

+ + + + + + + + + +
SUBMENU.ClassName + +
SUBMENU:New(MenuText, ParentMenu) + +
+ +

Global(s)

+
+
+ + #COMMANDMENU + +COMMANDMENU + +
+
+ + + +
+
+
+
+ + #MENU + +MENU + +
+
+ + + +
+
+
+
+ + #MENU_CLIENT + +MENU_CLIENT + +
+
+ + + +
+
+
+
+ + #MENU_CLIENT_COMMAND + +MENU_CLIENT_COMMAND + +
+
+ + + +
+
+
+
+ + #SUBMENU + +SUBMENU + +
+
+ + + +
+
+

Type Menu

+ +

Type COMMANDMENU

+ +

The COMMANDMENU class

+ +

Field(s)

+
+
+ + #string + +COMMANDMENU.ClassName + +
+
+ + + +
+
+
+
+ + +COMMANDMENU.CommandMenuArgument + +
+
+ + + +
+
+
+
+ + +COMMANDMENU.CommandMenuFunction + +
+
+ + + +
+
+
+
+ + +COMMANDMENU:New(MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument) + +
+
+ + + +

Parameters

+
    +
  • + +

    MenuText :

    + +
    • +
  • + +

    ParentMenu :

    + +
    • +
  • + +

    CommandMenuFunction :

    + +
    • +
  • + +

    CommandMenuArgument :

    + +
    • +
+
+
+ +

Type MENU

+ +

The MENU class

+ +

Field(s)

+
+
+ + #string + +MENU.ClassName + +
+
+ + + +
+
+
+
+ + +MENU.MenuParentPath + +
+
+ + + +
+
+
+
+ + +MENU.MenuPath + +
+
+ + + +
+
+
+
+ + #string + +MENU.MenuText + +
+
+ + + +
+
+
+
+ + +MENU:New(MenuText, MenuParentPath) + +
+
+ + + +

Parameters

+
    +
  • + +

    MenuText :

    + +
    • +
  • + +

    MenuParentPath :

    + +
    • +
+
+
+ +

Type MENU_CLIENT

+ +

The MENU_CLIENT class

+ +

Field(s)

+
+
+ + #string + +MENU_CLIENT.ClassName + +
+
+ + + +
+
+
+
+ + +MENU_CLIENT:New(MenuClient, MenuText, ParentMenu) + +
+
+ +

Creates a new menu item for a group

+ +

Parameters

+
    +
  • + +

    Client#CLIENT MenuClient : +The Client owning the menu.

    + +
    • +
  • + +

    #string MenuText : +The text for the menu.

    + +
    • +
  • + +

    #table ParentMenu : +The parent menu.

    + +
    • +
+

Return value

+ +

#MENU_CLIENT: +self

+ +
+
+ +

Type MENU_CLIENT_COMMAND

+ +

The MENUCLIENTCOMMAND class

+ +

Field(s)

+
+
+ + #string + +MENU_CLIENT_COMMAND.ClassName + +
+
+ + + +
+
+
+
+ + +MENU_CLIENT_COMMAND:New(MenuClient, MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument) + +
+
+ +

Creates a new radio command item for a group

+ +

Parameters

+
    +
  • + +

    Client#CLIENT MenuClient : +The Client owning the menu.

    + +
    • +
  • + +

    MenuText : +The text for the menu.

    + +
    • +
  • + +

    ParentMenu : +The parent menu.

    + +
    • +
  • + +

    CommandMenuFunction : +A function that is called when the menu key is pressed.

    + +
    • +
  • + +

    CommandMenuArgument : +An argument for the function.

    + +
    • +
+

Return value

+ +

Menu#MENUCLIENTCOMMAND: +self

+ +
+
+
+
+ + +MENU_CLIENT_COMMAND:Remove() + +
+
+ + + +
+
+ +

Type SUBMENU

+ +

The SUBMENU class

+ +

Field(s)

+
+
+ + #string + +SUBMENU.ClassName + +
+
+ + + +
+
+
+
+ + +SUBMENU:New(MenuText, ParentMenu) + +
+
+ + + +

Parameters

+
    +
  • + +

    MenuText :

    + +
    • +
  • + +

    ParentMenu :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Moose/docs/Message.html b/Moose/docs/Message.html new file mode 100644 index 000000000..2f6395963 --- /dev/null +++ b/Moose/docs/Message.html @@ -0,0 +1,536 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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().

+ +

Global(s)

+ + + + + + + + + +
MESSAGE + +
MESSAGEQUEUE + +
+

Type MESSAGE

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MESSAGE.ClassName + +
MESSAGE.MessageCategory + +
MESSAGE.MessageID + +
MESSAGE:New(MessageText, MessageCategory, MessageDuration, MessageID) +

Creates a new MESSAGE object.

+
MESSAGE:ToAll() +

Sends a MESSAGE to all players.

+
MESSAGE:ToBlue() +

Sends a MESSAGE to the Blue coalition.

+
MESSAGE:ToClient(Client) +

Sends a MESSAGE to a Client Group.

+
MESSAGE:ToCoalition(CoalitionSide) +

Sends a MESSAGE to a Coalition.

+
MESSAGE:ToRed() +

Sends a MESSAGE to the Red Coalition.

+
+ +

Type MESSAGEQUEUE

+ + + + + + + + + + + + + + + + + +
MESSAGEQUEUE.ClientGroups + +
MESSAGEQUEUE.CoalitionSides + +
MESSAGEQUEUE:New(RefreshInterval) + +
MESSAGEQUEUE:_DisplayMessages() +

This function is called automatically by the MESSAGEQUEUE scheduler.

+
+ +

Global(s)

+
+
+ + #MESSAGE + +MESSAGE + +
+
+ + + +
+
+
+
+ + #MESSAGEQUEUE + +MESSAGEQUEUE + +
+
+ + + +
+
+

Type Message

+ +

Type MESSAGE

+ +

The MESSAGE class

+ +

Field(s)

+
+
+ + #string + +MESSAGE.ClassName + +
+
+ + + +
+
+
+
+ + #number + +MESSAGE.MessageCategory + +
+
+ + + +
+
+
+
+ + #number + +MESSAGE.MessageID + +
+
+ + + +
+
+
+
+ + +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

+
    +
  • + +

    #string MessageText : +is the text of the Message.

    + +
    • +
  • + +

    #string MessageCategory : +is a string expressing the Category of the Message. Messages are grouped on the display panel per Category to improve readability.

    + +
    • +
  • + +

    #number MessageDuration : +is a number in seconds of how long the MESSAGE should be shown on the display panel.

    + +
    • +
  • + +

    #string MessageID : +is a string expressing the ID of the Message.

    + +
    • +
+

Return value

+ +

#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:ToAll() + +
+
+ +

Sends a MESSAGE to all players.

+ +

Return value

+ +

#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()
+ +
+
+
+
+ + +MESSAGE:ToBlue() + +
+
+ +

Sends a MESSAGE to the Blue coalition.

+ +

Return value

+ +

#MESSAGE:

+ + +

Usage:

+ 
-- Send a message created with the @{New} method to the BLUE coalition.
+MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
+or
+MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
+or
+MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
+MessageBLUE:ToBlue()
+ +
+
+
+
+ + +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".

+ +

Parameter

+ +

Return value

+ +

#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.

+ +

Parameter

+
    +
  • + +

    CoalitionSide : +needs to be filled out by the defined structure of the standard scripting engine coalition.side.

    + +
    • +
+

Return value

+ +

#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:ToRed() + +
+
+ +

Sends a MESSAGE to the Red Coalition.

+ +

Return value

+ +

#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" ):ToRed()
+or
+MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
+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:ToRed()
+ +
+
+ +

Type MESSAGEQUEUE

+ +

The MESSAGEQUEUE class

+ +

Field(s)

+
+
+ + + +MESSAGEQUEUE.ClientGroups + +
+
+ + + +
+
+
+
+ + + +MESSAGEQUEUE.CoalitionSides + +
+
+ + + +
+
+
+
+ + +MESSAGEQUEUE:New(RefreshInterval) + +
+
+ + + +

Parameter

+
    +
  • + +

    RefreshInterval :

    + +
    • +
+
+
+
+
+ + +MESSAGEQUEUE:_DisplayMessages() + +
+
+ +

This function is called automatically by the MESSAGEQUEUE scheduler.

+ +
+
+ +
+ +
+ + diff --git a/Moose/docs/NOTASK.html b/Moose/docs/NOTASK.html new file mode 100644 index 000000000..7cfacd0e4 --- /dev/null +++ b/Moose/docs/NOTASK.html @@ -0,0 +1,130 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module NOTASK

+ +

A NOTASK is a dummy activity...

+ + +

But it will show a Mission Briefing...

+ +

Global(s)

+ + + + + +
NOTASK + +
+

Type NOTASK

+ + + + + + + + + +
NOTASK.ClassName + +
NOTASK:New() +

Creates a new NOTASK.

+
+ +

Global(s)

+
+
+ + #NOTASK + +NOTASK + +
+
+ + + +
+
+

Type NOTASK

+

Field(s)

+
+
+ + #string + +NOTASK.ClassName + +
+
+ + + +
+
+
+
+ + +NOTASK:New() + +
+
+ +

Creates a new NOTASK.

+ +
+
+ +
+ +
+ + diff --git a/Moose/docs/PICKUPTASK.html b/Moose/docs/PICKUPTASK.html new file mode 100644 index 000000000..40548d876 --- /dev/null +++ b/Moose/docs/PICKUPTASK.html @@ -0,0 +1,375 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module PICKUPTASK

+ +

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

+ +

Global(s)

+ + + + + +
PICKUPTASK + +
+

Type PICKUPTASK

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PICKUPTASK:AddCargoMenus(Client, Cargos, TransportRadius) + +
PICKUPTASK.ClassName + +
PICKUPTASK:FromZone(LandingZone) + +
PICKUPTASK.GoalVerb + +
PICKUPTASK:HasFailed(ClientDead) + +
PICKUPTASK:InitCargo(InitCargos) + +
PICKUPTASK:LoadCargo(LoadCargos) + +
PICKUPTASK.New(table, CARGO_TYPE, number, self, CargoType, OnBoardSide) +

Creates a new PICKUPTASK.

+
PICKUPTASK:RemoveCargoMenus(Client) + +
PICKUPTASK.TEXT + +
+ +

Global(s)

+
+
+ + #PICKUPTASK + +PICKUPTASK + +
+
+ + + +
+
+

Type PICKUPTASK

+

Field(s)

+
+
+ + +PICKUPTASK:AddCargoMenus(Client, Cargos, TransportRadius) + +
+
+ + + +

Parameters

+
    +
  • + +

    Client :

    + +
    • +
  • + +

    Cargos :

    + +
    • +
  • + +

    TransportRadius :

    + +
    • +
+
+
+
+
+ + #string + +PICKUPTASK.ClassName + +
+
+ + + +
+
+
+
+ + +PICKUPTASK:FromZone(LandingZone) + +
+
+ + + +

Parameter

+
    +
  • + +

    LandingZone :

    + +
    • +
+
+
+
+
+ + #string + +PICKUPTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +PICKUPTASK:HasFailed(ClientDead) + +
+
+ + + +

Parameter

+
    +
  • + +

    ClientDead :

    + +
    • +
+
+
+
+
+ + +PICKUPTASK:InitCargo(InitCargos) + +
+
+ + + +

Parameter

+
    +
  • + +

    InitCargos :

    + +
    • +
+
+
+
+
+ + +PICKUPTASK:LoadCargo(LoadCargos) + +
+
+ + + +

Parameter

+
    +
  • + +

    LoadCargos :

    + +
    • +
+
+
+
+
+ + +PICKUPTASK.New(table, CARGO_TYPE, number, self, CargoType, OnBoardSide) + +
+
+ +

Creates a new PICKUPTASK.

+ +

Parameters

+
    +
  • + +

    table : +string,...}|string LandingZones Table of Zone names where Cargo is to be loaded.

    + +
    • +
  • + +

    CARGO_TYPE : +CargoType Type of the Cargo. The type must be of the following Enumeration:..

    + +
    • +
  • + +

    number : +OnBoardSide Reflects from which side the cargo Group will be on-boarded on the Carrier.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    CargoType :

    + +
    • +
  • + +

    OnBoardSide :

    + +
    • +
+
+
+
+
+ + +PICKUPTASK:RemoveCargoMenus(Client) + +
+
+ + + +

Parameter

+
    +
  • + +

    Client :

    + +
    • +
+
+
+
+
+ + + +PICKUPTASK.TEXT + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Moose/docs/ROUTETASK.html b/Moose/docs/ROUTETASK.html new file mode 100644 index 000000000..5e09833a9 --- /dev/null +++ b/Moose/docs/ROUTETASK.html @@ -0,0 +1,182 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module ROUTETASK

+ +

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

+ +

Global(s)

+ + + + + +
ROUTETASK + +
+

Type ROUTETASK

+ + + + + + + + + + + + + +
ROUTETASK.ClassName + +
ROUTETASK.GoalVerb + +
ROUTETASK.New(table, string, self, LandingZones, TaskBriefing) +

Creates a new ROUTETASK.

+
+ +

Global(s)

+
+
+ + #ROUTETASK + +ROUTETASK + +
+
+ + + +
+
+

Type ROUTETASK

+

Field(s)

+
+
+ + #string + +ROUTETASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +ROUTETASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +ROUTETASK.New(table, string, self, LandingZones, TaskBriefing) + +
+
+ +

Creates a new ROUTETASK.

+ +

Parameters

+
    +
  • + +

    table : +sring,...}|string LandingZones Table of Zone Names where the target is located.

    + +
    • +
  • + +

    string : +TaskBriefing (optional) Defines a text describing the briefing of the task.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    LandingZones :

    + +
    • +
  • + +

    TaskBriefing :

    + +
    • +
+

Return value

+ + +

ROUTETASK

+ +
+
+ +
+ +
+ + diff --git a/Moose/docs/STAGE.html b/Moose/docs/STAGE.html new file mode 100644 index 000000000..dd84fbcbc --- /dev/null +++ b/Moose/docs/STAGE.html @@ -0,0 +1,794 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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.

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CargoStatic + +
STAGE + +
STAGEARRIVE + +
STAGEBRIEF + +
STAGEDONE + +
STAGEGROUPSDESTROYED + +
STAGELANDED + +
STAGELANDING + +
STAGELOAD + +
STAGEROUTE + +
STAGESTART + +
STAGEUNLOAD + +
STAGE_CARGO_INIT + +
STAGE_CARGO_LOAD + +
_TransportStage + +
_TransportStageAction + +
_TransportStageTime + +
+

Type STAGE

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
STAGE.ClassName + +
STAGE:Execute(Mission, Client, Task) + +
STAGE:Executing(Mission, Client, Task) + +
STAGE.FREQUENCY + +
STAGE.Frequency + +
STAGE.MSG + +
STAGE.MessageCount + +
STAGE.MessageFlash + +
STAGE.MessageInterval + +
STAGE.MessageShow + +
STAGE.MessageShown + +
STAGE.Name + +
STAGE:New() + +
STAGE.StageType + +
STAGE:Validate(Mission, Client, Task) + +
STAGE.WaitTime + +
+ +

Global(s)

+
+
+ + + +CargoStatic + +
+
+ + + +
+
+
+
+ + #STAGE + +STAGE + +
+
+ + + +
+
+
+
+ + + +STAGEARRIVE + +
+
+ + + +
+
+
+
+ + + +STAGEBRIEF + +
+
+ + + +
+
+
+
+ + + +STAGEDONE + +
+
+ + + +
+
+
+
+ + + +STAGEGROUPSDESTROYED + +
+
+ + + +
+
+
+
+ + + +STAGELANDED + +
+
+ + + +
+
+
+
+ + + +STAGELANDING + +
+
+ + + +
+
+
+
+ + + +STAGELOAD + +
+
+ + + +
+
+
+
+ + + +STAGEROUTE + +
+
+ + + +
+
+
+
+ + + +STAGESTART + +
+
+ + + +
+
+
+
+ + + +STAGEUNLOAD + +
+
+ + + +
+
+
+
+ + + +STAGE_CARGO_INIT + +
+
+ + + +
+
+
+
+ + + +STAGE_CARGO_LOAD + +
+
+ + + +
+
+
+
+ + + +_TransportStage + +
+
+ + + + +

_TransportStage: Defines the different stages of which of transport missions can be in. This table is internal and is used to control the sequence of messages, actions and flow.

+ +
    +
  • _TransportStage.START
    • +
  • _TransportStage.ROUTE
    • +
  • _TransportStage.LAND
    • +
  • _TransportStage.EXECUTE
    • +
  • _TransportStage.DONE
    • +
  • _TransportStage.REMOVE + --
    • +
+ +
+
+
+
+ + + +_TransportStageAction + +
+
+ + + +
+
+
+
+ + + +_TransportStageTime + +
+
+ + + +
+
+

Type STAGE

+

Field(s)

+
+
+ + #string + +STAGE.ClassName + +
+
+ + + +
+
+
+
+ + +STAGE:Execute(Mission, Client, Task) + +
+
+ + + +

Parameters

+
    +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
  • + +

    Task :

    + +
    • +
+
+
+
+
+ + +STAGE:Executing(Mission, Client, Task) + +
+
+ + + +

Parameters

+
    +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
  • + +

    Task :

    + +
    • +
+
+
+
+
+ + + +STAGE.FREQUENCY + +
+
+ + + +
+
+
+
+ + #number + +STAGE.Frequency + +
+
+ + + +
+
+
+
+ + + +STAGE.MSG + +
+
+ + + +
+
+
+
+ + #number + +STAGE.MessageCount + +
+
+ + + +
+
+
+
+ + #boolean + +STAGE.MessageFlash + +
+
+ + + +
+
+
+
+ + #number + +STAGE.MessageInterval + +
+
+ + + +
+
+
+
+ + #boolean + +STAGE.MessageShow + +
+
+ + + +
+
+
+
+ + + +STAGE.MessageShown + +
+
+ + + +
+
+
+
+ + #string + +STAGE.Name + +
+
+ + + +
+
+
+
+ + +STAGE:New() + +
+
+ + + +
+
+
+
+ + #string + +STAGE.StageType + +
+
+ + + +
+
+
+
+ + +STAGE:Validate(Mission, Client, Task) + +
+
+ + + +

Parameters

+
    +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
  • + +

    Task :

    + +
    • +
+
+
+
+
+ + #number + +STAGE.WaitTime + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Moose/docs/Sead.html b/Moose/docs/Sead.html new file mode 100644 index 000000000..3df78f717 --- /dev/null +++ b/Moose/docs/Sead.html @@ -0,0 +1,235 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Sead

+ +

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

+ +

Global(s)

+ + + + + +
SEAD + +
+

Type SEAD

+ + + + + + + + + + + + + + + + + + + + + +
SEAD.ClassName + +
SEAD:EventShot(event) +

Detects if an SA site was shot with an anti radiation missile.

+
SEAD.New(table, self, SEADGroupPrefixes) +

Creates the main object which is handling defensive actions for SA sites or moving SA vehicles.

+
SEAD.SEADGroupPrefixes + +
SEAD.TargetSkill + +
+ +

Global(s)

+
+
+ + #SEAD + +SEAD + +
+
+ + + +
+
+

Type Sead

+ +

Type SEAD

+ +

The SEAD class

+ +

Field(s)

+
+
+ + #string + +SEAD.ClassName + +
+
+ + + +
+
+
+
+ + +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.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +SEAD.New(table, self, 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

+
    +
  • + +

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

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SEADGroupPrefixes :

    + +
    • +
+

Return value

+ + +

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.SEADGroupPrefixes + +
+
+ + + +
+
+
+
+ + + +SEAD.TargetSkill + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Moose/docs/Spawn.html b/Moose/docs/Spawn.html new file mode 100644 index 000000000..1a704ea3d --- /dev/null +++ b/Moose/docs/Spawn.html @@ -0,0 +1,1761 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Spawn

+ +

Dynamic spawning of groups (and units).

+ + +

The SPAWN class allows to spawn dynamically new groups, based on pre-defined initialization settings, modifying the behaviour when groups are spawned. +For each group to be spawned, within the mission editor, a group has to be created with the "late activation flag" set. We call this group the "Spawn Template" of the SPAWN object. +A reference to this Spawn Template needs to be provided when constructing the SPAWN object, by indicating the name of the group within the mission editor in the constructor methods.

+ +

Within the SPAWN object, there is an internal index that keeps track of which group from the internal group list was spawned. +When new groups get spawned by using the SPAWN functions (see below), it will be validated whether the Limits (SPAWN.Limit) of the SPAWN object are not reached. +When all is valid, a new group will be created by the spawning methods, and the internal index will be increased with 1.

+ +

Regarding the name of new spawned groups, a SpawnPrefix will be assigned for each new group created. +If you want to have the Spawn Template name to be used as the SpawnPrefix name, use the SPAWN.New constructor. +However, when the SPAWN.NewWithAlias constructor was used, the Alias name will define the SpawnPrefix name. +Groups will follow the following naming structure when spawned at run-time:

+ +
    +
  1. Spawned groups will have the name SpawnPrefix#ggg, where ggg is a counter from 0 to 999.
    2. +
  2. Spawned units will have the name SpawnPrefix#ggg-uu, where uu is a counter from 0 to 99 for each new spawned unit belonging to the group.
    3. +
+ +

Some additional notes that need to be remembered:

+ +
    +

  • Templates are actually groups defined within the mission editor, with the flag "Late Activation" set. As such, these groups are never used within the mission, but are used by the #SPAWN module.

    • +

  • It is important to defined BEFORE you spawn new groups, a proper initialization of the SPAWN instance is done with the options you want to use.

    • +

  • When designing a mission, NEVER name groups using a "#" within the name of the group Spawn Template(s), or the SPAWN module logic won't work anymore.

    • +

  • SPAWN object construction methods:

    +

    Create a new SPAWN object with the SPAWN.New or the SPAWN.NewWithAlias methods:

    • +

  • SPAWN.New: Creates a new SPAWN object taking the name of the group that functions as the Template.

    • +
+ +

It is important to understand how the SPAWN class works internally. The SPAWN object created will contain internally a list of groups that will be spawned and that are already spawned. +The initialization functions will modify this list of groups so that when a group gets spawned, ALL information is already prepared when spawning. This is done for performance reasons. +So in principle, the group list will contain all parameters and configurations after initialization, and when groups get actually spawned, this spawning can be done quickly and efficient.

+ +
    +

  1. SPAWN object initialization methods:

    +

    A spawn object will behave differently based on the usage of initialization methods:

    2. +

  2. SPAWN.Limit: Limits the amount of groups that can be alive at the same time and that can be dynamically spawned.

    3. +

  3. SPAWN.RandomizeRoute: Randomize the routes of spawned groups.

    4. +

  4. SPAWN.RandomizeTemplate: Randomize the group templates so that when a new group is spawned, a random group template is selected from one of the templates defined.

    5. +

  5. SPAWN.Uncontrolled: Spawn plane groups uncontrolled.

    6. +

  6. SPAWN.Array: Make groups visible before they are actually activated, and order these groups like a batallion in an array.

    7. +

  7. SPAWN.Repeat: Re-spawn groups when they land at the home base. Similar functions are SPAWN.RepeatOnLanding and SPAWN.RepeatOnEngineShutDown.

    8. +

  8. SPAWN object spawning methods:

    +

    Groups can be spawned at different times and methods:

    9. +

  9. SPAWN.Spawn: Spawn one new group based on the last spawned index.

    10. +

  10. SPAWN.ReSpawn: Re-spawn a group based on a given index.

    11. +

  11. SPAWN.SpawnScheduled: Spawn groups at scheduled but randomized intervals. You can use SPAWN.SpawnScheduleStart and SPAWN.SpawnScheduleStop to start and stop the schedule respectively.

    12. +

  12. SPAWN.SpawnFromUnit: Spawn a new group taking the position of a UNIT.

    13. +

  13. SPAWN.SpawnInZone: Spawn a new group in a ZONE.

    14. +
+ +

Note that SPAWN.Spawn and SPAWN.ReSpawn return a GROUP#GROUP.New object, that contains a reference to the DCSGroup object. +You can use the GROUP object to do further actions with the DCSGroup.

+ +
    +
  1. SPAWN object cleaning: +
    + Sometimes, it will occur during a mission run-time, that ground or especially air objects get damaged, and will while being damged stop their activities, while remaining alive. + In such cases, the SPAWN object will just sit there and wait until that group gets destroyed, but most of the time it won't, + and it may occur that no new groups are or can be spawned as limits are reached. + To prevent this, a SPAWN.CleanUp initialization method has been defined that will silently monitor the status of each spawned group. + Once a group has a velocity = 0, and has been waiting for a defined interval, that group will be cleaned or removed from run-time. + There is a catch however :-) If a damaged group has returned to an airbase within the coalition, that group will not be considered as "lost"... + In such a case, when the inactive group is cleaned, a new group will Re-spawned automatically. + This models AI that has succesfully returned to their airbase, to restart their combat activities. + Check the SPAWN.CleanUp for further info.
    2. +
+ + +

Global(s)

+ + + + + +
SPAWN + +
+

Type SPAWN

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SPAWN:Array(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY) +

Makes the groups visible before start (like a batallion).

+
SPAWN.ClassName + +
SPAWN:CleanUp(SpawnCleanUpInterval) +

CleanUp groups when they are still alive, but inactive.

+
SPAWN:GetFirstAliveGroup(SpawnCursor) +

Find the first alive group.

+
SPAWN:GetGroupFromIndex(SpawnIndex) +

Get the group from an index.

+
SPAWN:GetLastAliveGroup() +

Find the last alive group during runtime.

+
SPAWN:GetNextAliveGroup(SpawnCursor) +

Find the next alive group.

+
SPAWN:GetSpawnIndexFromGroup(SpawnGroup) +

Get the index from a given group.

+
SPAWN:Limit(SpawnMaxUnitsAlive, SpawnMaxGroups) +

Limits the Maximum amount of Units that can be alive at the same time, and the maximum amount of groups that can be spawned.

+
SPAWN:New(SpawnTemplatePrefix) +

Creates the main object to spawn a GROUP defined in the DCS ME.

+
SPAWN:NewWithAlias(SpawnTemplatePrefix, SpawnAliasPrefix) +

Creates a new SPAWN instance to create new groups based on the defined template and using a new alias for each new group.

+
SPAWN:RandomizeRoute(SpawnStartPoint, SpawnEndPoint, SpawnRadius) +

Randomizes the defined route of the SpawnTemplatePrefix group in the ME.

+
SPAWN:RandomizeTemplate(SpawnTemplatePrefixTable) +

This function is rather complicated to understand.

+
SPAWN:ReSpawn(SpawnIndex) +

Will re-spawn a group based on a given index.

+
SPAWN:Repeat() +

For planes and helicopters, when these groups 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 runtime environment.

+
SPAWN:RepeatOnEngineShutDown() +

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

+
SPAWN:RepeatOnLanding() + +
SPAWN:Spawn() +

Will re-spawn a group based on a given index.

+
SPAWN:SpawnFromUnit(HostUnit, OuterRadius, InnerRadius, SpawnIndex) +

Will spawn a group from a hosting unit.

+
SPAWN:SpawnGroupName(SpawnIndex) +

Will return the SpawnGroupName either with with a specific count number or without any count.

+
SPAWN:SpawnInZone(Zone, SpawnIndex) +

Will spawn a Group within a given ZONE.

+
SPAWN:SpawnScheduleStart() +

Will start the spawning scheduler.

+
SPAWN:SpawnScheduleStop() +

Will stop the scheduled spawning scheduler.

+
SPAWN:SpawnScheduled(SpawnTime, SpawnTimeVariation) +

Spawns new groups at varying time intervals.

+
SPAWN:SpawnWithIndex(SpawnIndex) +

Will spawn a group with a specified index number.

+
SPAWN:UnControlled() +

Will spawn a plane group in uncontrolled mode...

+
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:_GetGroupFromDCSUnit(DCSUnit) +

Return the group within the SpawnGroups collection with input a DCSUnit.

+
SPAWN:_GetGroupIndexFromDCSUnit(DCSUnit) +

Get the group index from a DCSUnit.

+
SPAWN:_GetLastIndex() +

Return the last maximum index that can be used.

+
SPAWN:_GetPrefixFromDCSUnit(DCSUnit) +

Return the prefix of a DCSUnit.

+
SPAWN:_GetSpawnIndex(SpawnIndex) +

Get the next index of the groups to be spawned.

+
SPAWN:_GetTemplate(SpawnTemplatePrefix) +

Gets the Group Template from the ME environment definition.

+
SPAWN:_InitializeSpawnGroups(SpawnIndex) +

Initalize the SpawnGroups collection.

+
SPAWN:_OnBirth(event) + +
SPAWN:_OnDeadOrCrash(event) +

Obscolete

+
SPAWN:_OnLand(event) +

Will detect AIR Units landing...

+
SPAWN:_OnTakeOff(event) +

Will detect AIR Units taking off...

+
SPAWN:_Prepare(SpawnTemplatePrefix, SpawnIndex) +

Prepares the new Group Template.

+
SPAWN:_RandomizeRoute(SpawnIndex) +

Internal function randomizing the routes.

+
SPAWN:_RandomizeTemplate(SpawnIndex) + +
SPAWN:_Scheduler() +

This function is called automatically by the Spawning scheduler.

+
SPAWN:_SpawnCleanUpScheduler() + +
SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) + +
+ +

Global(s)

+
+
+ + #SPAWN + +SPAWN + +
+
+ + + +
+
+

Type Spawn

+ +

Type SPAWN

+ +

SPAWN Class

+ +

Field(s)

+
+
+ + +SPAWN:Array(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY) + +
+
+ +

Makes the groups visible before start (like a batallion).

+ + +

The method will take the position of the group as the first position in the array.

+ +

Parameters

+
    +
  • + +

    #number SpawnAngle :

    +
        The angle in degrees how the groups and each unit of the group will be positioned.
+
    + +
    • +
  • + +

    #number SpawnWidth :

    +
         The amount of Groups that will be positioned on the X axis.
+
    + +
    • +
  • + +

    #number SpawnDeltaX :

    +
       The space between each Group on the X-axis.
+
    + +
    • +
  • + +

    #number SpawnDeltaY :

    +
         The space between each Group on the Y-axis.
+
    + +
    • +
+

Return value

+ +

#SPAWN: +self

+ +

Usage:

+ 
-- Define an array of Groups.
+Spawn_BE_Ground = SPAWN:New( 'BE Ground' ):Limit( 2, 24 ):Visible( 90, "Diamond", 10, 100, 50 )
+ +
+
+
+
+ + +SPAWN.ClassName + +
+
+ + + +
+
+
+
+ + +SPAWN:CleanUp(SpawnCleanUpInterval) + +
+
+ +

CleanUp groups when they are still alive, but inactive.

+ + +

When groups are still alive and have become inactive due to damage and are unable to contribute anything, then this group will be removed at defined intervals in seconds.

+ +

Parameter

+
    +
  • + +

    #string SpawnCleanUpInterval : +The interval to check for inactive groups within seconds.

    + +
    • +
+

Return value

+ +

#SPAWN: +self

+ +

Usage:

+ 
Spawn_Helicopter:CleanUp( 20 )  -- CleanUp the spawning of the helicopters every 20 seconds when they become inactive.
+ +
+
+
+
+ + +SPAWN:GetFirstAliveGroup(SpawnCursor) + +
+
+ +

Find the first alive group.

+ +

Parameter

+
    +
  • + +

    #number SpawnCursor : +A number holding the index from where to find the first group from.

    + +
    • +
+

Return values

+
    +
  1. + +

    GROUP#GROUP, #number: +The group found, the new index where the group was found.

    + +
    2. +
  2. + +

    #nil, #nil: +When no group is found, #nil is returned.

    + +
    3. +
+
+
+
+
+ + +SPAWN:GetGroupFromIndex(SpawnIndex) + +
+
+ +

Get the group from an index.

+ + +

Returns the group from the SpawnGroups list. +If no index is given, it will return the first group in the list.

+ +

Parameter

+
    +
  • + +

    #number SpawnIndex : +The index of the group to return.

    + +
    • +
+

Return value

+ +

GROUP#GROUP:

+ + +
+
+
+
+ + +SPAWN:GetLastAliveGroup() + +
+
+ +

Find the last alive group during runtime.

+ +
+
+
+
+ + +SPAWN:GetNextAliveGroup(SpawnCursor) + +
+
+ +

Find the next alive group.

+ +

Parameter

+
    +
  • + +

    #number SpawnCursor : +A number holding the last found previous index.

    + +
    • +
+

Return values

+
    +
  1. + +

    GROUP#GROUP, #number: +The group found, the new index where the group was found.

    + +
    2. +
  2. + +

    #nil, #nil: +When no group is found, #nil is returned.

    + +
    3. +
+
+
+
+
+ + +SPAWN:GetSpawnIndexFromGroup(SpawnGroup) + +
+
+ +

Get the index from a given group.

+ + +

The function will search the name of the group for a #, and will return the number behind the #-mark.

+ +

Parameter

+
    +
  • + +

    SpawnGroup :

    + +
    • +
+
+
+
+
+ + +SPAWN:Limit(SpawnMaxUnitsAlive, SpawnMaxGroups) + +
+
+ +

Limits the Maximum amount of Units that can be alive at the same time, and the maximum amount of groups that can be spawned.

+ + +

Note that this method is exceptionally important to balance 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... +When a SPAWN.New is executed and the limit of the amount of units alive is reached, then no new spawn will happen of the group, until some of these units of the spawn object will be destroyed.

+ +

Parameters

+
    +
  • + +

    #number SpawnMaxUnitsAlive : +The maximum amount of units that can be alive at runtime.

    + +
    • +
  • + +

    #number SpawnMaxGroups : +The maximum amount of groups that can be spawned. When the limit is reached, then no more actual 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 defines that there are no maximum group limits, but there are limits on the maximum of units that can be alive at the same time.

    + +
    • +
+

Return value

+ +

#SPAWN: +self

+ +

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:New(SpawnTemplatePrefix) + +
+
+ +

Creates the main object to spawn a GROUP defined in the DCS ME.

+ +

Parameter

+
    +
  • + +

    #string SpawnTemplatePrefix : +is the name of the Group in the ME that defines the Template. Each new group will have the name starting with SpawnTemplatePrefix.

    + +
    • +
+

Return value

+ +

#SPAWN:

+ + +

Usages:

+
    + 
  • -- NATO helicopters engaging in the battle field.
+Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' )
    • + 
  • local Plane = SPAWN:New( "Plane" ) -- Creates a new local variable that can initiate new planes with the name "Plane#ddd" using the template "Plane" as defined within the ME.
    • +
+ +
+
+
+
+ + +SPAWN:NewWithAlias(SpawnTemplatePrefix, SpawnAliasPrefix) + +
+
+ +

Creates a new SPAWN instance to create new groups based on the defined template and using a new alias for each new group.

+ +

Parameters

+
    +
  • + +

    #string SpawnTemplatePrefix : +is the name of the Group in the ME that defines the Template.

    + +
    • +
  • + +

    #string SpawnAliasPrefix : +is the name that will be given to the Group at runtime.

    + +
    • +
+

Return value

+ +

#SPAWN:

+ + +

Usages:

+
    + 
  • -- NATO helicopters engaging in the battle field.
+Spawn_BE_KA50 = SPAWN:NewWithAlias( 'BE KA-50@RAMP-Ground Defense', 'Helicopter Attacking a City' )
    • + 
  • local PlaneWithAlias = SPAWN:NewWithAlias( "Plane", "Bomber" ) -- Creates a new local variable that can instantiate new planes with the name "Bomber#ddd" using the template "Plane" as defined within the ME.
    • +
+ +
+
+
+
+ + +SPAWN:RandomizeRoute(SpawnStartPoint, SpawnEndPoint, SpawnRadius) + +
+
+ +

Randomizes the defined route of the SpawnTemplatePrefix group in the ME.

+ + +

This is very useful to define extra variation of the behaviour of groups.

+ +

Parameters

+
    +
  • + +

    #number SpawnStartPoint : +is the waypoint where the randomization begins. +Note that the StartPoint = 0 equaling the point where the group is spawned.

    + +
    • +
  • + +

    #number SpawnEndPoint : +is the waypoint where the randomization ends counting backwards. +This parameter is useful to avoid randomization to end at a waypoint earlier than the last waypoint on the route.

    + +
    • +
  • + +

    #number SpawnRadius : +is the radius in meters in which the randomization of the new waypoints, with the original waypoint of the original template located in the middle ...

    + +
    • +
+

Return value

+ +

#SPAWN:

+ + +

Usage:

+ 
-- NATO helicopters engaging in the battle field. 
+-- The KA-50 has waypoints Start point ( =0 or SP ), 1, 2, 3, 4, End point (= 5 or 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 radius of 2000 meters.
+Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):RandomizeRoute( 2, 2, 2000 )
+ +
+
+
+
+ + +SPAWN:RandomizeTemplate(SpawnTemplatePrefixTable) + +
+
+ +

This function is rather complicated to understand.

+ + +

But I'll try to explain. +This function becomes useful when you need to spawn groups with random templates of groups defined within the mission editor, +but they will all follow the same Template route and have the same prefix name. +In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.

+ +

Parameter

+
    +
  • + +

    #string SpawnTemplatePrefixTable : +A table with the names of the groups defined within the mission editor, from which one will be choosen when a new group will be spawned.

    + +
    • +
+

Return value

+ +

#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' SpawnTemplatePrefixes.
+-- 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:ReSpawn(SpawnIndex) + +
+
+ +

Will re-spawn a group based on a given index.

+ + +

Note: Uses DATABASE module defined in MOOSE.

+ +

Parameter

+
    +
  • + +

    #string SpawnIndex : +The index of the group to be spawned.

    + +
    • +
+

Return value

+ +

GROUP#GROUP: +The group that was spawned. You can use this group for further actions.

+ +
+
+
+
+ + +SPAWN:Repeat() + +
+
+ +

For planes and helicopters, when these groups 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 runtime environment.

+ + +

This function is used to re-spawn automatically (so no extra call is needed anymore) the same group after it has 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 re-spawn from the original airbase where it took off. +So ensure that the routes for groups that respawn, always return to the original airbase, or players may get confused ...

+ +

Return value

+ +

#SPAWN: +self

+ +

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:RepeatOnEngineShutDown() + +
+
+ +

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

+ +

Return value

+ + +

SPAWN

+ +
+
+
+
+ + +SPAWN:RepeatOnLanding() + +
+
+ + + +
+
+
+
+ + +SPAWN:Spawn() + +
+
+ +

Will re-spawn a group based on a given index.

+ + +

Note: Uses DATABASE module defined in MOOSE.

+ +

Return value

+ +

GROUP#GROUP: +The group that was spawned. You can use this group for further actions.

+ +
+
+
+
+ + +SPAWN:SpawnFromUnit(HostUnit, OuterRadius, InnerRadius, SpawnIndex) + +
+
+ +

Will spawn a group from a hosting unit.

+ + +

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. +Note that each point in the route assigned to the spawning group is reset to the point of the spawn. +You can use the returned group to further define the route to be followed.

+ +

Parameters

+
    +
  • + +

    Unit#UNIT HostUnit : +The air or ground unit dropping or unloading the group.

    + +
    • +
  • + +

    #number OuterRadius : +The outer radius in meters where the new group will be spawned.

    + +
    • +
  • + +

    #number InnerRadius : +The inner radius in meters where the new group will NOT be spawned.

    + +
    • +
  • + +

    #number SpawnIndex : +(Optional) The index which group to spawn within the given zone.

    + +
    • +
+

Return values

+
    +
  1. + +

    Group#GROUP: +that was spawned.

    + +
    2. +
  2. + +

    #nil: +Nothing was spawned.

    + +
    3. +
+
+
+
+
+ + +SPAWN:SpawnGroupName(SpawnIndex) + +
+
+ +

Will return the SpawnGroupName either with with a specific count number or without any count.

+ +

Parameter

+
    +
  • + +

    #number SpawnIndex : +Is the number of the Group that is to be spawned.

    + +
    • +
+

Return value

+ + +

string SpawnGroupName

+ +
+
+
+
+ + +SPAWN:SpawnInZone(Zone, SpawnIndex) + +
+
+ +

Will spawn a Group within a given ZONE.

+ +

Parameters

+
    +
  • + +

    #ZONE Zone : +The zone where the group is to be spawned.

    + +
    • +
  • + +

    #number SpawnIndex : +(Optional) The index which group to spawn within the given zone.

    + +
    • +
+

Return values

+
    +
  1. + +

    GROUP#GROUP: +that was spawned.

    + +
    2. +
  2. + +

    #nil: +when nothing was spawned.

    + +
    3. +
+
+
+
+
+ + +SPAWN:SpawnScheduleStart() + +
+
+ +

Will start the spawning scheduler.

+ + +

Note: This function is called automatically when SPAWN.Scheduled is called.

+ +
+
+
+
+ + +SPAWN:SpawnScheduleStop() + +
+
+ +

Will stop the scheduled spawning scheduler.

+ +
+
+
+
+ + +SPAWN:SpawnScheduled(SpawnTime, SpawnTimeVariation) + +
+
+ +

Spawns new groups at 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

+
    +
  • + +

    #number SpawnTime : +The time interval defined in seconds between each new spawn of new groups.

    + +
    • +
  • + +

    #number SpawnTimeVariation : +The variation to be applied on the defined time interval between each new spawn. +The variation is a number between 0 and 1, representing the %-tage of variation to be applied on the time interval.

    + +
    • +
+

Return value

+ +

#SPAWN: +self

+ +

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:SpawnWithIndex(SpawnIndex) + +
+
+ +

Will spawn a group with a specified index number.

+ + +

Uses DATABASE global object defined in MOOSE.

+ +

Parameter

+
    +
  • + +

    SpawnIndex :

    + +
    • +
+

Return value

+ +

GROUP#GROUP: +The group that was spawned. You can use this group for further actions.

+ +
+
+
+
+ + +SPAWN:UnControlled() + +
+
+ +

Will spawn a plane group in uncontrolled mode...

+ + +

This will be similar to the uncontrolled flag setting in the ME.

+ +

Return value

+ +

#SPAWN: +self

+ +
+
+
+
+ + +SPAWN:_GetGroupCategoryID(SpawnPrefix) + +
+
+ +

Gets the CategoryID of the Group with the given SpawnPrefix

+ +

Parameter

+
    +
  • + +

    SpawnPrefix :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetGroupCoalitionID(SpawnPrefix) + +
+
+ +

Gets the CoalitionID of the Group with the given SpawnPrefix

+ +

Parameter

+
    +
  • + +

    SpawnPrefix :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetGroupCountryID(SpawnPrefix) + +
+
+ +

Gets the CountryID of the Group with the given SpawnPrefix

+ +

Parameter

+
    +
  • + +

    SpawnPrefix :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetGroupFromDCSUnit(DCSUnit) + +
+
+ +

Return the group within the SpawnGroups collection with input a DCSUnit.

+ +

Parameter

+
    +
  • + +

    DCSUnit :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetGroupIndexFromDCSUnit(DCSUnit) + +
+
+ +

Get the group index from a DCSUnit.

+ + +

The method will search for a #-mark, and will return the index behind the #-mark of the DCSUnit. +It will return nil of no prefix was found.

+ +

Parameter

+
    +
  • + +

    DCSUnit : +The DCS unit to be searched.

    + +
    • +
+

Return values

+
    +
  1. + +

    #string: +The prefix

    + +
    2. +
  2. + +

    #nil: +Nothing found

    + +
    3. +
+
+
+
+
+ + +SPAWN:_GetLastIndex() + +
+
+ +

Return the last maximum index that can be used.

+ +
+
+
+
+ + +SPAWN:_GetPrefixFromDCSUnit(DCSUnit) + +
+
+ +

Return the prefix of a DCSUnit.

+ + +

The method will search for a #-mark, and will return the text before the #-mark. +It will return nil of no prefix was found.

+ +

Parameter

+
    +
  • + +

    DCSUnit : +The DCS unit to be searched.

    + +
    • +
+

Return values

+
    +
  1. + +

    #string: +The prefix

    + +
    2. +
  2. + +

    #nil: +Nothing found

    + +
    3. +
+
+
+
+
+ + +SPAWN:_GetSpawnIndex(SpawnIndex) + +
+
+ +

Get the next index of the groups to be spawned.

+ + +

This function is complicated, as it is used at several spaces.

+ +

Parameter

+
    +
  • + +

    SpawnIndex :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetTemplate(SpawnTemplatePrefix) + +
+
+ +

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.

+ +

Parameter

+
    +
  • + +

    SpawnTemplatePrefix :

    + +
    • +
+
+
+
+
+ + +SPAWN:_InitializeSpawnGroups(SpawnIndex) + +
+
+ +

Initalize the SpawnGroups collection.

+ +

Parameter

+
    +
  • + +

    SpawnIndex :

    + +
    • +
+
+
+
+
+ + +SPAWN:_OnBirth(event) + +
+
+ + + + +

TODO Need to delete this... _Database does this now ...

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +SPAWN:_OnDeadOrCrash(event) + +
+
+ +

Obscolete

+ +

Parameter

+
    +
  • + +

    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.

+ +

Parameter

+
    +
  • + +

    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.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +SPAWN:_Prepare(SpawnTemplatePrefix, SpawnIndex) + +
+
+ +

Prepares the new Group Template.

+ +

Parameters

+
    +
  • + +

    SpawnTemplatePrefix :

    + +
    • +
  • + +

    SpawnIndex :

    + +
    • +
+
+
+
+
+ + +SPAWN:_RandomizeRoute(SpawnIndex) + +
+
+ +

Internal function randomizing the routes.

+ +

Parameter

+
    +
  • + +

    #number SpawnIndex : +The index of the group to be spawned.

    + +
    • +
+

Return value

+ +

#SPAWN:

+ + +
+
+
+
+ + +SPAWN:_RandomizeTemplate(SpawnIndex) + +
+
+ + + +

Parameter

+
    +
  • + +

    SpawnIndex :

    + +
    • +
+
+
+
+
+ + +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.

+ +
+
+
+
+ + +SPAWN:_SpawnCleanUpScheduler() + +
+
+ + + +
+
+
+
+ + +SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) + +
+
+ + + +

Parameters

+
    +
  • + +

    SpawnIndex :

    + +
    • +
  • + +

    SpawnRootX :

    + +
    • +
  • + +

    SpawnRootY :

    + +
    • +
  • + +

    SpawnX :

    + +
    • +
  • + +

    SpawnY :

    + +
    • +
  • + +

    SpawnAngle :

    + +
    • +
+
+
+ +

Type ZONE

+ +
+ +
+ + diff --git a/Moose/docs/TASK.html b/Moose/docs/TASK.html new file mode 100644 index 000000000..a4d38d451 --- /dev/null +++ b/Moose/docs/TASK.html @@ -0,0 +1,1655 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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.

+ +

Global(s)

+ + + + + +
TASK + +
+

Type TASK

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TASK.ActiveStage + +
TASK.AddFlareBlue(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a BLUE FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddFlareGreen(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a GREEN FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddFlareOrange(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, an ORANGE FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddFlareRed(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a RED FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddFlareWhite(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a WHITE FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddGoalCompletion(string, string, number, self, GoalVerb, GoalTask, GoalIncrease) +

Adds an Additional Goal for the TASK to be achieved.

+
TASK:AddSignal(SignalUnitNames, SignalType, SignalColor, SignalHeight) +

Work function to set signal events within a TASK.

+
TASK.AddSmokeBlue(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a BLUE SMOKE will be fired by an optional SignalUnitNames.

+
TASK.AddSmokeGreen(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a GREEN SMOKE will be fired by an optional SignalUnitNames.

+
TASK.AddSmokeOrange(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, an ORANGE SMOKE will be fired by an optional SignalUnitNames.

+
TASK.AddSmokeRed(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a RED SMOKE will be fired by an optional SignalUnitNames.

+
TASK.AddSmokeWhite(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a WHITE SMOKE will be fired by an optional SignalUnitNames.

+
TASK.Cargos + +
TASK.ClassName + +
TASK:Done() +

Sets a TASK to status Done.

+
TASK:Failed() +

Sets a TASK to status failed.

+
TASK.GetGoalCompletion(?, self, GoalVerb) +

Returns if the additional Goal for the TASK was completed.

+
TASK.GetGoalCount(?, self, GoalVerb) +

Gets the total of Goals currently achieved within the TASK of the GoalVerb.

+
TASK.GetGoalPercentage(?, self, GoalVerb) +

Gets the percentage of Goals currently achieved within the TASK of the GoalVerb.

+
TASK:GetGoalProgress() +

Get progress of a TASK.

+
TASK.GetGoalTotal(?, self, GoalVerb) +

Gets the total of Goals to be achieved within the TASK of the GoalVerb.

+
TASK:GetGoals() +

Returns the Goals of a TASK

+
TASK.Goal(?, self, GoalVerb) +

Returns if a TASK has Goal(s).

+
TASK.GoalTasks + +
TASK.IncreaseGoalCount(number, ?, self, GoalCountIncrease, GoalVerb) +

Increments the total of Goals currently achieved within the TASK of the GoalVerb, with the given GoalCountIncrease.

+
TASK:Init() + +
TASK:IsDone() +

Returns if a TASK is done.

+
TASK:IsFailed() +

Returns if a TASk has failed.

+
TASK:IsGoalReached() +

Returns if all the Goals of the TASK were achieved.

+
TASK.LandingZones + +
TASK.MenuAction(Parameter) + +
TASK.Mission + +
TASK.Name + +
TASK:New() +

Instantiates a new TASK Base.

+
TASK:Reset(Mission, Client) + +
TASK.SIGNAL + +
TASK.SetGoalCount(number, ?, self, GoalCount, GoalVerb) +

Sets the total of Goals currently achieved within the TASK of the GoalVerb.

+
TASK.SetGoalTotal(number, ?, self, GoalTotal, GoalVerb) +

Sets the total Goals to be achieved of the Goal Name

+
TASK:SetStage(StageSequenceIncrement) + +
TASK.ShowGoalProgress(MISSION, CLIENT, self, Mission, Client) +

Show progress of a TASK.

+
TASK.Stage + +
TASK:StageExecute() + +
TASK.Stages + +
TASK.TaskDone + +
TASK.TaskFailed + +
+ +

Global(s)

+
+
+ + #TASK + +TASK + +
+
+ + + +
+
+

Type TASK

+ +

The TASK class

+ +

Field(s)

+
+
+ + #number + +TASK.ActiveStage + +
+
+ + + +
+
+
+
+ + +TASK.AddFlareBlue(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a BLUE FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddFlareGreen(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a GREEN FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddFlareOrange(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, an ORANGE FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddFlareRed(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a RED FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddFlareWhite(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a WHITE FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddGoalCompletion(string, string, number, self, GoalVerb, GoalTask, GoalIncrease) + +
+
+ +

Adds an Additional Goal for the TASK to be achieved.

+ +

Parameters

+
    +
  • + +

    string : +GoalVerb is the name of the Goal of the TASK.

    + +
    • +
  • + +

    string : +GoalTask is a text describing the Goal of the TASK to be achieved.

    + +
    • +
  • + +

    number : +GoalIncrease is a number by which the Goal achievement is increasing.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
  • + +

    GoalTask :

    + +
    • +
  • + +

    GoalIncrease :

    + +
    • +
+
+
+
+
+ + +TASK:AddSignal(SignalUnitNames, SignalType, SignalColor, SignalHeight) + +
+
+ +

Work function to set signal events within a TASK.

+ +

Parameters

+
    +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalType :

    + +
    • +
  • + +

    SignalColor :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeBlue(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a BLUE SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeGreen(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a GREEN SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeOrange(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, an ORANGE SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeRed(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a RED SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeWhite(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a WHITE SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + + +TASK.Cargos + +
+
+ + + +
+
+
+
+ + #string + +TASK.ClassName + +
+
+ + + +
+
+
+
+ + +TASK:Done() + +
+
+ +

Sets a TASK to status Done.

+ +
+
+
+
+ + +TASK:Failed() + +
+
+ +

Sets a TASK to status failed.

+ +
+
+
+
+ + +TASK.GetGoalCompletion(?, self, GoalVerb) + +
+
+ +

Returns if the additional Goal for the TASK was completed.

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

string Goals

+ +
+
+
+
+ + +TASK.GetGoalCount(?, self, GoalVerb) + +
+
+ +

Gets the total of Goals currently achieved within the TASK of the GoalVerb.

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK.GetGoalPercentage(?, self, GoalVerb) + +
+
+ +

Gets the percentage of Goals currently achieved within the TASK of the GoalVerb.

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK:GetGoalProgress() + +
+
+ +

Get progress of a TASK.

+ +

Return value

+ + +

string GoalsText

+ +
+
+
+
+ + +TASK.GetGoalTotal(?, self, GoalVerb) + +
+
+ +

Gets the total of Goals to be achieved within the TASK of the GoalVerb.

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+
+
+
+
+ + +TASK:GetGoals() + +
+
+ +

Returns the Goals of a TASK

+ +

Return value

+ + +

@table Goals

+ +
+
+
+
+ + +TASK.Goal(?, self, GoalVerb) + +
+
+ +

Returns if a TASK has Goal(s).

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

bool

+ +
+
+
+
+ + + +TASK.GoalTasks + +
+
+ + + +
+
+
+
+ + +TASK.IncreaseGoalCount(number, ?, self, GoalCountIncrease, GoalVerb) + +
+
+ +

Increments the total of Goals currently achieved within the TASK of the GoalVerb, with the given GoalCountIncrease.

+ +

Parameters

+
    +
  • + +

    number : +GoalCountIncrease is the number of new Goals achieved within the TASK.

    + +
    • +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalCountIncrease :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK:Init() + +
+
+ + + +
+
+
+
+ + +TASK:IsDone() + +
+
+ +

Returns if a TASK is done.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + +TASK:IsFailed() + +
+
+ +

Returns if a TASk has failed.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + +TASK:IsGoalReached() + +
+
+ +

Returns if all the Goals of the TASK were achieved.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + + +TASK.LandingZones + +
+
+ + + +
+
+
+
+ + +TASK.MenuAction(Parameter) + +
+
+ + + +

Parameter

+
    +
  • + +

    Parameter :

    + +
    • +
+
+
+
+
+ + + +TASK.Mission + +
+
+ + + +
+
+
+
+ + #string + +TASK.Name + +
+
+ + + +
+
+
+
+ + +TASK:New() + +
+
+ +

Instantiates a new TASK Base.

+ + +

Should never be used. Interface Class.

+ +

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK:Reset(Mission, Client) + +
+
+ + + +

Parameters

+
    +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
+
+
+
+
+ + + +TASK.SIGNAL + +
+
+ + + + +

Defines the different signal types with a Task.

+ +
+
+
+
+ + +TASK.SetGoalCount(number, ?, self, GoalCount, GoalVerb) + +
+
+ +

Sets the total of Goals currently achieved within the TASK of the GoalVerb.

+ +

Parameters

+
    +
  • + +

    number : +GoalCount is the total number of Goals achieved within the TASK.

    + +
    • +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalCount :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK.SetGoalTotal(number, ?, self, GoalTotal, GoalVerb) + +
+
+ +

Sets the total Goals to be achieved of the Goal Name

+ +

Parameters

+
    +
  • + +

    number : +GoalTotal is the number of times the GoalVerb needs to be achieved.

    + +
    • +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalTotal :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+
+
+
+
+ + +TASK:SetStage(StageSequenceIncrement) + +
+
+ + + +

Parameter

+
    +
  • + +

    StageSequenceIncrement :

    + +
    • +
+
+
+
+
+ + +TASK.ShowGoalProgress(MISSION, CLIENT, self, Mission, Client) + +
+
+ +

Show progress of a TASK.

+ +

Parameters

+
    +
  • + +

    MISSION :

    +
    Mission         Group structure describing the Mission.
+
    + +
    • +
  • + +

    CLIENT : +Client Group structure describing the Client.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
+
+
+
+
+ + + +TASK.Stage + +
+
+ + + +
+
+
+
+ + +TASK:StageExecute() + +
+
+ + + +
+
+
+
+ + + +TASK.Stages + +
+
+ + + +
+
+
+
+ + #boolean + +TASK.TaskDone + +
+
+ + + +
+
+
+
+ + #boolean + +TASK.TaskFailed + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/Moose/docs/Unit.html b/Moose/docs/Unit.html new file mode 100644 index 000000000..39ccc3046 --- /dev/null +++ b/Moose/docs/Unit.html @@ -0,0 +1,382 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Unit

+ +

UNIT Classes

+ +

Global(s)

+ + + + + +
UNIT + +
+

Type UNIT

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNIT.CategoryName + +
UNIT.ClassName + +
UNIT:GetCallSign() + +
UNIT:GetCategoryName() + +
UNIT:GetDCSUnit() + +
UNIT:GetID() + +
UNIT:GetName() + +
UNIT:GetPointVec2() + +
UNIT:GetPositionVec3() + +
UNIT:GetPrefix() + +
UNIT:GetTypeName() + +
UNIT:IsAlive() + +
UNIT:New(DCSUnit) + +
UNIT:OtherUnitInRadius(AwaitUnit, Radius) + +
+ +

Global(s)

+
+
+ + #UNIT + +UNIT + +
+
+ + + +
+
+

Type Unit

+ +

Type UNIT

+ +

The UNIT class

+ +

Field(s)

+
+
+ + + +UNIT.CategoryName + +
+
+ + + +
+
+
+
+ + #string + +UNIT.ClassName + +
+
+ + + +
+
+
+
+ + +UNIT:GetCallSign() + +
+
+ + + +
+
+
+
+ + +UNIT:GetCategoryName() + +
+
+ + + +
+
+
+
+ + +UNIT:GetDCSUnit() + +
+
+ + + +
+
+
+
+ + +UNIT:GetID() + +
+
+ + + +
+
+
+
+ + +UNIT:GetName() + +
+
+ + + +
+
+
+
+ + +UNIT:GetPointVec2() + +
+
+ + + +
+
+
+
+ + +UNIT:GetPositionVec3() + +
+
+ + + +
+
+
+
+ + +UNIT:GetPrefix() + +
+
+ + + +
+
+
+
+ + +UNIT:GetTypeName() + +
+
+ + + +
+
+
+
+ + +UNIT:IsAlive() + +
+
+ + + +
+
+
+
+ + +UNIT:New(DCSUnit) + +
+
+ + + +

Parameter

+
    +
  • + +

    DCSUnit :

    + +
    • +
+
+
+
+
+ + +UNIT:OtherUnitInRadius(AwaitUnit, Radius) + +
+
+ + + +

Parameters

+
    +
  • + +

    AwaitUnit :

    + +
    • +
  • + +

    Radius :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Moose/docs/Zone.html b/Moose/docs/Zone.html new file mode 100644 index 000000000..52a3e0d58 --- /dev/null +++ b/Moose/docs/Zone.html @@ -0,0 +1,197 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Zone

+ +

ZONE Classes

+ +

Global(s)

+ + + + + +
ZONE + +
+

Type ZONE

+ + + + + + + + + + + + + + + + + + + + + +
ZONE.ClassName + +
ZONE:GetPointVec2() + +
ZONE:GetRadius() + +
ZONE:GetRandomPoint() + +
ZONE:New(ZoneName) + +
+ +

Global(s)

+
+
+ + #ZONE + +ZONE + +
+
+ + + +
+
+

Type Zone

+ +

Type ZONE

+ +

The ZONE class

+ +

Field(s)

+
+
+ + #string + +ZONE.ClassName + +
+
+ + + +
+
+
+
+ + +ZONE:GetPointVec2() + +
+
+ + + +
+
+
+
+ + +ZONE:GetRadius() + +
+
+ + + +
+
+
+
+ + +ZONE:GetRandomPoint() + +
+
+ + + +
+
+
+
+ + +ZONE:New(ZoneName) + +
+
+ + + +

Parameter

+
    +
  • + +

    ZoneName :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/Moose/docs/index.html b/Moose/docs/index.html new file mode 100644 index 000000000..eb2ac62be --- /dev/null +++ b/Moose/docs/index.html @@ -0,0 +1,212 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Base +

BASE The base class for all the classes defined within MOOSE.

+
CARGO +

CARGO Classes

+
CLEANUP +

CLEANUP Classes

+
Client +

CLIENT Classes

+
DEPLOYTASK +

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

+
DESTROYBASETASK +

A DESTROYBASETASK will monitor the destruction of Groups and Units.

+
DESTROYGROUPSTASK +

DESTROYGROUPSTASK

+
DESTROYRADARSTASK +

Task class to destroy radar installations.

+
DESTROYUNITTYPESTASK +

Set TASK to destroy certain unit types.

+
Database +

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

+
GOHOMETASK +

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

+
Group +

A GROUP class abstraction of a DCSGroup class.

+
MISSION +

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

+
MOVEMENT +

Limit the simultaneous movement of Groups within a running Mission.

+
Menu +

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

+
Message +

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

+
NOTASK +

A NOTASK is a dummy activity...

+
PICKUPTASK +

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

+
ROUTETASK +

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

+
STAGE +

Stages within a TASK within a MISSION.

+
Sead +

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

+
Spawn +

Dynamic spawning of groups (and units).

+
TASK +

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

+
Unit +

UNIT Classes

+
Zone +

ZONE Classes

+
routines +

Various routines

+
+
+ +
+ + diff --git a/Moose/docs/routines.html b/Moose/docs/routines.html new file mode 100644 index 000000000..e562adbcb --- /dev/null +++ b/Moose/docs/routines.html @@ -0,0 +1,1187 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module routines

+ +

Various routines

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alive + +
ChooseInfantry(TeleportPrefixTable, TeleportMax) + +
EscortCarrier(CarrierGroup, EscortPrefix, EscortLastWayPoint, EscortEngagementDistanceMax, EscortTargetTypes) + +
EscortCount + +
EscortMissionName + +
GetUnitHeight(CheckUnit) + +
GroupAlive(groupName) + +
LandCarrier(CarrierGroup, LandingZonePrefix) + +
MessageToAll(MsgText, MsgTime, MsgName) + +
MessageToBlue(MsgText, MsgTime, MsgName) + +
MessageToUnit(UnitName, MsgText, MsgTime, MsgName) + +
MusicRegister(SndRef, SndFile, SndTime) + +
MusicReset(flg) + +
MusicToPlayer(SndRef, PlayerName, SndContinue) + +
PlaneActivate(groupNameFormat, flg) + +
PlayerGroup + +
SendMessageToCarrier(CarrierGroup, CarrierMessage) + +
SpawnSettings + +
SpawnedInfantry + +
Su34AttackCarlVinson(groupName) + +
Su34AttackNorth(groupName) + +
Su34AttackWest(groupName) + +
Su34Destroyed(groupName) + +
Su34Hold(groupName) + +
Su34IsDead() + +
Su34Menu(groupName) + +
Su34MenuPath + +
Su34Menus + +
Su34Orbit(groupName) + +
Su34OverviewStatus() + +
Su34RTB(groupName) + +
Su34Status + +
Su34TakeOff(groupName) + +
TeleportPrefixTableCount + +
TeleportPrefixTableIndex + +
UpdateBoardMsg() + +
_MusicTable + +
boardMsgAll + +
boardMsgRed + +
getCarrierHeight(CarrierGroup) + +
lookup_table + +
routines + +
spairs(t, order) + +
+

Global(s)

+
+
+ + + +Alive + +
+
+ + + +
+
+
+
+ + +ChooseInfantry(TeleportPrefixTable, TeleportMax) + +
+
+ + + +

Parameters

+
    +
  • + +

    TeleportPrefixTable :

    + +
    • +
  • + +

    TeleportMax :

    + +
    • +
+
+
+
+
+ + +EscortCarrier(CarrierGroup, EscortPrefix, EscortLastWayPoint, EscortEngagementDistanceMax, EscortTargetTypes) + +
+
+ + + +

Parameters

+
    +
  • + +

    CarrierGroup :

    + +
    • +
  • + +

    EscortPrefix :

    + +
    • +
  • + +

    EscortLastWayPoint :

    + +
    • +
  • + +

    EscortEngagementDistanceMax :

    + +
    • +
  • + +

    EscortTargetTypes :

    + +
    • +
+
+
+
+
+ + #number + +EscortCount + +
+
+ + + +
+
+
+
+ + + +EscortMissionName + +
+
+ + + +
+
+
+
+ + +GetUnitHeight(CheckUnit) + +
+
+ + + +

Parameter

+
    +
  • + +

    CheckUnit :

    + +
    • +
+
+
+
+
+ + +GroupAlive(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +LandCarrier(CarrierGroup, LandingZonePrefix) + +
+
+ + + +

Parameters

+
    +
  • + +

    CarrierGroup :

    + +
    • +
  • + +

    LandingZonePrefix :

    + +
    • +
+
+
+
+
+ + +MessageToAll(MsgText, MsgTime, MsgName) + +
+
+ + + +

Parameters

+
    +
  • + +

    MsgText :

    + +
    • +
  • + +

    MsgTime :

    + +
    • +
  • + +

    MsgName :

    + +
    • +
+
+
+
+
+ + +MessageToBlue(MsgText, MsgTime, MsgName) + +
+
+ + + +

Parameters

+
    +
  • + +

    MsgText :

    + +
    • +
  • + +

    MsgTime :

    + +
    • +
  • + +

    MsgName :

    + +
    • +
+
+
+
+
+ + +MessageToUnit(UnitName, MsgText, MsgTime, MsgName) + +
+
+ + + +

Parameters

+
    +
  • + +

    UnitName :

    + +
    • +
  • + +

    MsgText :

    + +
    • +
  • + +

    MsgTime :

    + +
    • +
  • + +

    MsgName :

    + +
    • +
+
+
+
+
+ + +MusicRegister(SndRef, SndFile, SndTime) + +
+
+ + + +

Parameters

+
    +
  • + +

    SndRef :

    + +
    • +
  • + +

    SndFile :

    + +
    • +
  • + +

    SndTime :

    + +
    • +
+
+
+
+
+ + +MusicReset(flg) + +
+
+ + + +

Parameter

+
    +
  • + +

    flg :

    + +
    • +
+
+
+
+
+ + +MusicToPlayer(SndRef, PlayerName, SndContinue) + +
+
+ + + +

Parameters

+
    +
  • + +

    SndRef :

    + +
    • +
  • + +

    PlayerName :

    + +
    • +
  • + +

    SndContinue :

    + +
    • +
+
+
+
+
+ + +PlaneActivate(groupNameFormat, flg) + +
+
+ + + +

Parameters

+
    +
  • + +

    groupNameFormat :

    + +
    • +
  • + +

    flg :

    + +
    • +
+
+
+
+
+ + + +PlayerGroup + +
+
+ + + +
+
+
+
+ + +SendMessageToCarrier(CarrierGroup, CarrierMessage) + +
+
+ + + +

Parameters

+
    +
  • + +

    CarrierGroup :

    + +
    • +
  • + +

    CarrierMessage :

    + +
    • +
+
+
+
+
+ + + +SpawnSettings + +
+
+ + + +
+
+
+
+ + #number + +SpawnedInfantry + +
+
+ + + +
+
+
+
+ + +Su34AttackCarlVinson(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34AttackNorth(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34AttackWest(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34Destroyed(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34Hold(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34IsDead() + +
+
+ + + +
+
+
+
+ + +Su34Menu(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + + +Su34MenuPath + +
+
+ + + +
+
+
+
+ + #number + +Su34Menus + +
+
+ + + +
+
+
+
+ + +Su34Orbit(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34OverviewStatus() + +
+
+ + + +
+
+
+
+ + +Su34RTB(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + + +Su34Status + +
+
+ + + +
+
+
+
+ + +Su34TakeOff(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +TeleportPrefixTableCount + +
+
+ + + +
+
+
+
+ + + +TeleportPrefixTableIndex + +
+
+ + + +
+
+
+
+ + +UpdateBoardMsg() + +
+
+ + + +
+
+
+
+ + + +_MusicTable + +
+
+ + + +
+
+
+
+ + + +boardMsgAll + +
+
+ + + +
+
+
+
+ + + +boardMsgRed + +
+
+ + + +
+
+
+
+ + +getCarrierHeight(CarrierGroup) + +
+
+ + + +

Parameter

+
    +
  • + +

    CarrierGroup :

    + +
    • +
+
+
+
+
+ + + +lookup_table + +
+
+ + + +
+
+
+
+ + + +routines + +
+
+ + + +
+
+
+
+ + +spairs(t, order) + +
+
+ + + +

Parameters

+
    +
  • + +

    t :

    + +
    • +
  • + +

    order :

    + +
    • +
+
+
+

Type routines

+ +
+ +
+ + diff --git a/Moose/docs/stylesheet.css b/Moose/docs/stylesheet.css new file mode 100644 index 000000000..1b82635b5 --- /dev/null +++ b/Moose/docs/stylesheet.css @@ -0,0 +1,269 @@ +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: bullet; + 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; } + +body, p, td, th { font-size: .95em; line-height: 1.2em;} + +p, ul { margin: 10px 0 0 10px;} + +strong { font-weight: bold;} + +em { font-style: italic;} + +h1 { + font-size: 1.5em; + margin: 25px 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; +} + +p:first-child { + margin-top: 0px; +} + +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; + 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: 18em; + vertical-align: top; + background-color: #f0f0f0; + overflow: scroll; + position: fixed; + height:100%; +} + +#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: 18em; + padding: 1em; + 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; } +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; } +table.function_list td.summary { width: 100%; } + +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;} + diff --git a/docs/Base.html b/docs/Base.html new file mode 100644 index 000000000..4c165b9e9 --- /dev/null +++ b/docs/Base.html @@ -0,0 +1,745 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Base

+ +

BASE The base class for all the classes defined within MOOSE.

+ +

Global(s)

+ + + + + + + + + +
BASE + +
FORMATION + +
+

Type BASE

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BASE:AddEvent(Event, EventFunction) + +
BASE.ClassID +

The ID number of the class.

+
BASE.ClassName +

The name of the class.

+
BASE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) + +
BASE:CreateEventCrash(EventTime, Initiator) + +
BASE:DisableEvents() + +
BASE:E(Arguments) + +
BASE:EnableEvents() + +
BASE.Events + +
BASE:F(Arguments) + +
BASE:F2(Arguments) + +
BASE:F3(Arguments) + +
BASE:GetClassID() +

Get the ClassID of the class instance.

+
BASE:GetClassName() +

Get the ClassName of the class instance.

+
BASE:GetClassNameAndID() +

Get the ClassName + ClassID of the class instance.

+
BASE.Inherit(Child, Parent, self) +

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

+
BASE.Inherited(Child, self) +

This is the worker method to retrieve the Parent class.

+
BASE:New() + +
BASE:T(Arguments) + +
BASE:T2(Arguments) + +
BASE:T3(Arguments) + +
BASE:onEvent(event) + +
+ +

Type FORMATION

+ + + + + +
FORMATION.Cone +

A cone formation.

+
+ +

Global(s)

+
+
+ + #BASE + +BASE + +
+
+ + + +
+
+
+
+ + #FORMATION + +FORMATION + +
+
+ + + +
+
+

Type Base

+ +

Type BASE

+ +

The BASE Class

+ +

Field(s)

+
+
+ + +BASE:AddEvent(Event, EventFunction) + +
+
+ + + +

Parameters

+
    +
  • + +

    Event :

    + +
    • +
  • + +

    EventFunction :

    + +
    • +
+
+
+
+
+ + +BASE.ClassID + +
+
+ +

The ID number of the class.

+ +
+
+
+
+ + +BASE.ClassName + +
+
+ +

The name of the class.

+ +
+
+
+
+ + +BASE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) + +
+
+ + + +

Parameters

+
    +
  • + +

    EventTime :

    + +
    • +
  • + +

    Initiator :

    + +
    • +
  • + +

    IniUnitName :

    + +
    • +
  • + +

    place :

    + +
    • +
  • + +

    subplace :

    + +
    • +
+
+
+
+
+ + +BASE:CreateEventCrash(EventTime, Initiator) + +
+
+ + + +

Parameters

+
    +
  • + +

    EventTime :

    + +
    • +
  • + +

    Initiator :

    + +
    • +
+
+
+
+
+ + +BASE:DisableEvents() + +
+
+ + + +
+
+
+
+ + +BASE:E(Arguments) + +
+
+ + + + +

Log an exception

+ +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:EnableEvents() + +
+
+ + + +
+
+
+
+ + + +BASE.Events + +
+
+ + + +
+
+
+
+ + +BASE:F(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:F2(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:F3(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:GetClassID() + +
+
+ +

Get the ClassID of the class instance.

+ +

Return value

+ +

#string: +The ClassID of the class instance.

+ +
+
+
+
+ + +BASE:GetClassName() + +
+
+ +

Get the ClassName of the class instance.

+ +

Return value

+ +

#string: +The ClassName of the class instance.

+ +
+
+
+
+ + +BASE:GetClassNameAndID() + +
+
+ +

Get the ClassName + ClassID of the class instance.

+ + +

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

+ +

Return value

+ +

#string: +The ClassName + ClassID of the class instance.

+ +
+
+
+
+ + +BASE.Inherit(Child, Parent, self) + +
+
+ +

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

+ +

Parameters

+
    +
  • + +

    Child : +is the Child class that inherits.

    + +
    • +
  • + +

    Parent : +is the Parent class that the Child inherits from.

    + +
    • +
  • + +

    self :

    + +
    • +
+

Return value

+ + +

Child

+ +
+
+
+
+ + +BASE.Inherited(Child, self) + +
+
+ +

This is the worker method to retrieve the Parent class.

+ +

Parameters

+
    +
  • + +

    #BASE Child : +is the Child class from which the Parent class needs to be retrieved.

    + +
    • +
  • + +

    self :

    + +
    • +
+

Return value

+ +

#BASE:

+ + +
+
+
+
+ + +BASE:New() + +
+
+ + + +
+
+
+
+ + +BASE:T(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:T2(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:T3(Arguments) + +
+
+ + + +

Parameter

+
    +
  • + +

    Arguments :

    + +
    • +
+
+
+
+
+ + +BASE:onEvent(event) + +
+
+ + + +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+ +

Type FORMATION

+ +

The Formation Class

+ +

Field(s)

+
+
+ + +FORMATION.Cone + +
+
+ +

A cone formation.

+ +
+
+ +
+ +
+ + diff --git a/docs/CARGO.html b/docs/CARGO.html new file mode 100644 index 000000000..87f70296b --- /dev/null +++ b/docs/CARGO.html @@ -0,0 +1,204 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module CARGO

+ +

CARGO Classes

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CARGO + +
CARGOS + +
CARGO_GROUP + +
CARGO_PACKAGE + +
CARGO_SLINGLOAD + +
CARGO_ZONE + +
CargoStatic + +
+

Global(s)

+
+
+ + + +CARGO + +
+
+ + + +
+
+
+
+ + + +CARGOS + +
+
+ + + +
+
+
+
+ + + +CARGO_GROUP + +
+
+ + + +
+
+
+
+ + + +CARGO_PACKAGE + +
+
+ + + +
+
+
+
+ + + +CARGO_SLINGLOAD + +
+
+ + + +
+
+
+
+ + + +CARGO_ZONE + +
+
+ + + +
+
+
+
+ + + +CargoStatic + +
+
+ + + +
+
+

Type CARGO

+ +
+ +
+ + diff --git a/docs/CLEANUP.html b/docs/CLEANUP.html new file mode 100644 index 000000000..ffcde52b3 --- /dev/null +++ b/docs/CLEANUP.html @@ -0,0 +1,486 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module CLEANUP

+ +

CLEANUP Classes

+ +

Global(s)

+ + + + + + + + + +
CLEANUP + +
CleanUpSurfaceTypeText + +
+

Type CLEANUP

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CLEANUP.ClassName + +
CLEANUP.CleanUpList + +
CLEANUP:New(ZoneNames, TimeInterval) + +
CLEANUP.TimeInterval + +
CLEANUP.ZoneNames + +
CLEANUP:_AddForCleanUp(CleanUpUnit, CleanUpUnitName) + +
CLEANUP:_DestroyGroup(GroupObject, CleanUpGroupName) +

Destroys a group from the simulator, but checks first if it is still existing!

+
CLEANUP:_DestroyMissile(MissileObject) +

Destroys a missile from the simulator, but checks first if it is still existing!

+
CLEANUP:_DestroyUnit(CleanUpUnit, CleanUpUnitName) +

Destroys a unit from the simulator, but checks first if it is still existing!

+
CLEANUP:_EventAddForCleanUp(event) +

Detects if the Unit has an SEVENTENGINESHUTDOWN or an SEVENT_HIT within the given ZoneNames.

+
CLEANUP:_EventCrash(event) +

Detects if an SA site was shot with an anti radiation missile.

+
CLEANUP:_EventHitCleanUp(event) +

Detects if the Unit has an SEVENTHIT within the given ZoneNames.

+
CLEANUP:_EventShot(event) +

Detects if an SA site was shot with an anti radiation missile.

+
CLEANUP:_Scheduler() +

At the defined time interval, CleanUp the Groups within the CleanUpList.

+
+ +

Global(s)

+
+
+ + #CLEANUP + +CLEANUP + +
+
+ + + +
+
+
+
+ + + +CleanUpSurfaceTypeText + +
+
+ + + +
+
+

Type CLEANUP

+ +

The CLEANUP class.

+ +

Field(s)

+
+
+ + #string + +CLEANUP.ClassName + +
+
+ + + +
+
+
+
+ + + +CLEANUP.CleanUpList + +
+
+ + + +
+
+
+
+ + +CLEANUP:New(ZoneNames, TimeInterval) + +
+
+ + + +

Parameters

+
    +
  • + +

    ZoneNames :

    + +
    • +
  • + +

    TimeInterval :

    + +
    • +
+
+
+
+
+ + #number + +CLEANUP.TimeInterval + +
+
+ + + +
+
+
+
+ + + +CLEANUP.ZoneNames + +
+
+ + + +
+
+
+
+ + +CLEANUP:_AddForCleanUp(CleanUpUnit, CleanUpUnitName) + +
+
+ + + +

Parameters

+
    +
  • + +

    CleanUpUnit :

    + +
    • +
  • + +

    CleanUpUnitName :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_DestroyGroup(GroupObject, CleanUpGroupName) + +
+
+ +

Destroys a group from the simulator, but checks first if it is still existing!

+ +

Parameters

+
    +
  • + +

    GroupObject :

    + +
    • +
  • + +

    CleanUpGroupName :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_DestroyMissile(MissileObject) + +
+
+ +

Destroys a missile from the simulator, but checks first if it is still existing!

+ +

Parameter

+
    +
  • + +

    MissileObject :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_DestroyUnit(CleanUpUnit, CleanUpUnitName) + +
+
+ +

Destroys a unit from the simulator, but checks first if it is still existing!

+ +

Parameters

+
    +
  • + +

    CleanUpUnit :

    + +
    • +
  • + +

    CleanUpUnitName :

    + +
    • +
+
+
+
+
+ + +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.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_EventCrash(event) + +
+
+ +

Detects if an SA site was shot with an anti radiation missile.

+ + +

In this case, take evasive actions based on the skill level set within the ME.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_EventHitCleanUp(event) + +
+
+ +

Detects if the Unit has an SEVENTHIT within the given ZoneNames.

+ + +

If this is the case, destroy the unit.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_EventShot(event) + +
+
+ +

Detects if an SA site was shot with an anti radiation missile.

+ + +

In this case, take evasive actions based on the skill level set within the ME.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +CLEANUP:_Scheduler() + +
+
+ +

At the defined time interval, CleanUp the Groups within the CleanUpList.

+ +
+
+ +
+ +
+ + diff --git a/docs/Client.html b/docs/Client.html new file mode 100644 index 000000000..a77456c52 --- /dev/null +++ b/docs/Client.html @@ -0,0 +1,944 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Client

+ +

CLIENT Classes

+ +

Global(s)

+ + + + + + + + + +
CLIENT + +
ClientGroupUnit + +
+

Type CLIENT

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CLIENT.AddBriefing(string, self, ClientBriefing) +

AddBriefing adds a briefing to a Client when a Player joins a Mission.

+
CLIENT:Alive(CallBack) +

Checks for a client alive event and calls a function on a continuous basis.

+
CLIENT.AliveCheckFunction + +
CLIENT.ClassName + +
CLIENT.ClientAlive + +
CLIENT.ClientAlive2 + +
CLIENT.ClientBriefingShown + +
CLIENT.ClientCallBack + +
CLIENT.ClientName + +
CLIENT:ClientPosition() +

Returns the Position of the CLIENT.

+
CLIENT.ClientTransport + +
CLIENT:GetAltitude() +

Returns the altitude of the CLIENT.

+
CLIENT:GetClientGroupDCSUnit() +

Returns the DCSUnit of the CLIENT.

+
CLIENT:GetClientGroupID() + +
CLIENT:GetClientGroupName() + +
CLIENT:GetClientGroupUnit() +

Returns the Unit of the CLIENT.

+
CLIENT:GetDCSGroup() +

Return the DCSGroup of a Client.

+
CLIENT:GetPointVec2() +

Returns the Point of the CLIENT.

+
CLIENT:GetUnit() + +
CLIENT:IsAlive(Returns) +

Checks if client is alive and returns true or false.

+
CLIENT:IsTransport() +

IsTransport returns if a Client is a transport.

+
CLIENT.Message(string, number, string, string, number, self, Message, MessageDuration, MessageId, MessageCategory, MessageInterval) +

Message is the key Message driver for the CLIENT class.

+
CLIENT.Messages + +
CLIENT:New(ClientName, ClientBriefing) +

Use this method to register new Clients within the MOF.

+
CLIENT.ONBOARDSIDE + +
CLIENT.Reset(string, self, ClientName) +

Resets a CLIENT.

+
CLIENT:ShowCargo() +

ShowCargo shows the CARGO within the CLIENT to the Player.

+
CLIENT.SwitchMessages(PrmTable) +

SwitchMessages is a local function called by the DCS World Menu system to switch off messages.

+
CLIENT:Transport() +

Transport defines that the Client is a Transport.

+
CLIENT:_AliveCheckCallBack() + +
CLIENT._Menus + +
CLIENT._Tasks + +
+ +

Global(s)

+
+
+ + #CLIENT + +CLIENT + +
+
+ + + +
+
+
+
+ + + +ClientGroupUnit + +
+
+ + + +
+
+

Type Client

+ +

Type CLIENT

+ +

The CLIENT class

+ +

Field(s)

+
+
+ + +CLIENT.AddBriefing(string, self, ClientBriefing) + +
+
+ +

AddBriefing adds a briefing to a Client when a Player joins a Mission.

+ +

Parameters

+
    +
  • + +

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

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    ClientBriefing :

    + +
    • +
+

Return value

+ + +

CLIENT

+ +
+
+
+
+ + +CLIENT:Alive(CallBack) + +
+
+ +

Checks for a client alive event and calls a function on a continuous basis.

+ +

Parameter

+
    +
  • + +

    #function CallBack : +Function.

    + +
    • +
+
+
+
+
+ + + +CLIENT.AliveCheckFunction + +
+
+ + + +
+
+
+
+ + #string + +CLIENT.ClassName + +
+
+ + + +
+
+
+
+ + #boolean + +CLIENT.ClientAlive + +
+
+ + + +
+
+
+
+ + #boolean + +CLIENT.ClientAlive2 + +
+
+ + + +
+
+
+
+ + #boolean + +CLIENT.ClientBriefingShown + +
+
+ + + +
+
+
+
+ + + +CLIENT.ClientCallBack + +
+
+ + + +
+
+
+
+ + +CLIENT.ClientName + +
+
+ + + +
+
+
+
+ + +CLIENT:ClientPosition() + +
+
+ +

Returns the Position of the CLIENT.

+ +

Return value

+ +

DCSTypes#Position:

+ + +
+
+
+
+ + #boolean + +CLIENT.ClientTransport + +
+
+ + + +
+
+
+
+ + +CLIENT:GetAltitude() + +
+
+ +

Returns the altitude of the CLIENT.

+ +

Return value

+ +

DCSTypes#Distance:

+ + +
+
+
+
+ + +CLIENT:GetClientGroupDCSUnit() + +
+
+ +

Returns the DCSUnit of the CLIENT.

+ +

Return value

+ + +

DCSUnit

+ +
+
+
+
+ + +CLIENT:GetClientGroupID() + +
+
+ + + +
+
+
+
+ + +CLIENT:GetClientGroupName() + +
+
+ + + +
+
+
+
+ + +CLIENT:GetClientGroupUnit() + +
+
+ +

Returns the Unit of the CLIENT.

+ +

Return value

+ +

Unit#UNIT:

+ + +
+
+
+
+ + +CLIENT:GetDCSGroup() + +
+
+ +

Return the DCSGroup of a Client.

+ + +

This function is modified to deal with a couple of bugs in DCS 1.5.3

+ +

Return value

+ +

DCSGroup#Group:

+ + +
+
+
+
+ + +CLIENT:GetPointVec2() + +
+
+ +

Returns the Point of the CLIENT.

+ +

Return value

+ +

DCSTypes#Vec2:

+ + +
+
+
+
+ + +CLIENT:GetUnit() + +
+
+ + + +
+
+
+
+ + +CLIENT:IsAlive(Returns) + +
+
+ +

Checks if client is alive and returns true or false.

+ +

Parameter

+
    +
  • + +

    #boolean Returns : +true if client is alive.

    + +
    • +
+
+
+
+
+ + +CLIENT:IsTransport() + +
+
+ +

IsTransport returns if a Client is a transport.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + +CLIENT.Message(string, number, string, string, number, self, 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

+
    +
  • + +

    string : +Message is the text describing the message.

    + +
    • +
  • + +

    number : +MessageDuration is the duration in seconds that the Message should be displayed.

    + +
    • +
  • + +

    string : +MessageId is a text identifying the Message in the MessageQueue. The Message system overwrites Messages with the same MessageId

    + +
    • +
  • + +

    string : +MessageCategory is the category of the message (the title).

    + +
    • +
  • + +

    number : +MessageInterval is the interval in seconds between the display of the Message when the CLIENT is in the air.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    Message :

    + +
    • +
  • + +

    MessageDuration :

    + +
    • +
  • + +

    MessageId :

    + +
    • +
  • + +

    MessageCategory :

    + +
    • +
  • + +

    MessageInterval :

    + +
    • +
+
+
+
+
+ + + +CLIENT.Messages + +
+
+ + + +
+
+
+
+ + +CLIENT:New(ClientName, ClientBriefing) + +
+
+ +

Use this method to register new Clients within the MOF.

+ +

Parameters

+
    +
  • + +

    #string ClientName : +Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client.

    + +
    • +
  • + +

    #string ClientBriefing : +Text that describes the briefing of the mission when a Player logs into the Client.

    + +
    • +
+

Return value

+ +

#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.ONBOARDSIDE + +
+
+ + + +
+
+
+
+ + +CLIENT.Reset(string, self, ClientName) + +
+
+ +

Resets a CLIENT.

+ +

Parameters

+
    +
  • + +

    string : +ClientName Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    ClientName :

    + +
    • +
+
+
+
+
+ + +CLIENT:ShowCargo() + +
+
+ +

ShowCargo shows the CARGO within the CLIENT to the Player.

+ + +

The CARGO is shown throught the MESSAGE system of DCS World.

+ +
+
+
+
+ + +CLIENT.SwitchMessages(PrmTable) + +
+
+ +

SwitchMessages is a local function called by the DCS World Menu system to switch off messages.

+ +

Parameter

+
    +
  • + +

    PrmTable :

    + +
    • +
+
+
+
+
+ + +CLIENT:Transport() + +
+
+ +

Transport defines that the Client is a Transport.

+ +

Return value

+ + +

CLIENT

+ +
+
+
+
+ + +CLIENT:_AliveCheckCallBack() + +
+
+ + + +
+
+
+
+ + + +CLIENT._Menus + +
+
+ + + +
+
+
+
+ + + +CLIENT._Tasks + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/docs/DEPLOYTASK.html b/docs/DEPLOYTASK.html new file mode 100644 index 000000000..28c31d551 --- /dev/null +++ b/docs/DEPLOYTASK.html @@ -0,0 +1,368 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DEPLOYTASK

+ +

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

+ +

Global(s)

+ + + + + +
DEPLOYTASK + +
+

Type DEPLOYTASK

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DEPLOYTASK:AddCargoMenus(Client, Cargos, TransportRadius) + +
DEPLOYTASK.ClassName + +
DEPLOYTASK.GoalVerb + +
DEPLOYTASK:InitCargo(InitCargos) + +
DEPLOYTASK:LoadCargo(LoadCargos) + +
DEPLOYTASK.New(CargoType) +

Creates a new DEPLOYTASK object, which models the sequence of STAGEs to unload a cargo.

+
DEPLOYTASK:RemoveCargoMenus(Client) + +
DEPLOYTASK.SetCargoTargetZoneName(string, self, TargetZoneName) +

When the cargo is unloaded, it will move to the target zone name.

+
DEPLOYTASK.TEXT + +
DEPLOYTASK:ToZone(LandingZone) + +
+ +

Global(s)

+
+
+ + #DEPLOYTASK + +DEPLOYTASK + +
+
+ + + +
+
+

Type DEPLOYTASK

+ +

A DeployTask

+ +

Field(s)

+
+
+ + +DEPLOYTASK:AddCargoMenus(Client, Cargos, TransportRadius) + +
+
+ + + +

Parameters

+
    +
  • + +

    Client :

    + +
    • +
  • + +

    Cargos :

    + +
    • +
  • + +

    TransportRadius :

    + +
    • +
+
+
+
+
+ + #string + +DEPLOYTASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +DEPLOYTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DEPLOYTASK:InitCargo(InitCargos) + +
+
+ + + +

Parameter

+
    +
  • + +

    InitCargos :

    + +
    • +
+
+
+
+
+ + +DEPLOYTASK:LoadCargo(LoadCargos) + +
+
+ + + +

Parameter

+
    +
  • + +

    LoadCargos :

    + +
    • +
+
+
+
+
+ + +DEPLOYTASK.New(CargoType) + +
+
+ +

Creates a new DEPLOYTASK object, which models the sequence of STAGEs to unload a cargo.

+ +

Parameter

+
    +
  • + +

    #string CargoType : +Type of the Cargo.

    + +
    • +
+

Return value

+ +

#DEPLOYTASK: +The created DeployTask

+ +
+
+
+
+ + +DEPLOYTASK:RemoveCargoMenus(Client) + +
+
+ + + +

Parameter

+
    +
  • + +

    Client :

    + +
    • +
+
+
+
+
+ + +DEPLOYTASK.SetCargoTargetZoneName(string, self, TargetZoneName) + +
+
+ +

When the cargo is unloaded, it will move to the target zone name.

+ +

Parameters

+
    +
  • + +

    string : +TargetZoneName Name of the Zone to where the Cargo should move after unloading.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    TargetZoneName :

    + +
    • +
+
+
+
+
+ + + +DEPLOYTASK.TEXT + +
+
+ + + +
+
+
+
+ + +DEPLOYTASK:ToZone(LandingZone) + +
+
+ + + +

Parameter

+
    +
  • + +

    LandingZone :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/docs/DESTROYBASETASK.html b/docs/DESTROYBASETASK.html new file mode 100644 index 000000000..7fcd12e4b --- /dev/null +++ b/docs/DESTROYBASETASK.html @@ -0,0 +1,326 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DESTROYBASETASK

+ +

A DESTROYBASETASK will monitor the destruction of Groups and Units.

+ + +

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

+ +

Global(s)

+ + + + + +
DESTROYBASETASK + +
+

Type DESTROYBASETASK

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DESTROYBASETASK.ClassName + +
DESTROYBASETASK.DestroyPercentage + +
DESTROYBASETASK.Destroyed + +
DESTROYBASETASK.EventDead(event, self) +

Handle the SEVENTDEAD events to validate the destruction of units for the task monitoring.

+
DESTROYBASETASK.GoalVerb + +
DESTROYBASETASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupPrefixes, DestroyPercentage) +

Creates a new DESTROYBASETASK.

+
DESTROYBASETASK.ReportGoalProgress(DestroyGroup, DestroyUnit, self) +

Validate task completeness of DESTROYBASETASK.

+
+ +

Global(s)

+
+
+ + #DESTROYBASETASK + +DESTROYBASETASK + +
+
+ + + +
+
+

Type DESTROYBASETASK

+ +

The DESTROYBASETASK class

+ +

Field(s)

+
+
+ + #string + +DESTROYBASETASK.ClassName + +
+
+ + + +
+
+
+
+ + #number + +DESTROYBASETASK.DestroyPercentage + +
+
+ + + +
+
+
+
+ + #number + +DESTROYBASETASK.Destroyed + +
+
+ + + +
+
+
+
+ + +DESTROYBASETASK.EventDead(event, self) + +
+
+ +

Handle the SEVENTDEAD events to validate the destruction of units for the task monitoring.

+ +

Parameters

+
    +
  • + +

    event :

    +
        Event structure of DCS world.
+
    + +
    • +
  • + +

    self :

    + +
    • +
+
+
+
+
+ + #string + +DESTROYBASETASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DESTROYBASETASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupPrefixes, DestroyPercentage) + +
+
+ +

Creates a new DESTROYBASETASK.

+ +

Parameters

+
    +
  • + +

    string : +DestroyGroupType Text describing the group to be destroyed. f.e. "Radar Installations", "Ships", "Vehicles", "Command Centers".

    + +
    • +
  • + +

    string : +DestroyUnitType Text describing the unit types to be destroyed. f.e. "SA-6", "Row Boats", "Tanks", "Tents".

    + +
    • +
  • + +

    table : +string,...} DestroyGroupPrefixes Table of Prefixes of the Groups to be destroyed before task is completed.

    + +
    • +
  • + +

    ? : +umber DestroyPercentage 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.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroupType :

    + +
    • +
  • + +

    DestroyUnitType :

    + +
    • +
  • + +

    DestroyGroupPrefixes :

    + +
    • +
  • + +

    DestroyPercentage :

    + +
    • +
+

Return value

+ + +

DESTROYBASETASK

+ +
+
+
+
+ + +DESTROYBASETASK.ReportGoalProgress(DestroyGroup, DestroyUnit, self) + +
+
+ +

Validate task completeness of DESTROYBASETASK.

+ +

Parameters

+
    +
  • + +

    DestroyGroup :

    +
        Group structure describing the group to be evaluated.
+
    + +
    • +
  • + +

    DestroyUnit :

    +
        Unit structure describing the Unit to be evaluated.
+
    + +
    • +
  • + +

    self :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/docs/DESTROYGROUPSTASK.html b/docs/DESTROYGROUPSTASK.html new file mode 100644 index 000000000..97df250ed --- /dev/null +++ b/docs/DESTROYGROUPSTASK.html @@ -0,0 +1,250 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DESTROYGROUPSTASK

+ +

DESTROYGROUPSTASK

+ +

Global(s)

+ + + + + +
DESTROYGROUPSTASK + +
+

Type DESTROYGROUPSTASK

+ + + + + + + + + + + + + + + + + +
DESTROYGROUPSTASK.ClassName + +
DESTROYGROUPSTASK.GoalVerb + +
DESTROYGROUPSTASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyPercentage) +

Creates a new DESTROYGROUPSTASK.

+
DESTROYGROUPSTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) +

Report Goal Progress.

+
+ +

Global(s)

+
+
+ + #DESTROYGROUPSTASK + +DESTROYGROUPSTASK + +
+
+ + + +
+
+

Type DESTROYGROUPSTASK

+

Field(s)

+
+
+ + #string + +DESTROYGROUPSTASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +DESTROYGROUPSTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DESTROYGROUPSTASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyPercentage) + +
+
+ +

Creates a new DESTROYGROUPSTASK.

+ +

Parameters

+
    +
  • + +

    string : +DestroyGroupType String describing the group to be destroyed.

    + +
    • +
  • + +

    string : +DestroyUnitType String describing the unit to be destroyed.

    + +
    • +
  • + +

    table : +string,...} DestroyGroupNames Table of string containing the name of the groups to be destroyed before task is completed.

    + +
    • +
  • + +

    ? : +umber DestroyPercentage 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. +-@return DESTROYGROUPSTASK

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroupType :

    + +
    • +
  • + +

    DestroyUnitType :

    + +
    • +
  • + +

    DestroyGroupNames :

    + +
    • +
  • + +

    DestroyPercentage :

    + +
    • +
+
+
+
+
+ + +DESTROYGROUPSTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) + +
+
+ +

Report Goal Progress.

+ +

Parameters

+
    +
  • + +

    Group : +DestroyGroup Group structure describing the group to be evaluated.

    + +
    • +
  • + +

    Unit : +DestroyUnit Unit structure describing the Unit to be evaluated.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroup :

    + +
    • +
  • + +

    DestroyUnit :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/docs/DESTROYRADARSTASK.html b/docs/DESTROYRADARSTASK.html new file mode 100644 index 000000000..6fc05bc3d --- /dev/null +++ b/docs/DESTROYRADARSTASK.html @@ -0,0 +1,221 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DESTROYRADARSTASK

+ +

Task class to destroy radar installations.

+ +

Global(s)

+ + + + + +
DESTROYRADARSTASK + +
+

Type DESTROYRADARSTASK

+ + + + + + + + + + + + + + + + + +
DESTROYRADARSTASK.ClassName + +
DESTROYRADARSTASK.GoalVerb + +
DESTROYRADARSTASK.New(table, self, DestroyGroupNames) +

Creates a new DESTROYRADARSTASK.

+
DESTROYRADARSTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) +

Report Goal Progress.

+
+ +

Global(s)

+
+
+ + #DESTROYRADARSTASK + +DESTROYRADARSTASK + +
+
+ + + +
+
+

Type DESTROYRADARSTASK

+

Field(s)

+
+
+ + #string + +DESTROYRADARSTASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +DESTROYRADARSTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DESTROYRADARSTASK.New(table, self, DestroyGroupNames) + +
+
+ +

Creates a new DESTROYRADARSTASK.

+ +

Parameters

+
    +
  • + +

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

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroupNames :

    + +
    • +
+

Return value

+ + +

DESTROYRADARSTASK

+ +
+
+
+
+ + +DESTROYRADARSTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) + +
+
+ +

Report Goal Progress.

+ +

Parameters

+
    +
  • + +

    Group : +DestroyGroup Group structure describing the group to be evaluated.

    + +
    • +
  • + +

    Unit : +DestroyUnit Unit structure describing the Unit to be evaluated.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroup :

    + +
    • +
  • + +

    DestroyUnit :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/docs/DESTROYUNITTYPESTASK.html b/docs/DESTROYUNITTYPESTASK.html new file mode 100644 index 000000000..3a0ec5566 --- /dev/null +++ b/docs/DESTROYUNITTYPESTASK.html @@ -0,0 +1,254 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module DESTROYUNITTYPESTASK

+ +

Set TASK to destroy certain unit types.

+ +

Global(s)

+ + + + + +
DESTROYUNITTYPESTASK + +
+

Type DESTROYUNITTYPESTASK

+ + + + + + + + + + + + + + + + + +
DESTROYUNITTYPESTASK.ClassName + +
DESTROYUNITTYPESTASK.GoalVerb + +
DESTROYUNITTYPESTASK.New(string, string, table, string, self, DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyUnitTypes) +

Creates a new DESTROYUNITTYPESTASK.

+
DESTROYUNITTYPESTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) +

Report Goal Progress.

+
+ +

Global(s)

+
+
+ + #DESTROYUNITTYPESTASK + +DESTROYUNITTYPESTASK + +
+
+ + + +
+
+

Type DESTROYUNITTYPESTASK

+

Field(s)

+
+
+ + #string + +DESTROYUNITTYPESTASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +DESTROYUNITTYPESTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +DESTROYUNITTYPESTASK.New(string, string, table, string, self, DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyUnitTypes) + +
+
+ +

Creates a new DESTROYUNITTYPESTASK.

+ +

Parameters

+
    +
  • + +

    string : +DestroyGroupType String describing the group to be destroyed. f.e. "Radar Installations", "Fleet", "Batallion", "Command Centers".

    + +
    • +
  • + +

    string : +DestroyUnitType String describing the unit to be destroyed. f.e. "radars", "ships", "tanks", "centers".

    + +
    • +
  • + +

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

    + +
    • +
  • + +

    string : +DestroyUnitTypes Table of string containing the type names of the units to achieve mission success.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroupType :

    + +
    • +
  • + +

    DestroyUnitType :

    + +
    • +
  • + +

    DestroyGroupNames :

    + +
    • +
  • + +

    DestroyUnitTypes :

    + +
    • +
+

Return value

+ + +

DESTROYUNITTYPESTASK

+ +
+
+
+
+ + +DESTROYUNITTYPESTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) + +
+
+ +

Report Goal Progress.

+ +

Parameters

+
    +
  • + +

    Group : +DestroyGroup Group structure describing the group to be evaluated.

    + +
    • +
  • + +

    Unit : +DestroyUnit Unit structure describing the Unit to be evaluated.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    DestroyGroup :

    + +
    • +
  • + +

    DestroyUnit :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/docs/Database.html b/docs/Database.html new file mode 100644 index 000000000..0c549a1b1 --- /dev/null +++ b/docs/Database.html @@ -0,0 +1,996 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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).

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ClientGroup + +
DATABASE + +
DATABASECategory + +
DATABASECoalition + +
InitGroup + +
InitUnitDesc + +
LogClose() + +
TargetGroup + +
TargetUnitDesc + +
nHours + +
nMins + +
nSecs + +
+

Type DATABASE

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DATABASE.ActivePlayers + +
DATABASE.ClassName + +
DATABASE.ClientsByID + +
DATABASE.ClientsByName + +
DATABASE:GetStatusGroup(GroupName) +

Get a status to a Group within the Database, this to check crossing events for example.

+
DATABASE.Groups + +
DATABASE.NavPoints + +
DATABASE:New() +

Creates a new DATABASE Object to administer the Groups defined and alive within the DCSRTE.

+
DATABASE:OnDeadOrCrash(event) +

Track DCSRTE DEAD or CRASH events for the internal scoring.

+
DATABASE:OnHit(event) + +
DATABASE.Players + +
DATABASE:ReportScoreAll() + +
DATABASE:ReportScorePlayer() + +
DATABASE:ScoreAdd(PlayerName, ScoreType, ScoreTimes, ScoreAmount, PlayerUnitName, PlayerUnitCoalition, PlayerUnitCategory, PlayerUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType) + +
DATABASE:ScoreMenu() + +
DATABASE:ScoreOpen() + +
DATABASE:SecondsToClock(sSeconds) + +
DATABASE:SetStatusGroup(GroupName, Status) +

Set a status to a Group within the Database, this to check crossing events for example.

+
DATABASE:Spawn(SpawnTemplate) +

Instantiate new Groups within the DCSRTE.

+
DATABASE.Statics + +
DATABASE.Units + +
DATABASE:_AddMissionScore(MissionName, Score) +

Registers Mission Scores for possible multiple players that contributed in the Mission.

+
DATABASE:_AddMissionTaskScore(PlayerUnit, MissionName, Score) +

Registers Scores the players completing a Mission Task.

+
DATABASE:_AddPlayerFromUnit(UnitData) +

Add a new player entering a Unit.

+
DATABASE:_FollowPlayers() +

Follows new players entering Clients within the DCSRTE.

+
DATABASE:_RegisterGroup(GroupTemplate) +

Registers new Group Templates within the DATABASE Object.

+
+ +

Global(s)

+
+
+ + + +ClientGroup + +
+
+ + + +
+
+
+
+ + #DATABASE + +DATABASE + +
+
+ + + +
+
+
+
+ + + +DATABASECategory + +
+
+ + + +
+
+
+
+ + + +DATABASECoalition + +
+
+ + + +
+
+
+
+ + + +InitGroup + +
+
+ + + +
+
+
+
+ + + +InitUnitDesc + +
+
+ + + +
+
+
+
+ + +LogClose() + +
+
+ + + +
+
+
+
+ + + +TargetGroup + +
+
+ + + +
+
+
+
+ + + +TargetUnitDesc + +
+
+ + + +
+
+
+
+ + + +nHours + +
+
+ + + +
+
+
+
+ + + +nMins + +
+
+ + + +
+
+
+
+ + + +nSecs + +
+
+ + + +
+
+

Type Database

+ +

Type DATABASE

+ +

The DATABASE class

+ +

Field(s)

+
+
+ + + +DATABASE.ActivePlayers + +
+
+ + + +
+
+
+
+ + #string + +DATABASE.ClassName + +
+
+ + + +
+
+
+
+ + + +DATABASE.ClientsByID + +
+
+ + + +
+
+
+
+ + + +DATABASE.ClientsByName + +
+
+ + + +
+
+
+
+ + +DATABASE:GetStatusGroup(GroupName) + +
+
+ +

Get a status to a Group within the Database, this to check crossing events for example.

+ +

Parameter

+
    +
  • + +

    GroupName :

    + +
    • +
+
+
+
+
+ + + +DATABASE.Groups + +
+
+ + + +
+
+
+
+ + + +DATABASE.NavPoints + +
+
+ + + +
+
+
+
+ + +DATABASE:New() + +
+
+ +

Creates a new DATABASE Object to administer the Groups defined and alive within the DCSRTE.

+ +

Return value

+ + +

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:OnDeadOrCrash(event) + +
+
+ +

Track DCSRTE DEAD or CRASH events for the internal scoring.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +DATABASE:OnHit(event) + +
+
+ + + +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + + +DATABASE.Players + +
+
+ + + +
+
+
+
+ + +DATABASE:ReportScoreAll() + +
+
+ + + +
+
+
+
+ + +DATABASE:ReportScorePlayer() + +
+
+ + + +
+
+
+
+ + +DATABASE:ScoreAdd(PlayerName, ScoreType, ScoreTimes, ScoreAmount, PlayerUnitName, PlayerUnitCoalition, PlayerUnitCategory, PlayerUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType) + +
+
+ + + +

Parameters

+
    +
  • + +

    PlayerName :

    + +
    • +
  • + +

    ScoreType :

    + +
    • +
  • + +

    ScoreTimes :

    + +
    • +
  • + +

    ScoreAmount :

    + +
    • +
  • + +

    PlayerUnitName :

    + +
    • +
  • + +

    PlayerUnitCoalition :

    + +
    • +
  • + +

    PlayerUnitCategory :

    + +
    • +
  • + +

    PlayerUnitType :

    + +
    • +
  • + +

    TargetUnitName :

    + +
    • +
  • + +

    TargetUnitCoalition :

    + +
    • +
  • + +

    TargetUnitCategory :

    + +
    • +
  • + +

    TargetUnitType :

    + +
    • +
+
+
+
+
+ + +DATABASE:ScoreMenu() + +
+
+ + + +
+
+
+
+ + +DATABASE:ScoreOpen() + +
+
+ + + +
+
+
+
+ + +DATABASE:SecondsToClock(sSeconds) + +
+
+ + + +

Parameter

+
    +
  • + +

    sSeconds :

    + +
    • +
+
+
+
+
+ + +DATABASE:SetStatusGroup(GroupName, Status) + +
+
+ +

Set a status to a Group within the Database, this to check crossing events for example.

+ +

Parameters

+
    +
  • + +

    GroupName :

    + +
    • +
  • + +

    Status :

    + +
    • +
+
+
+
+
+ + +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.

+ +

Parameter

+
    +
  • + +

    SpawnTemplate :

    + +
    • +
+
+
+
+
+ + + +DATABASE.Statics + +
+
+ + + +
+
+
+
+ + + +DATABASE.Units + +
+
+ + + +
+
+
+
+ + +DATABASE:_AddMissionScore(MissionName, Score) + +
+
+ +

Registers Mission Scores for possible multiple players that contributed in the Mission.

+ +

Parameters

+
    +
  • + +

    MissionName :

    + +
    • +
  • + +

    Score :

    + +
    • +
+
+
+
+
+ + +DATABASE:_AddMissionTaskScore(PlayerUnit, MissionName, Score) + +
+
+ +

Registers Scores the players completing a Mission Task.

+ +

Parameters

+
    +
  • + +

    PlayerUnit :

    + +
    • +
  • + +

    MissionName :

    + +
    • +
  • + +

    Score :

    + +
    • +
+
+
+
+
+ + +DATABASE:_AddPlayerFromUnit(UnitData) + +
+
+ +

Add a new player entering a Unit.

+ +

Parameter

+
    +
  • + +

    UnitData :

    + +
    • +
+
+
+
+
+ + +DATABASE:_FollowPlayers() + +
+
+ +

Follows new players entering Clients within the DCSRTE.

+ +
+
+
+
+ + +DATABASE:_RegisterGroup(GroupTemplate) + +
+
+ +

Registers new Group Templates within the DATABASE Object.

+ +

Parameter

+
    +
  • + +

    GroupTemplate :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/docs/Escort.html b/docs/Escort.html new file mode 100644 index 000000000..a8729fca9 --- /dev/null +++ b/docs/Escort.html @@ -0,0 +1,871 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Escort

+ +

Taking the lead of AI escorting your flight.

+ + +

The ESCORT class allows you to interact with escoring AI on your flight and take the lead.

+ +

Global(s)

+ + + + + +
ESCORT + +
+

Type ESCORT

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ESCORT.ClassName + +
ESCORT.EscortClient + +
ESCORT.EscortGroup + +
ESCORT.EscortName + +
ESCORT.FollowScheduler +

The id of the _FollowScheduler function.

+
ESCORT:New(EscortClient, EscortGroup, EscortName) +

ESCORT class constructor for an AI group

+
ESCORT.OptionROE + +
ESCORT.OptionReactionOnThreat +

Which REACTIONONTHREAT is set to the EscortGroup.

+
ESCORT:RegisterRoute() + +
ESCORT.ReportTargets +

If true, nearby targets are reported.

+
ESCORT.Targets + +
ESCORT._AttackTarget(MenuParam) + +
ESCORT:_FollowScheduler(FollowDistance) + +
ESCORT._HoldPosition(MenuParam) + +
ESCORT._HoldPositionNearBy(MenuParam) + +
ESCORT._JoinUpAndFollow(MenuParam) + +
ESCORT._OptionROTEvadeFire(MenuParam) + +
ESCORT._OptionROTNoReaction(MenuParam) + +
ESCORT._OptionROTPassiveDefense(MenuParam) + +
ESCORT._OptionROTVertical(MenuParam) + +
ESCORT._ROEHoldFire(MenuParam) + +
ESCORT._ROEOpenFire(MenuParam) + +
ESCORT._ROEReturnFire(MenuParam) + +
ESCORT._ROEWeaponFree(MenuParam) + +
ESCORT._ReportNearbyTargets(MenuParam) + +
ESCORT:_ReportTargetsScheduler() + +
ESCORT._ResumeMission(MenuParam) + +
ESCORT._ScanTargets30Seconds(MenuParam) + +
ESCORT._ScanTargets60Seconds(MenuParam) + +
+ +

Type MENUPARAM

+ + + + + + + + + +
MENUPARAM.ParamDistance + +
MENUPARAM.ParamSelf + +
+ +

Global(s)

+
+
+ + #ESCORT + +ESCORT + +
+
+ + + +
+
+

Type Escort

+ +

Type Distance

+ +

Type ESCORT

+ +

ESCORT class

+ +

Field(s)

+
+
+ + #string + +ESCORT.ClassName + +
+
+ + + +
+
+
+
+ + Client#CLIENT + +ESCORT.EscortClient + +
+
+ + + +
+
+
+
+ + Group#GROUP + +ESCORT.EscortGroup + +
+
+ + + +
+
+
+
+ + #string + +ESCORT.EscortName + +
+
+ + + +
+
+
+
+ + #number + +ESCORT.FollowScheduler + +
+
+ +

The id of the _FollowScheduler function.

+ +
+
+
+
+ + +ESCORT:New(EscortClient, EscortGroup, EscortName) + +
+
+ +

ESCORT class constructor for an AI group

+ +

Parameters

+
    +
  • + +

    Client#CLIENT EscortClient : +The client escorted by the EscortGroup.

    + +
    • +
  • + +

    Group#GROUP EscortGroup : +The group AI escorting the EscortClient.

    + +
    • +
  • + +

    #string EscortName : +Name of the escort.

    + +
    • +
+

Return value

+ +

#ESCORT: +self

+ +
+
+
+
+ + + +ESCORT.OptionROE + +
+
+ + + +
+
+
+
+ + DCSTypes#AI.Option.Air.val.REACTION_ON_THREAT + +ESCORT.OptionReactionOnThreat + +
+
+ +

Which REACTIONONTHREAT is set to the EscortGroup.

+ +
+
+
+
+ + +ESCORT:RegisterRoute() + +
+
+ + + +
+
+
+
+ + #boolean + +ESCORT.ReportTargets + +
+
+ +

If true, nearby targets are reported.

+ +
+
+
+
+ + + +ESCORT.Targets + +
+
+ + + +
+
+
+
+ + +ESCORT._AttackTarget(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT:_FollowScheduler(FollowDistance) + +
+
+ + + +

Parameter

+
    +
  • + +

    FollowDistance :

    + +
    • +
+
+
+
+
+ + +ESCORT._HoldPosition(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._HoldPositionNearBy(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._JoinUpAndFollow(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._OptionROTEvadeFire(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._OptionROTNoReaction(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._OptionROTPassiveDefense(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._OptionROTVertical(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._ROEHoldFire(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._ROEOpenFire(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._ROEReturnFire(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._ROEWeaponFree(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._ReportNearbyTargets(MenuParam) + +
+
+ + + +

Parameter

+
    +
  • + +

    MenuParam :

    + +
    • +
+
+
+
+
+ + +ESCORT:_ReportTargetsScheduler() + +
+
+ + + +
+
+
+
+ + +ESCORT._ResumeMission(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._ScanTargets30Seconds(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ESCORT._ScanTargets60Seconds(MenuParam) + +
+
+ + + +

Parameter

+ +
+
+ +

Type MENUPARAM

+ +

MENUPARAM type

+ +

Field(s)

+
+
+ + #Distance + +MENUPARAM.ParamDistance + +
+
+ + + +
+
+
+
+ + #ESCORT + +MENUPARAM.ParamSelf + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/docs/GOHOMETASK.html b/docs/GOHOMETASK.html new file mode 100644 index 000000000..b91260543 --- /dev/null +++ b/docs/GOHOMETASK.html @@ -0,0 +1,152 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module GOHOMETASK

+ +

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

+ +

Global(s)

+ + + + + +
GOHOMETASK + +
+

Type GOHOMETASK

+ + + + + + + + + +
GOHOMETASK.ClassName + +
GOHOMETASK.New(table, self, LandingZones) +

Creates a new GOHOMETASK.

+
+ +

Global(s)

+
+
+ + #GOHOMETASK + +GOHOMETASK + +
+
+ + + +
+
+

Type GOHOMETASK

+

Field(s)

+
+
+ + #string + +GOHOMETASK.ClassName + +
+
+ + + +
+
+
+
+ + +GOHOMETASK.New(table, self, LandingZones) + +
+
+ +

Creates a new GOHOMETASK.

+ +

Parameters

+
    +
  • + +

    table : +string,...}|string LandingZones Table of Landing Zone names where Home(s) are located.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    LandingZones :

    + +
    • +
+

Return value

+ + +

GOHOMETASK

+ +
+
+ +
+ +
+ + diff --git a/docs/Group.html b/docs/Group.html new file mode 100644 index 000000000..bb62338c3 --- /dev/null +++ b/docs/Group.html @@ -0,0 +1,2152 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Group

+ +

A GROUP class abstraction of a DCSGroup class.

+ + +

The GROUP class will take an abstraction of the DCSGroup class, providing more methods that can be done with a GROUP.

+ +

Global(s)

+ + + + + +
GROUP + +
+

Type DCSGroup

+ + + + + +
DCSGroup.id_ +

The ID of the group in DCS

+
+ +

Type GROUP

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
GROUP:Activate() +

Activates a GROUP.

+
GROUP:AllOnGround() +

Returns if all units of the group are on the ground or landed.

+
GROUP.ClassName + +
GROUP.Controller +

The controller of the group.

+
GROUP:CopyRoute(Begin, End, Randomize, Radius) +

Return the route of a group by using the Database#DATABASE class.

+
GROUP.DCSGroup +

The DCS group class.

+
GROUP:Destroy() +

Destroy a GROUP +Note that this destroy method also raises a destroy event at run-time.

+
GROUP.FindGroup(Group, DCSGroup) +

Find the created GROUP using the DCSGroup ID.

+
GROUP:GetCallsign() +

Gets the callsign of the fist unit of the group.

+
GROUP:GetDCSGroup() +

Gets the DCSGroup of the GROUP.

+
GROUP:GetDCSUnit(UnitNumber) +

Gets the DCS Unit of the GROUP.

+
GROUP:GetDetectedTargets() + +
GROUP:GetID() +

Gets the ID of the GROUP.

+
GROUP:GetMaxHeight() +

Returns the current maximum height of the group.

+
GROUP:GetMaxVelocity() +

Returns the current maximum velocity of the group.

+
GROUP:GetMinHeight() +

Returns the current minimum height of the group.

+
GROUP:GetName() +

Gets the name of the GROUP.

+
GROUP:GetPointVec2() +

Gets the current Point of the GROUP in VEC3 format.

+
GROUP:GetPositionVec3() +

Gets the current Point of the GROUP in VEC3 format.

+
GROUP:GetTaskMission() +

Return the mission template of the group.

+
GROUP:GetTaskRoute() +

Return the mission route of the group.

+
GROUP:GetTypeName() +

Gets the type name of the group.

+
GROUP:GetUnit(UnitNumber) +

Gets the DCS Unit.

+
GROUP.GroupID +

the ID of the group.

+
GROUP.GroupName +

The name of the group.

+
GROUP:IsAir() +

Returns if the group is of an air category.

+
GROUP:IsAlive() +

Returns if the group is alive.

+
GROUP:IsTargetDetected(DCSObject) + +
GROUP:Message(Message, Duration) +

Returns a message for a coalition or a client.

+
GROUP:MessageToAll(Message, Duration) +

Send a message to all coalitions.

+
GROUP:MessageToBlue(Message, Duration) +

Send a message to the blue coalition.

+
GROUP:MessageToClient(Message, Duration, Client) +

Send a message to a client.

+
GROUP:MessageToRed(Message, Duration) +

Send a message to the red coalition.

+
GROUP:New(DCSGroup) +

Create a new GROUP from a DCSGroup

+
GROUP:NewFromDCSUnit(DCSUnit) +

Create a new GROUP from an existing DCSUnit in the mission.

+
GROUP:NewFromName(GroupName) +

Create a new GROUP from an existing group name.

+
GROUP:OptionROEHoldFire() +

Holding weapons.

+
GROUP:OptionROEOpenFire() +

Openfire.

+
GROUP:OptionROEReturnFire() +

Return fire.

+
GROUP:OptionROEWeaponFree() +

Weapon free.

+
GROUP:OptionROTEvadeFire() +

Evade fire.

+
GROUP:OptionROTNoReaction() +

No evasion on enemy threats.

+
GROUP:OptionROTPassiveDefense() +

Evasion passive defense.

+
GROUP:OptionROTVertical() +

Vertical manoeuvres.

+
GROUP:PopCurrentTask() +

Popping current Task from the group.

+
GROUP:PushTask(DCSTask) +

Pushing Task on the queue from the group.

+
GROUP:RegisterWayPoint(WayPoint) + +
GROUP:Route(GoPoints) +

Make the group to follow a given route.

+
GROUP:SetTask(DCSTask) +

Clearing the Task Queue and Setting the Task on the queue from the group.

+
GROUP:TaskAttackUnit(The, AttackUnit) +

Attack the Unit.

+
GROUP:TaskCondition(time, userFlag, userFlagValue, condition, duration, lastWayPoint) +

Return a condition section for a controlled task

+
GROUP:TaskControlled(DCSTask, DCSStopCondition) +

Return a Controlled Task taking a Task and a TaskCondition

+
GROUP:TaskEmbarkToTransportAtVec2(Point, Radius) +

Move to a defined Vec2 Point, and embark to a group when arrived within a defined Radius.

+
GROUP:TaskEmbarkingAtVec2(Point, Duration, EmbarkingGroup) +

Move the group to a Vec2 Point, wait for a defined duration and embark a group.

+
GROUP:TaskHoldPosition(Duration) +

Hold position at the current position of the first unit of the group.

+
GROUP:TaskLandAtVec2(Point, Duration) +

Land the group at a Vec2Point.

+
GROUP:TaskLandAtZone(Zone, Duration) +

Land the group at a @{Zone#ZONE).

+
GROUP:TaskMission(TaskMission) +

Return a Misson task from a mission template.

+
GROUP:TaskOrbitCircle(Altitude, Speed) +

Orbit at the current position of the first unit of the group at a specified alititude

+
GROUP:TaskOrbitCircleAtVec2(Point, Altitude, Speed) +

Orbit at a specified position at a specified alititude during a specified duration with a specified speed.

+
GROUP:TaskRegisterWayPoint(WayPoint) + +
GROUP:TaskRoute(Points) +

Return a Misson task to follow a given route defined by Points.

+
GROUP:TaskRouteToVec3(Point, Speed) +

Make the group to fly to a given point and hover.

+
GROUP:TaskRouteToZone(Zone, Randomize, Speed, Formation) +

Route the group to a given zone.

+
GROUP:_GetController() +

Get the controller for the GROUP.

+
+ +

Type Vec3

+ + + + + + + + + +
Vec3.x + +
Vec3.y + +
+ +

Global(s)

+
+
+ + #GROUP + +GROUP + +
+
+ + + +
+
+

Type Group

+ +

Type DCSGroup

+ +

A DCSGroup

+ +

Field(s)

+
+
+ + +DCSGroup.id_ + +
+
+ +

The ID of the group in DCS

+ +
+
+ +

Type DCSStopCondition

+ +

Type DCSTask

+ +

Type Duration

+ +

Type GROUP

+ +

The GROUP class

+ +

Field(s)

+
+
+ + +GROUP:Activate() + +
+
+ +

Activates a GROUP.

+ +
+
+
+
+ + +GROUP:AllOnGround() + +
+
+ +

Returns if all units of the group are on the ground or landed.

+ + +

If all units of this group are on the ground, this function will return true, otherwise false.

+ +

Return value

+ +

#boolean: +All units on the ground result.

+ +
+
+
+
+ + #string + +GROUP.ClassName + +
+
+ + + +
+
+
+
+ + #table + +GROUP.Controller + +
+
+ +

The controller of the group.

+ +
+
+
+
+ + +GROUP:CopyRoute(Begin, End, Randomize, Radius) + +
+
+ +

Return the route of a group by using the Database#DATABASE class.

+ +

Parameters

+
    +
  • + +

    #number Begin : +The route point from where the copy will start. The base route point is 0.

    + +
    • +
  • + +

    #number End : +The route point where the copy will end. The End point is the last point - the End point. The last point has base 0.

    + +
    • +
  • + +

    #boolean Randomize : +Randomization of the route, when true.

    + +
    • +
  • + +

    #number Radius : +When randomization is on, the randomization is within the radius.

    + +
    • +
+
+
+
+
+ + DCSGroup#Group + +GROUP.DCSGroup + +
+
+ +

The DCS group class.

+ +
+
+
+
+ + +GROUP:Destroy() + +
+
+ +

Destroy a GROUP +Note that this destroy method also raises a destroy event at run-time.

+ + +

So all event listeners will catch the destroy event of this GROUP.

+ +
+
+
+
+ + +GROUP.FindGroup(Group, DCSGroup) + +
+
+ +

Find the created GROUP using the DCSGroup ID.

+ + +

If a GROUP was created with the DCSGroupID, the the GROUP instance will be returned. +Otherwise nil will be returned.

+ +

Parameters

+ +

Return value

+ +

#GROUP:

+ + +
+
+
+
+ + +GROUP:GetCallsign() + +
+
+ +

Gets the callsign of the fist unit of the group.

+ +

Return value

+ +

#string: +The callsign of the first unit of the group.

+ +
+
+
+
+ + +GROUP:GetDCSGroup() + +
+
+ +

Gets the DCSGroup of the GROUP.

+ +

Return value

+ +

#Group: +The DCSGroup.

+ +
+
+
+
+ + +GROUP:GetDCSUnit(UnitNumber) + +
+
+ +

Gets the DCS Unit of the GROUP.

+ +

Parameter

+
    +
  • + +

    #number UnitNumber : +The unit index to be returned from the GROUP.

    + +
    • +
+

Return value

+ +

#Unit: +The DCS Unit.

+ +
+
+
+
+ + +GROUP:GetDetectedTargets() + +
+
+ + + +
+
+
+
+ + +GROUP:GetID() + +
+
+ +

Gets the ID of the GROUP.

+ +

Return value

+ +

#number: +The ID of the GROUP.

+ +
+
+
+
+ + +GROUP:GetMaxHeight() + +
+
+ +

Returns the current maximum height of the group.

+ + +

Each unit within the group gets evaluated, and the maximum height (= the unit which is the highest elevated) is returned.

+ +

Return value

+ +

#number: +Maximum height found.

+ +
+
+
+
+ + +GROUP:GetMaxVelocity() + +
+
+ +

Returns the current maximum velocity of the group.

+ + +

Each unit within the group gets evaluated, and the maximum velocity (= the unit which is going the fastest) is returned.

+ +

Return value

+ +

#number: +Maximum velocity found.

+ +
+
+
+
+ + +GROUP:GetMinHeight() + +
+
+ +

Returns the current minimum height of the group.

+ + +

Each unit within the group gets evaluated, and the minimum height (= the unit which is the lowest elevated) is returned.

+ +

Return value

+ +

#number: +Minimum height found.

+ +
+
+
+
+ + +GROUP:GetName() + +
+
+ +

Gets the name of the GROUP.

+ +

Return value

+ +

#string: +The name of the GROUP.

+ +
+
+
+
+ + +GROUP:GetPointVec2() + +
+
+ +

Gets the current Point of the GROUP in VEC3 format.

+ +

Return value

+ +

#Vec3: +Current x,y and z position of the group.

+ +
+
+
+
+ + +GROUP:GetPositionVec3() + +
+
+ +

Gets the current Point of the GROUP in VEC3 format.

+ +

Return value

+ +

#Vec3: +Current Vec3 position of the group.

+ +
+
+
+
+ + +GROUP:GetTaskMission() + +
+
+ +

Return the mission template of the group.

+ +

Return value

+ +

#table: +The MissionTemplate

+ +
+
+
+
+ + +GROUP:GetTaskRoute() + +
+
+ +

Return the mission route of the group.

+ +

Return value

+ +

#table: +The mission route defined by points.

+ +
+
+
+
+ + +GROUP:GetTypeName() + +
+
+ +

Gets the type name of the group.

+ +

Return value

+ +

#string: +The type name of the group.

+ +
+
+
+
+ + +GROUP:GetUnit(UnitNumber) + +
+
+ +

Gets the DCS Unit.

+ +

Parameter

+
    +
  • + +

    #number UnitNumber : +The number of the Unit to be returned.

    + +
    • +
+

Return value

+ +

Unit#UNIT: +The DCS Unit.

+ +
+
+
+
+ + #number + +GROUP.GroupID + +
+
+ +

the ID of the group.

+ +
+
+
+
+ + #string + +GROUP.GroupName + +
+
+ +

The name of the group.

+ +
+
+
+
+ + +GROUP:IsAir() + +
+
+ +

Returns if the group is of an air category.

+ + +

If the group is a helicopter or a plane, then this method will return true, otherwise false.

+ +

Return value

+ +

#boolean: +Air category evaluation result.

+ +
+
+
+
+ + +GROUP:IsAlive() + +
+
+ +

Returns if the group is alive.

+ + +

When the group exists at run-time, this method will return true, otherwise false.

+ +

Return value

+ +

#boolean: +Alive result.

+ +
+
+
+
+ + +GROUP:IsTargetDetected(DCSObject) + +
+
+ + + +

Parameter

+
    +
  • + +

    DCSObject :

    + +
    • +
+
+
+
+
+ + +GROUP:Message(Message, Duration) + +
+
+ +

Returns a message for a coalition or a client.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
+

Return value

+ +

Message#MESSAGE:

+ + +
+
+
+
+ + +GROUP:MessageToAll(Message, Duration) + +
+
+ +

Send a message to all coalitions.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
+
+
+
+
+ + +GROUP:MessageToBlue(Message, Duration) + +
+
+ +

Send a message to the blue coalition.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
+
+
+
+
+ + +GROUP:MessageToClient(Message, Duration, Client) + +
+
+ +

Send a message to a client.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
  • + +

    Client#CLIENT Client : +The client object receiving the message.

    + +
    • +
+
+
+
+
+ + +GROUP:MessageToRed(Message, Duration) + +
+
+ +

Send a message to the red coalition.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +

Parameters

+
    +
  • + +

    #string Message : +The message text

    + +
    • +
  • + +

    #Duration Duration : +The duration of the message.

    + +
    • +
+
+
+
+
+ + +GROUP:New(DCSGroup) + +
+
+ +

Create a new GROUP from a DCSGroup

+ +

Parameter

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:NewFromDCSUnit(DCSUnit) + +
+
+ +

Create a new GROUP from an existing DCSUnit in the mission.

+ +

Parameter

+
    +
  • + +

    DCSUnit : +The DCSUnit.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:NewFromName(GroupName) + +
+
+ +

Create a new GROUP from an existing group name.

+ +

Parameter

+
    +
  • + +

    GroupName : +The name of the DCS Group.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROEHoldFire() + +
+
+ +

Holding weapons.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROEOpenFire() + +
+
+ +

Openfire.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROEReturnFire() + +
+
+ +

Return fire.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROEWeaponFree() + +
+
+ +

Weapon free.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROTEvadeFire() + +
+
+ +

Evade fire.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROTNoReaction() + +
+
+ +

No evasion on enemy threats.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROTPassiveDefense() + +
+
+ +

Evasion passive defense.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:OptionROTVertical() + +
+
+ +

Vertical manoeuvres.

+ +

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:PopCurrentTask() + +
+
+ +

Popping current Task from the group.

+ +

Return value

+ +

Group#GROUP: +self

+ +
+
+
+
+ + +GROUP:PushTask(DCSTask) + +
+
+ +

Pushing Task on the queue from the group.

+ +

Parameter

+
    +
  • + +

    DCSTask :

    + +
    • +
+

Return value

+ +

Group#GROUP: +self

+ +
+
+
+
+ + +GROUP:RegisterWayPoint(WayPoint) + +
+
+ + + +

Parameter

+
    +
  • + +

    WayPoint :

    + +
    • +
+
+
+
+
+ + +GROUP:Route(GoPoints) + +
+
+ +

Make the group to follow a given route.

+ +

Parameter

+
    +
  • + +

    #table GoPoints : +A table of Route Points.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:SetTask(DCSTask) + +
+
+ +

Clearing the Task Queue and Setting the Task on the queue from the group.

+ +

Parameter

+
    +
  • + +

    DCSTask :

    + +
    • +
+

Return value

+ +

Group#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskAttackUnit(The, AttackUnit) + +
+
+ +

Attack the Unit.

+ +

Parameters

+
    +
  • + +

    Unit#UNIT The : +unit.

    + +
    • +
  • + +

    AttackUnit :

    + +
    • +
+

Return value

+ +

#DCSTask: +The DCS task structure.

+ +
+
+
+
+ + +GROUP:TaskCondition(time, userFlag, userFlagValue, condition, duration, lastWayPoint) + +
+
+ +

Return a condition section for a controlled task

+ +

Parameters

+
    +
  • + +

    #Time time :

    + +
    • +
  • + +

    #string userFlag :

    + +
    • +
  • + +

    #boolean userFlagValue :

    + +
    • +
  • + +

    #string condition :

    + +
    • +
  • + +

    #Time duration :

    + +
    • +
  • + +

    #number lastWayPoint :

    + +

    return #DCSTask

    + +
    • +
+
+
+
+
+ + +GROUP:TaskControlled(DCSTask, DCSStopCondition) + +
+
+ +

Return a Controlled Task taking a Task and a TaskCondition

+ +

Parameters

+ +

Return value

+ +

#DCSTask:

+ + +
+
+
+
+ + +GROUP:TaskEmbarkToTransportAtVec2(Point, Radius) + +
+
+ +

Move to a defined Vec2 Point, and embark to a group when arrived within a defined Radius.

+ +

Parameters

+
    +
  • + +

    #Vec2 Point : +The point where to wait.

    + +
    • +
  • + +

    #number Radius : +The radius of the embarking zone around the Point.

    + +
    • +
+

Return value

+ +

#DCSTask: +The DCS task structure.

+ +
+
+
+
+ + +GROUP:TaskEmbarkingAtVec2(Point, Duration, EmbarkingGroup) + +
+
+ +

Move the group to a Vec2 Point, wait for a defined duration and embark a group.

+ +

Parameters

+
    +
  • + +

    #Vec2 Point : +The point where to wait.

    + +
    • +
  • + +

    #number Duration : +The duration in seconds to wait.

    + +
    • +
  • + +

    #GROUP EmbarkingGroup : +The group to be embarked.

    + +
    • +
+

Return value

+ +

#DCSTask: +The DCS task structure

+ +
+
+
+
+ + +GROUP:TaskHoldPosition(Duration) + +
+
+ +

Hold position at the current position of the first unit of the group.

+ +

Parameter

+
    +
  • + +

    #number Duration : +The maximum duration in seconds to hold the position.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskLandAtVec2(Point, Duration) + +
+
+ +

Land the group at a Vec2Point.

+ +

Parameters

+
    +
  • + +

    #Vec2 Point : +The point where to land.

    + +
    • +
  • + +

    #number Duration : +The duration in seconds to stay on the ground.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskLandAtZone(Zone, Duration) + +
+
+ +

Land the group at a @{Zone#ZONE).

+ +

Parameters

+
    +
  • + +

    Zone#ZONE Zone : +The zone where to land.

    + +
    • +
  • + +

    #number Duration : +The duration in seconds to stay on the ground.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskMission(TaskMission) + +
+
+ +

Return a Misson task from a mission template.

+ +

Parameter

+
    +
  • + +

    #table TaskMission : +A table containing the mission task.

    + +
    • +
+

Return value

+ +

#DCSTask:

+ + +
+
+
+
+ + +GROUP:TaskOrbitCircle(Altitude, Speed) + +
+
+ +

Orbit at the current position of the first unit of the group at a specified alititude

+ +

Parameters

+
    +
  • + +

    #number Altitude : +The altitude to hold the position.

    + +
    • +
  • + +

    #number Speed : +The speed flying when holding the position.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskOrbitCircleAtVec2(Point, Altitude, Speed) + +
+
+ +

Orbit at a specified position at a specified alititude during a specified duration with a specified speed.

+ +

Parameters

+
    +
  • + +

    #Vec2 Point : +The point to hold the position.

    + +
    • +
  • + +

    #number Altitude : +The altitude to hold the position.

    + +
    • +
  • + +

    #number Speed : +The speed flying when holding the position.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskRegisterWayPoint(WayPoint) + +
+
+ + + +

Parameter

+
    +
  • + +

    WayPoint :

    + +
    • +
+
+
+
+
+ + +GROUP:TaskRoute(Points) + +
+
+ +

Return a Misson task to follow a given route defined by Points.

+ +

Parameter

+
    +
  • + +

    #table Points : +A table of route points.

    + +
    • +
+

Return value

+ +

#DCSTask:

+ + +
+
+
+
+ + +GROUP:TaskRouteToVec3(Point, Speed) + +
+
+ +

Make the group to fly to a given point and hover.

+ +

Parameters

+
    +
  • + +

    #Vec3 Point : +The destination point.

    + +
    • +
  • + +

    #number Speed : +The speed to travel.

    + +
    • +
+

Return value

+ +

#GROUP: +self

+ +
+
+
+
+ + +GROUP:TaskRouteToZone(Zone, Randomize, Speed, Formation) + +
+
+ +

Route the group to a given zone.

+ + +

The group final destination point can be randomized. +A speed can be given in km/h. +A given formation can be given.

+ +

Parameters

+
    +
  • + +

    Zone#ZONE Zone : +The zone where to route to.

    + +
    • +
  • + +

    #boolean Randomize : +Defines whether to target point gets randomized within the Zone.

    + +
    • +
  • + +

    #number Speed : +The speed.

    + +
    • +
  • + +

    Base#FORMATION Formation : +The formation string.

    + +
    • +
+
+
+
+
+ + +GROUP:_GetController() + +
+
+ +

Get the controller for the GROUP.

+ +

Return value

+ +

Controller#Controller:

+ + +
+
+ +

Type Time

+ +

Type Unit

+ +

Type Vec2

+ +

Type Vec3

+

Field(s)

+
+
+ + + +Vec3.x + +
+
+ + + +
+
+
+
+ + + +Vec3.y + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/docs/MISSION.html b/docs/MISSION.html new file mode 100644 index 000000000..f925fbe5c --- /dev/null +++ b/docs/MISSION.html @@ -0,0 +1,1632 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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.

+ +

Global(s)

+ + + + + + + + + + + + + + + + + +
MISSION + +
MISSIONSCHEDULER + +
TaskComplete + +
_TransportExecuteStage + +
+

Type MISSION

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MISSION.AddClient(CLIENT, self, Client) +

Register a new CLIENT to participate within the mission.

+
MISSION.AddGoalFunction(function, self, GoalFunction) +

Add a goal function to a MISSION.

+
MISSION:AddTask(Task, TaskNumber) + +
MISSION.ClassName + +
MISSION:Completed() +

Set a Mission to completed.

+
MISSION.FAILED + +
MISSION:Failed() +

Set a Mission to failed.

+
MISSION.FindClient(CLIENT, self, ClientName) +

Find a CLIENT object within the MISSION by its ClientName.

+
MISSION:GetTask(TaskNumber) + +
MISSION:GetTasks() +

Get all the TASKs from the Mission.

+
MISSION.GoalFunction + +
MISSION:IsCompleted() +

Returns if a Mission has completed.

+
MISSION:IsFailed() +

Returns if a Mission has failed.

+
MISSION:IsOngoing() +

Returns if a Mission is ongoing.

+
MISSION:IsPending() +

Returns if a Mission is pending.

+
MISSION:Meta() + +
MISSION.MissionCoalition + +
MISSION.MissionProgressTrigger + +
MISSION.MissionReportFlash + +
MISSION.MissionReportShow + +
MISSION.MissionReportTrigger + +
MISSION.MissionStatus + +
MISSION.MissionTimeInterval + +
MISSION.Name + +
MISSION.New(string, string, string, string, self, MissionName, MissionPriority, MissionBriefing, MissionCoalition) +

This is the main MISSION declaration method.

+
MISSION:Ongoing() +

Set a Mission to ongoing.

+
MISSION:Pending() +

Set a Mission to pending.

+
MISSION.REPEAT + +
MISSION:ReportToAll() +

Report the status of all MISSIONs to all active Clients.

+
MISSION:ReportTrigger() +

Handles the reporting.

+
MISSION.SUCCESS + +
MISSION.ShowBriefing(CLIENT, self, Client) +

Show the briefing of the MISSION to the CLIENT.

+
MISSION:StatusToClients() +

Send the status of the MISSION to all Clients.

+
MISSION._ActiveTasks + +
MISSION._Clients + +
MISSION._GoalTasks + +
MISSION._Tasks + +
+ +

Type MISSIONSCHEDULER

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MISSIONSCHEDULER.AddMission(Mission) +

This is the main MISSION declaration method.

+
MISSIONSCHEDULER.FindMission(MissionName) +

Find a MISSION within the MISSIONSCHEDULER.

+
MISSIONSCHEDULER.MissionCount + +
MISSIONSCHEDULER.Missions + +
MISSIONSCHEDULER.RemoveMission(MissionName) +

Remove a MISSION from the MISSIONSCHEDULER.

+
MISSIONSCHEDULER.ReportMenu() +

Enables a MENU option in the communications menu under F10 to control the status of the active missions.

+
MISSIONSCHEDULER.ReportMissionsFlash(TimeInterval) + +
MISSIONSCHEDULER.ReportMissionsHide(Prm) + +
MISSIONSCHEDULER.ReportMissionsShow() + +
MISSIONSCHEDULER.Scheduler() +

This is the main MISSIONSCHEDULER Scheduler function.

+
MISSIONSCHEDULER.SchedulerId + +
MISSIONSCHEDULER.Start() +

Start the MISSIONSCHEDULER.

+
MISSIONSCHEDULER.Stop() +

Stop the MISSIONSCHEDULER.

+
MISSIONSCHEDULER:Time(TimeSeconds, TimeIntervalShow, TimeShow) + +
MISSIONSCHEDULER.TimeIntervalCount + +
MISSIONSCHEDULER.TimeIntervalShow + +
MISSIONSCHEDULER.TimeSeconds + +
MISSIONSCHEDULER.TimeShow + +
+ +

Global(s)

+
+
+ + #MISSION + +MISSION + +
+
+ + + +
+
+
+
+ + #MISSIONSCHEDULER + +MISSIONSCHEDULER + +
+
+ + + +
+
+
+
+ + #boolean + +TaskComplete + +
+
+ + + + +

For each Client, check for each Task the state and evolve the mission. + This flag will indicate if the Task of the Client is Complete.

+ +
+
+
+
+ + + +_TransportExecuteStage + +
+
+ + + + +

_TransportExecuteStage: Defines the different stages of Transport unload/load execution. This table is internal and is used to control the validity of Transport load/unload timing.

+ +
    +
  • _TransportExecuteStage.EXECUTING
    • +
  • _TransportExecuteStage.SUCCESS
    • +
  • _TransportExecuteStage.FAILED
    • +
+ +

--

+ +
+
+

Type MISSION

+

Field(s)

+
+
+ + +MISSION.AddClient(CLIENT, self, Client) + +
+
+ +

Register a new CLIENT to participate within the mission.

+ +

Parameters

+
    +
  • + +

    CLIENT : +Client is the CLIENT object. The object must have been instantiated with CLIENT.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    Client :

    + +
    • +
+

Return value

+ + +

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.AddGoalFunction(function, self, GoalFunction) + +
+
+ +

Add a goal function to a MISSION.

+ + +

Goal functions are called when a TASK within a mission has been completed.

+ +

Parameters

+
    +
  • + +

    function : +GoalFunction 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.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalFunction :

    + +
    • +
+

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:AddTask(Task, TaskNumber) + +
+
+ + + +

Parameters

+
    +
  • + +

    Task :

    + +
    • +
  • + +

    TaskNumber :

    + +
    • +
+
+
+
+
+ + #string + +MISSION.ClassName + +
+
+ + + +
+
+
+
+ + +MISSION:Completed() + +
+
+ +

Set a Mission to completed.

+ +
+
+
+
+ + #number + +MISSION.FAILED + +
+
+ + + +
+
+
+
+ + +MISSION:Failed() + +
+
+ +

Set a Mission to failed.

+ +
+
+
+
+ + +MISSION.FindClient(CLIENT, self, ClientName) + +
+
+ +

Find a CLIENT object within the MISSION by its ClientName.

+ +

Parameters

+
    +
  • + +

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

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    ClientName :

    + +
    • +
+

Return value

+ + +

CLIENT

+ +

Usage:

+ 
-- Seach for Client "Bomber" within the Mission.
+local BomberClient = Mission:FindClient( "Bomber" )
+ +
+
+
+
+ + +MISSION:GetTask(TaskNumber) + +
+
+ + + +

Parameter

+
    +
  • + +

    TaskNumber :

    + +
    • +
+
+
+
+
+ + +MISSION:GetTasks() + +
+
+ +

Get all the TASKs from the Mission.

+ + +

This function is useful in GoalFunctions.

+ +

Return value

+ + +

{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() .. "%" )
+ +
+
+
+
+ + +MISSION.GoalFunction + +
+
+ + + +
+
+
+
+ + +MISSION:IsCompleted() + +
+
+ +

Returns if a Mission has completed.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + +MISSION:IsFailed() + +
+
+ +

Returns if a Mission has failed.

+ + +

treturn bool

+ +
+
+
+
+ + +MISSION:IsOngoing() + +
+
+ +

Returns if a Mission is ongoing.

+ + +

treturn bool

+ +
+
+
+
+ + +MISSION:IsPending() + +
+
+ +

Returns if a Mission is pending.

+ + +

treturn bool

+ +
+
+
+
+ + +MISSION:Meta() + +
+
+ + + +
+
+
+
+ + #string + +MISSION.MissionCoalition + +
+
+ + + +
+
+
+
+ + #number + +MISSION.MissionProgressTrigger + +
+
+ + + +
+
+
+
+ + #boolean + +MISSION.MissionReportFlash + +
+
+ + + +
+
+
+
+ + #boolean + +MISSION.MissionReportShow + +
+
+ + + +
+
+
+
+ + #number + +MISSION.MissionReportTrigger + +
+
+ + + +
+
+
+
+ + #string + +MISSION.MissionStatus + +
+
+ + + +
+
+
+
+ + #number + +MISSION.MissionTimeInterval + +
+
+ + + +
+
+
+
+ + #string + +MISSION.Name + +
+
+ + + +
+
+
+
+ + +MISSION.New(string, string, string, string, self, 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

+
    +
  • + +

    string : +MissionName is the name of the mission. This name will be used to reference the status of each mission by the players.

    + +
    • +
  • + +

    string : +MissionPriority 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.

    + +
    • +
  • + +

    string : +MissionBriefing is a string indicating the mission briefing to be shown when a player joins a CLIENT.

    + +
    • +
  • + +

    string : +MissionCoalition 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"...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    MissionName :

    + +
    • +
  • + +

    MissionPriority :

    + +
    • +
  • + +

    MissionBriefing :

    + +
    • +
  • + +

    MissionCoalition :

    + +
    • +
+

Return value

+ + +

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:Ongoing() + +
+
+ +

Set a Mission to ongoing.

+ +
+
+
+
+ + +MISSION:Pending() + +
+
+ +

Set a Mission to pending.

+ +
+
+
+
+ + #number + +MISSION.REPEAT + +
+
+ + + +
+
+
+
+ + +MISSION:ReportToAll() + +
+
+ +

Report the status of all MISSIONs to all active Clients.

+ +
+
+
+
+ + +MISSION:ReportTrigger() + +
+
+ +

Handles the reporting.

+ + +

After certain time intervals, a MISSION report MESSAGE will be shown to All Players.

+ +
+
+
+
+ + #number + +MISSION.SUCCESS + +
+
+ + + +
+
+
+
+ + +MISSION.ShowBriefing(CLIENT, self, Client) + +
+
+ +

Show the briefing of the MISSION to the CLIENT.

+ +

Parameters

+
    +
  • + +

    CLIENT : +Client to show briefing to.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    Client :

    + +
    • +
+

Return value

+ + +

CLIENT

+ +
+
+
+
+ + +MISSION:StatusToClients() + +
+
+ +

Send the status of the MISSION to all Clients.

+ +
+
+
+
+ + + +MISSION._ActiveTasks + +
+
+ + + +
+
+
+
+ + + +MISSION._Clients + +
+
+ + + +
+
+
+
+ + + +MISSION._GoalTasks + +
+
+ + + +
+
+
+
+ + + +MISSION._Tasks + +
+
+ + + +
+
+ +

Type 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.

+ +

Field(s)

+
+
+ + +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.

+ +

Parameter

+
    +
  • + +

    Mission : +is the MISSION object instantiated by MISSION.

    + +
    • +
+

Return value

+ + +

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.FindMission(MissionName) + +
+
+ +

Find a MISSION within the MISSIONSCHEDULER.

+ +

Parameter

+
    +
  • + +

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

    + +
    • +
+

Return value

+ + +

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' )
+ +
+
+
+
+ + #number + +MISSIONSCHEDULER.MissionCount + +
+
+ + + +
+
+
+
+ + + +MISSIONSCHEDULER.Missions + +
+
+ + + +
+
+
+
+ + +MISSIONSCHEDULER.RemoveMission(MissionName) + +
+
+ +

Remove a MISSION from the MISSIONSCHEDULER.

+ +

Parameter

+
    +
  • + +

    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.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.ReportMissionsFlash(TimeInterval) + +
+
+ + + + +

Internal function used by the MISSIONSCHEDULER menu.

+ +

Parameter

+
    +
  • + +

    TimeInterval :

    + +
    • +
+
+
+
+
+ + +MISSIONSCHEDULER.ReportMissionsHide(Prm) + +
+
+ + + + +

Internal function used by the MISSIONSCHEDULER menu.

+ +

Parameter

+
    +
  • + +

    Prm :

    + +
    • +
+
+
+
+
+ + +MISSIONSCHEDULER.ReportMissionsShow() + +
+
+ + + + +

Internal function used by the MISSIONSCHEDULER menu.

+ +
+
+
+
+ + +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.SchedulerId + +
+
+ + + +
+
+
+
+ + +MISSIONSCHEDULER.Start() + +
+
+ +

Start the MISSIONSCHEDULER.

+ +
+
+
+
+ + +MISSIONSCHEDULER.Stop() + +
+
+ +

Stop the MISSIONSCHEDULER.

+ +
+
+
+
+ + +MISSIONSCHEDULER:Time(TimeSeconds, TimeIntervalShow, TimeShow) + +
+
+ + + +

Parameters

+
    +
  • + +

    TimeSeconds :

    + +
    • +
  • + +

    TimeIntervalShow :

    + +
    • +
  • + +

    TimeShow :

    + +
    • +
+
+
+
+
+ + #number + +MISSIONSCHEDULER.TimeIntervalCount + +
+
+ + + +
+
+
+
+ + #number + +MISSIONSCHEDULER.TimeIntervalShow + +
+
+ + + +
+
+
+
+ + #number + +MISSIONSCHEDULER.TimeSeconds + +
+
+ + + +
+
+
+
+ + #number + +MISSIONSCHEDULER.TimeShow + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/docs/MOVEMENT.html b/docs/MOVEMENT.html new file mode 100644 index 000000000..69e42ff2d --- /dev/null +++ b/docs/MOVEMENT.html @@ -0,0 +1,261 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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).

+ +

Global(s)

+ + + + + +
MOVEMENT + +
+

Type MOVEMENT

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MOVEMENT.ClassName + +
MOVEMENT:New(MovePrefixes, MoveMaximum) + +
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:ScheduleStart() +

Call this function to start the MOVEMENT scheduling.

+
MOVEMENT:ScheduleStop() +

Call this function to stop the MOVEMENT scheduling.

+
MOVEMENT:_Scheduler() +

This function is called automatically by the MOVEMENT scheduler.

+
+ +

Global(s)

+
+
+ + #MOVEMENT + +MOVEMENT + +
+
+ + + +
+
+

Type MOVEMENT

+

Field(s)

+
+
+ + #string + +MOVEMENT.ClassName + +
+
+ + + +
+
+
+
+ + +MOVEMENT:New(MovePrefixes, MoveMaximum) + +
+
+ + + +

Parameters

+
    +
  • + +

    MovePrefixes :

    + +
    • +
  • + +

    MoveMaximum :

    + +
    • +
+
+
+
+
+ + +MOVEMENT:OnBirth(event) + +
+
+ +

Captures the birth events when new Units were spawned.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +MOVEMENT:OnDeadOrCrash(event) + +
+
+ +

Captures the Dead or Crash events when Units crash or are destroyed.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +MOVEMENT:ScheduleStart() + +
+
+ +

Call this function to start the MOVEMENT scheduling.

+ +
+
+
+
+ + +MOVEMENT:ScheduleStop() + +
+
+ +

Call this function to stop the MOVEMENT scheduling.

+ +
+
+
+
+ + +MOVEMENT:_Scheduler() + +
+
+ +

This function is called automatically by the MOVEMENT scheduler.

+ + +

A new function is scheduled when MoveScheduled is true.

+ +
+
+ +
+ +
+ + diff --git a/docs/Menu.html b/docs/Menu.html new file mode 100644 index 000000000..4860e3ccb --- /dev/null +++ b/docs/Menu.html @@ -0,0 +1,637 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Menu

+ +

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

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + +
COMMANDMENU + +
MENU + +
MENU_CLIENT + +
MENU_CLIENT_COMMAND + +
SUBMENU + +
+

Type COMMANDMENU

+ + + + + + + + + + + + + + + + + +
COMMANDMENU.ClassName + +
COMMANDMENU.CommandMenuArgument + +
COMMANDMENU.CommandMenuFunction + +
COMMANDMENU:New(MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument) + +
+ +

Type MENU

+ + + + + + + + + + + + + + + + + + + + + +
MENU.ClassName + +
MENU.MenuParentPath + +
MENU.MenuPath + +
MENU.MenuText + +
MENU:New(MenuText, MenuParentPath) + +
+ +

Type MENU_CLIENT

+ + + + + + + + + +
MENU_CLIENT.ClassName + +
MENU_CLIENT:New(MenuClient, MenuText, ParentMenu) +

Creates a new menu item for a group

+
+ +

Type MENU_CLIENT_COMMAND

+ + + + + + + + + + + + + +
MENU_CLIENT_COMMAND.ClassName + +
MENU_CLIENT_COMMAND:New(MenuClient, MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument) +

Creates a new radio command item for a group

+
MENU_CLIENT_COMMAND:Remove() + +
+ +

Type SUBMENU

+ + + + + + + + + +
SUBMENU.ClassName + +
SUBMENU:New(MenuText, ParentMenu) + +
+ +

Global(s)

+
+
+ + #COMMANDMENU + +COMMANDMENU + +
+
+ + + +
+
+
+
+ + #MENU + +MENU + +
+
+ + + +
+
+
+
+ + #MENU_CLIENT + +MENU_CLIENT + +
+
+ + + +
+
+
+
+ + #MENU_CLIENT_COMMAND + +MENU_CLIENT_COMMAND + +
+
+ + + +
+
+
+
+ + #SUBMENU + +SUBMENU + +
+
+ + + +
+
+

Type Menu

+ +

Type COMMANDMENU

+ +

The COMMANDMENU class

+ +

Field(s)

+
+
+ + #string + +COMMANDMENU.ClassName + +
+
+ + + +
+
+
+
+ + +COMMANDMENU.CommandMenuArgument + +
+
+ + + +
+
+
+
+ + +COMMANDMENU.CommandMenuFunction + +
+
+ + + +
+
+
+
+ + +COMMANDMENU:New(MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument) + +
+
+ + + +

Parameters

+
    +
  • + +

    MenuText :

    + +
    • +
  • + +

    ParentMenu :

    + +
    • +
  • + +

    CommandMenuFunction :

    + +
    • +
  • + +

    CommandMenuArgument :

    + +
    • +
+
+
+ +

Type MENU

+ +

The MENU class

+ +

Field(s)

+
+
+ + #string + +MENU.ClassName + +
+
+ + + +
+
+
+
+ + +MENU.MenuParentPath + +
+
+ + + +
+
+
+
+ + +MENU.MenuPath + +
+
+ + + +
+
+
+
+ + #string + +MENU.MenuText + +
+
+ + + +
+
+
+
+ + +MENU:New(MenuText, MenuParentPath) + +
+
+ + + +

Parameters

+
    +
  • + +

    MenuText :

    + +
    • +
  • + +

    MenuParentPath :

    + +
    • +
+
+
+ +

Type MENU_CLIENT

+ +

The MENU_CLIENT class

+ +

Field(s)

+
+
+ + #string + +MENU_CLIENT.ClassName + +
+
+ + + +
+
+
+
+ + +MENU_CLIENT:New(MenuClient, MenuText, ParentMenu) + +
+
+ +

Creates a new menu item for a group

+ +

Parameters

+
    +
  • + +

    Client#CLIENT MenuClient : +The Client owning the menu.

    + +
    • +
  • + +

    #string MenuText : +The text for the menu.

    + +
    • +
  • + +

    #table ParentMenu : +The parent menu.

    + +
    • +
+

Return value

+ +

#MENU_CLIENT: +self

+ +
+
+ +

Type MENU_CLIENT_COMMAND

+ +

The MENUCLIENTCOMMAND class

+ +

Field(s)

+
+
+ + #string + +MENU_CLIENT_COMMAND.ClassName + +
+
+ + + +
+
+
+
+ + +MENU_CLIENT_COMMAND:New(MenuClient, MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument) + +
+
+ +

Creates a new radio command item for a group

+ +

Parameters

+
    +
  • + +

    Client#CLIENT MenuClient : +The Client owning the menu.

    + +
    • +
  • + +

    MenuText : +The text for the menu.

    + +
    • +
  • + +

    ParentMenu : +The parent menu.

    + +
    • +
  • + +

    CommandMenuFunction : +A function that is called when the menu key is pressed.

    + +
    • +
  • + +

    CommandMenuArgument : +An argument for the function.

    + +
    • +
+

Return value

+ +

Menu#MENUCLIENTCOMMAND: +self

+ +
+
+
+
+ + +MENU_CLIENT_COMMAND:Remove() + +
+
+ + + +
+
+ +

Type SUBMENU

+ +

The SUBMENU class

+ +

Field(s)

+
+
+ + #string + +SUBMENU.ClassName + +
+
+ + + +
+
+
+
+ + +SUBMENU:New(MenuText, ParentMenu) + +
+
+ + + +

Parameters

+
    +
  • + +

    MenuText :

    + +
    • +
  • + +

    ParentMenu :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/docs/Message.html b/docs/Message.html new file mode 100644 index 000000000..208d82d40 --- /dev/null +++ b/docs/Message.html @@ -0,0 +1,537 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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().

+ +

Global(s)

+ + + + + + + + + +
MESSAGE + +
MESSAGEQUEUE + +
+

Type MESSAGE

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MESSAGE.ClassName + +
MESSAGE.MessageCategory + +
MESSAGE.MessageID + +
MESSAGE:New(MessageText, MessageCategory, MessageDuration, MessageID) +

Creates a new MESSAGE object.

+
MESSAGE:ToAll() +

Sends a MESSAGE to all players.

+
MESSAGE:ToBlue() +

Sends a MESSAGE to the Blue coalition.

+
MESSAGE:ToClient(Client) +

Sends a MESSAGE to a Client Group.

+
MESSAGE:ToCoalition(CoalitionSide) +

Sends a MESSAGE to a Coalition.

+
MESSAGE:ToRed() +

Sends a MESSAGE to the Red Coalition.

+
+ +

Type MESSAGEQUEUE

+ + + + + + + + + + + + + + + + + +
MESSAGEQUEUE.ClientGroups + +
MESSAGEQUEUE.CoalitionSides + +
MESSAGEQUEUE:New(RefreshInterval) + +
MESSAGEQUEUE:_DisplayMessages() +

This function is called automatically by the MESSAGEQUEUE scheduler.

+
+ +

Global(s)

+
+
+ + #MESSAGE + +MESSAGE + +
+
+ + + +
+
+
+
+ + #MESSAGEQUEUE + +MESSAGEQUEUE + +
+
+ + + +
+
+

Type Message

+ +

Type MESSAGE

+ +

The MESSAGE class

+ +

Field(s)

+
+
+ + #string + +MESSAGE.ClassName + +
+
+ + + +
+
+
+
+ + #number + +MESSAGE.MessageCategory + +
+
+ + + +
+
+
+
+ + #number + +MESSAGE.MessageID + +
+
+ + + +
+
+
+
+ + +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

+
    +
  • + +

    #string MessageText : +is the text of the Message.

    + +
    • +
  • + +

    #string MessageCategory : +is a string expressing the Category of the Message. Messages are grouped on the display panel per Category to improve readability.

    + +
    • +
  • + +

    #number MessageDuration : +is a number in seconds of how long the MESSAGE should be shown on the display panel.

    + +
    • +
  • + +

    #string MessageID : +is a string expressing the ID of the Message.

    + +
    • +
+

Return value

+ +

#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:ToAll() + +
+
+ +

Sends a MESSAGE to all players.

+ +

Return value

+ +

#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()
+ +
+
+
+
+ + +MESSAGE:ToBlue() + +
+
+ +

Sends a MESSAGE to the Blue coalition.

+ +

Return value

+ +

#MESSAGE:

+ + +

Usage:

+ 
-- Send a message created with the @{New} method to the BLUE coalition.
+MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
+or
+MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
+or
+MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
+MessageBLUE:ToBlue()
+ +
+
+
+
+ + +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".

+ +

Parameter

+ +

Return value

+ +

#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.

+ +

Parameter

+
    +
  • + +

    CoalitionSide : +needs to be filled out by the defined structure of the standard scripting engine coalition.side.

    + +
    • +
+

Return value

+ +

#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:ToRed() + +
+
+ +

Sends a MESSAGE to the Red Coalition.

+ +

Return value

+ +

#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" ):ToRed()
+or
+MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
+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:ToRed()
+ +
+
+ +

Type MESSAGEQUEUE

+ +

The MESSAGEQUEUE class

+ +

Field(s)

+
+
+ + + +MESSAGEQUEUE.ClientGroups + +
+
+ + + +
+
+
+
+ + + +MESSAGEQUEUE.CoalitionSides + +
+
+ + + +
+
+
+
+ + +MESSAGEQUEUE:New(RefreshInterval) + +
+
+ + + +

Parameter

+
    +
  • + +

    RefreshInterval :

    + +
    • +
+
+
+
+
+ + +MESSAGEQUEUE:_DisplayMessages() + +
+
+ +

This function is called automatically by the MESSAGEQUEUE scheduler.

+ +
+
+ +
+ +
+ + diff --git a/docs/NOTASK.html b/docs/NOTASK.html new file mode 100644 index 000000000..77c0379f9 --- /dev/null +++ b/docs/NOTASK.html @@ -0,0 +1,131 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module NOTASK

+ +

A NOTASK is a dummy activity...

+ + +

But it will show a Mission Briefing...

+ +

Global(s)

+ + + + + +
NOTASK + +
+

Type NOTASK

+ + + + + + + + + +
NOTASK.ClassName + +
NOTASK:New() +

Creates a new NOTASK.

+
+ +

Global(s)

+
+
+ + #NOTASK + +NOTASK + +
+
+ + + +
+
+

Type NOTASK

+

Field(s)

+
+
+ + #string + +NOTASK.ClassName + +
+
+ + + +
+
+
+
+ + +NOTASK:New() + +
+
+ +

Creates a new NOTASK.

+ +
+
+ +
+ +
+ + diff --git a/docs/PICKUPTASK.html b/docs/PICKUPTASK.html new file mode 100644 index 000000000..797c399f9 --- /dev/null +++ b/docs/PICKUPTASK.html @@ -0,0 +1,376 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module PICKUPTASK

+ +

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

+ +

Global(s)

+ + + + + +
PICKUPTASK + +
+

Type PICKUPTASK

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PICKUPTASK:AddCargoMenus(Client, Cargos, TransportRadius) + +
PICKUPTASK.ClassName + +
PICKUPTASK:FromZone(LandingZone) + +
PICKUPTASK.GoalVerb + +
PICKUPTASK:HasFailed(ClientDead) + +
PICKUPTASK:InitCargo(InitCargos) + +
PICKUPTASK:LoadCargo(LoadCargos) + +
PICKUPTASK.New(table, CARGO_TYPE, number, self, CargoType, OnBoardSide) +

Creates a new PICKUPTASK.

+
PICKUPTASK:RemoveCargoMenus(Client) + +
PICKUPTASK.TEXT + +
+ +

Global(s)

+
+
+ + #PICKUPTASK + +PICKUPTASK + +
+
+ + + +
+
+

Type PICKUPTASK

+

Field(s)

+
+
+ + +PICKUPTASK:AddCargoMenus(Client, Cargos, TransportRadius) + +
+
+ + + +

Parameters

+
    +
  • + +

    Client :

    + +
    • +
  • + +

    Cargos :

    + +
    • +
  • + +

    TransportRadius :

    + +
    • +
+
+
+
+
+ + #string + +PICKUPTASK.ClassName + +
+
+ + + +
+
+
+
+ + +PICKUPTASK:FromZone(LandingZone) + +
+
+ + + +

Parameter

+
    +
  • + +

    LandingZone :

    + +
    • +
+
+
+
+
+ + #string + +PICKUPTASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +PICKUPTASK:HasFailed(ClientDead) + +
+
+ + + +

Parameter

+
    +
  • + +

    ClientDead :

    + +
    • +
+
+
+
+
+ + +PICKUPTASK:InitCargo(InitCargos) + +
+
+ + + +

Parameter

+
    +
  • + +

    InitCargos :

    + +
    • +
+
+
+
+
+ + +PICKUPTASK:LoadCargo(LoadCargos) + +
+
+ + + +

Parameter

+
    +
  • + +

    LoadCargos :

    + +
    • +
+
+
+
+
+ + +PICKUPTASK.New(table, CARGO_TYPE, number, self, CargoType, OnBoardSide) + +
+
+ +

Creates a new PICKUPTASK.

+ +

Parameters

+
    +
  • + +

    table : +string,...}|string LandingZones Table of Zone names where Cargo is to be loaded.

    + +
    • +
  • + +

    CARGO_TYPE : +CargoType Type of the Cargo. The type must be of the following Enumeration:..

    + +
    • +
  • + +

    number : +OnBoardSide Reflects from which side the cargo Group will be on-boarded on the Carrier.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    CargoType :

    + +
    • +
  • + +

    OnBoardSide :

    + +
    • +
+
+
+
+
+ + +PICKUPTASK:RemoveCargoMenus(Client) + +
+
+ + + +

Parameter

+
    +
  • + +

    Client :

    + +
    • +
+
+
+
+
+ + + +PICKUPTASK.TEXT + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/docs/ROUTETASK.html b/docs/ROUTETASK.html new file mode 100644 index 000000000..5b17f543f --- /dev/null +++ b/docs/ROUTETASK.html @@ -0,0 +1,183 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module ROUTETASK

+ +

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

+ +

Global(s)

+ + + + + +
ROUTETASK + +
+

Type ROUTETASK

+ + + + + + + + + + + + + +
ROUTETASK.ClassName + +
ROUTETASK.GoalVerb + +
ROUTETASK.New(table, string, self, LandingZones, TaskBriefing) +

Creates a new ROUTETASK.

+
+ +

Global(s)

+
+
+ + #ROUTETASK + +ROUTETASK + +
+
+ + + +
+
+

Type ROUTETASK

+

Field(s)

+
+
+ + #string + +ROUTETASK.ClassName + +
+
+ + + +
+
+
+
+ + #string + +ROUTETASK.GoalVerb + +
+
+ + + +
+
+
+
+ + +ROUTETASK.New(table, string, self, LandingZones, TaskBriefing) + +
+
+ +

Creates a new ROUTETASK.

+ +

Parameters

+
    +
  • + +

    table : +sring,...}|string LandingZones Table of Zone Names where the target is located.

    + +
    • +
  • + +

    string : +TaskBriefing (optional) Defines a text describing the briefing of the task.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    LandingZones :

    + +
    • +
  • + +

    TaskBriefing :

    + +
    • +
+

Return value

+ + +

ROUTETASK

+ +
+
+ +
+ +
+ + diff --git a/docs/STAGE.html b/docs/STAGE.html new file mode 100644 index 000000000..1e445b76e --- /dev/null +++ b/docs/STAGE.html @@ -0,0 +1,795 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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.

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CargoStatic + +
STAGE + +
STAGEARRIVE + +
STAGEBRIEF + +
STAGEDONE + +
STAGEGROUPSDESTROYED + +
STAGELANDED + +
STAGELANDING + +
STAGELOAD + +
STAGEROUTE + +
STAGESTART + +
STAGEUNLOAD + +
STAGE_CARGO_INIT + +
STAGE_CARGO_LOAD + +
_TransportStage + +
_TransportStageAction + +
_TransportStageTime + +
+

Type STAGE

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
STAGE.ClassName + +
STAGE:Execute(Mission, Client, Task) + +
STAGE:Executing(Mission, Client, Task) + +
STAGE.FREQUENCY + +
STAGE.Frequency + +
STAGE.MSG + +
STAGE.MessageCount + +
STAGE.MessageFlash + +
STAGE.MessageInterval + +
STAGE.MessageShow + +
STAGE.MessageShown + +
STAGE.Name + +
STAGE:New() + +
STAGE.StageType + +
STAGE:Validate(Mission, Client, Task) + +
STAGE.WaitTime + +
+ +

Global(s)

+
+
+ + + +CargoStatic + +
+
+ + + +
+
+
+
+ + #STAGE + +STAGE + +
+
+ + + +
+
+
+
+ + + +STAGEARRIVE + +
+
+ + + +
+
+
+
+ + + +STAGEBRIEF + +
+
+ + + +
+
+
+
+ + + +STAGEDONE + +
+
+ + + +
+
+
+
+ + + +STAGEGROUPSDESTROYED + +
+
+ + + +
+
+
+
+ + + +STAGELANDED + +
+
+ + + +
+
+
+
+ + + +STAGELANDING + +
+
+ + + +
+
+
+
+ + + +STAGELOAD + +
+
+ + + +
+
+
+
+ + + +STAGEROUTE + +
+
+ + + +
+
+
+
+ + + +STAGESTART + +
+
+ + + +
+
+
+
+ + + +STAGEUNLOAD + +
+
+ + + +
+
+
+
+ + + +STAGE_CARGO_INIT + +
+
+ + + +
+
+
+
+ + + +STAGE_CARGO_LOAD + +
+
+ + + +
+
+
+
+ + + +_TransportStage + +
+
+ + + + +

_TransportStage: Defines the different stages of which of transport missions can be in. This table is internal and is used to control the sequence of messages, actions and flow.

+ +
    +
  • _TransportStage.START
    • +
  • _TransportStage.ROUTE
    • +
  • _TransportStage.LAND
    • +
  • _TransportStage.EXECUTE
    • +
  • _TransportStage.DONE
    • +
  • _TransportStage.REMOVE + --
    • +
+ +
+
+
+
+ + + +_TransportStageAction + +
+
+ + + +
+
+
+
+ + + +_TransportStageTime + +
+
+ + + +
+
+

Type STAGE

+

Field(s)

+
+
+ + #string + +STAGE.ClassName + +
+
+ + + +
+
+
+
+ + +STAGE:Execute(Mission, Client, Task) + +
+
+ + + +

Parameters

+
    +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
  • + +

    Task :

    + +
    • +
+
+
+
+
+ + +STAGE:Executing(Mission, Client, Task) + +
+
+ + + +

Parameters

+
    +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
  • + +

    Task :

    + +
    • +
+
+
+
+
+ + + +STAGE.FREQUENCY + +
+
+ + + +
+
+
+
+ + #number + +STAGE.Frequency + +
+
+ + + +
+
+
+
+ + + +STAGE.MSG + +
+
+ + + +
+
+
+
+ + #number + +STAGE.MessageCount + +
+
+ + + +
+
+
+
+ + #boolean + +STAGE.MessageFlash + +
+
+ + + +
+
+
+
+ + #number + +STAGE.MessageInterval + +
+
+ + + +
+
+
+
+ + #boolean + +STAGE.MessageShow + +
+
+ + + +
+
+
+
+ + + +STAGE.MessageShown + +
+
+ + + +
+
+
+
+ + #string + +STAGE.Name + +
+
+ + + +
+
+
+
+ + +STAGE:New() + +
+
+ + + +
+
+
+
+ + #string + +STAGE.StageType + +
+
+ + + +
+
+
+
+ + +STAGE:Validate(Mission, Client, Task) + +
+
+ + + +

Parameters

+
    +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
  • + +

    Task :

    + +
    • +
+
+
+
+
+ + #number + +STAGE.WaitTime + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/docs/Sead.html b/docs/Sead.html new file mode 100644 index 000000000..c8ef201d1 --- /dev/null +++ b/docs/Sead.html @@ -0,0 +1,236 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Sead

+ +

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

+ +

Global(s)

+ + + + + +
SEAD + +
+

Type SEAD

+ + + + + + + + + + + + + + + + + + + + + +
SEAD.ClassName + +
SEAD:EventShot(event) +

Detects if an SA site was shot with an anti radiation missile.

+
SEAD.New(table, self, SEADGroupPrefixes) +

Creates the main object which is handling defensive actions for SA sites or moving SA vehicles.

+
SEAD.SEADGroupPrefixes + +
SEAD.TargetSkill + +
+ +

Global(s)

+
+
+ + #SEAD + +SEAD + +
+
+ + + +
+
+

Type Sead

+ +

Type SEAD

+ +

The SEAD class

+ +

Field(s)

+
+
+ + #string + +SEAD.ClassName + +
+
+ + + +
+
+
+
+ + +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.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +SEAD.New(table, self, 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

+
    +
  • + +

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

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SEADGroupPrefixes :

    + +
    • +
+

Return value

+ + +

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.SEADGroupPrefixes + +
+
+ + + +
+
+
+
+ + + +SEAD.TargetSkill + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/docs/Spawn.html b/docs/Spawn.html new file mode 100644 index 000000000..1807cbbf2 --- /dev/null +++ b/docs/Spawn.html @@ -0,0 +1,1762 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Spawn

+ +

Dynamic spawning of groups (and units).

+ + +

The SPAWN class allows to spawn dynamically new groups, based on pre-defined initialization settings, modifying the behaviour when groups are spawned. +For each group to be spawned, within the mission editor, a group has to be created with the "late activation flag" set. We call this group the "Spawn Template" of the SPAWN object. +A reference to this Spawn Template needs to be provided when constructing the SPAWN object, by indicating the name of the group within the mission editor in the constructor methods.

+ +

Within the SPAWN object, there is an internal index that keeps track of which group from the internal group list was spawned. +When new groups get spawned by using the SPAWN functions (see below), it will be validated whether the Limits (SPAWN.Limit) of the SPAWN object are not reached. +When all is valid, a new group will be created by the spawning methods, and the internal index will be increased with 1.

+ +

Regarding the name of new spawned groups, a SpawnPrefix will be assigned for each new group created. +If you want to have the Spawn Template name to be used as the SpawnPrefix name, use the SPAWN.New constructor. +However, when the SPAWN.NewWithAlias constructor was used, the Alias name will define the SpawnPrefix name. +Groups will follow the following naming structure when spawned at run-time:

+ +
    +
  1. Spawned groups will have the name SpawnPrefix#ggg, where ggg is a counter from 0 to 999.
    2. +
  2. Spawned units will have the name SpawnPrefix#ggg-uu, where uu is a counter from 0 to 99 for each new spawned unit belonging to the group.
    3. +
+ +

Some additional notes that need to be remembered:

+ +
    +

  • Templates are actually groups defined within the mission editor, with the flag "Late Activation" set. As such, these groups are never used within the mission, but are used by the #SPAWN module.

    • +

  • It is important to defined BEFORE you spawn new groups, a proper initialization of the SPAWN instance is done with the options you want to use.

    • +

  • When designing a mission, NEVER name groups using a "#" within the name of the group Spawn Template(s), or the SPAWN module logic won't work anymore.

    • +

  • SPAWN object construction methods:

    +

    Create a new SPAWN object with the SPAWN.New or the SPAWN.NewWithAlias methods:

    • +

  • SPAWN.New: Creates a new SPAWN object taking the name of the group that functions as the Template.

    • +
+ +

It is important to understand how the SPAWN class works internally. The SPAWN object created will contain internally a list of groups that will be spawned and that are already spawned. +The initialization functions will modify this list of groups so that when a group gets spawned, ALL information is already prepared when spawning. This is done for performance reasons. +So in principle, the group list will contain all parameters and configurations after initialization, and when groups get actually spawned, this spawning can be done quickly and efficient.

+ +
    +

  1. SPAWN object initialization methods:

    +

    A spawn object will behave differently based on the usage of initialization methods:

    2. +

  2. SPAWN.Limit: Limits the amount of groups that can be alive at the same time and that can be dynamically spawned.

    3. +

  3. SPAWN.RandomizeRoute: Randomize the routes of spawned groups.

    4. +

  4. SPAWN.RandomizeTemplate: Randomize the group templates so that when a new group is spawned, a random group template is selected from one of the templates defined.

    5. +

  5. SPAWN.Uncontrolled: Spawn plane groups uncontrolled.

    6. +

  6. SPAWN.Array: Make groups visible before they are actually activated, and order these groups like a batallion in an array.

    7. +

  7. SPAWN.Repeat: Re-spawn groups when they land at the home base. Similar functions are SPAWN.RepeatOnLanding and SPAWN.RepeatOnEngineShutDown.

    8. +

  8. SPAWN object spawning methods:

    +

    Groups can be spawned at different times and methods:

    9. +

  9. SPAWN.Spawn: Spawn one new group based on the last spawned index.

    10. +

  10. SPAWN.ReSpawn: Re-spawn a group based on a given index.

    11. +

  11. SPAWN.SpawnScheduled: Spawn groups at scheduled but randomized intervals. You can use SPAWN.SpawnScheduleStart and SPAWN.SpawnScheduleStop to start and stop the schedule respectively.

    12. +

  12. SPAWN.SpawnFromUnit: Spawn a new group taking the position of a UNIT.

    13. +

  13. SPAWN.SpawnInZone: Spawn a new group in a ZONE.

    14. +
+ +

Note that SPAWN.Spawn and SPAWN.ReSpawn return a GROUP#GROUP.New object, that contains a reference to the DCSGroup object. +You can use the GROUP object to do further actions with the DCSGroup.

+ +
    +
  1. SPAWN object cleaning: +
    + Sometimes, it will occur during a mission run-time, that ground or especially air objects get damaged, and will while being damged stop their activities, while remaining alive. + In such cases, the SPAWN object will just sit there and wait until that group gets destroyed, but most of the time it won't, + and it may occur that no new groups are or can be spawned as limits are reached. + To prevent this, a SPAWN.CleanUp initialization method has been defined that will silently monitor the status of each spawned group. + Once a group has a velocity = 0, and has been waiting for a defined interval, that group will be cleaned or removed from run-time. + There is a catch however :-) If a damaged group has returned to an airbase within the coalition, that group will not be considered as "lost"... + In such a case, when the inactive group is cleaned, a new group will Re-spawned automatically. + This models AI that has succesfully returned to their airbase, to restart their combat activities. + Check the SPAWN.CleanUp for further info.
    2. +
+ + +

Global(s)

+ + + + + +
SPAWN + +
+

Type SPAWN

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SPAWN:Array(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY) +

Makes the groups visible before start (like a batallion).

+
SPAWN.ClassName + +
SPAWN:CleanUp(SpawnCleanUpInterval) +

CleanUp groups when they are still alive, but inactive.

+
SPAWN:GetFirstAliveGroup(SpawnCursor) +

Find the first alive group.

+
SPAWN:GetGroupFromIndex(SpawnIndex) +

Get the group from an index.

+
SPAWN:GetLastAliveGroup() +

Find the last alive group during runtime.

+
SPAWN:GetNextAliveGroup(SpawnCursor) +

Find the next alive group.

+
SPAWN:GetSpawnIndexFromGroup(SpawnGroup) +

Get the index from a given group.

+
SPAWN:Limit(SpawnMaxUnitsAlive, SpawnMaxGroups) +

Limits the Maximum amount of Units that can be alive at the same time, and the maximum amount of groups that can be spawned.

+
SPAWN:New(SpawnTemplatePrefix) +

Creates the main object to spawn a GROUP defined in the DCS ME.

+
SPAWN:NewWithAlias(SpawnTemplatePrefix, SpawnAliasPrefix) +

Creates a new SPAWN instance to create new groups based on the defined template and using a new alias for each new group.

+
SPAWN:RandomizeRoute(SpawnStartPoint, SpawnEndPoint, SpawnRadius) +

Randomizes the defined route of the SpawnTemplatePrefix group in the ME.

+
SPAWN:RandomizeTemplate(SpawnTemplatePrefixTable) +

This function is rather complicated to understand.

+
SPAWN:ReSpawn(SpawnIndex) +

Will re-spawn a group based on a given index.

+
SPAWN:Repeat() +

For planes and helicopters, when these groups 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 runtime environment.

+
SPAWN:RepeatOnEngineShutDown() +

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

+
SPAWN:RepeatOnLanding() + +
SPAWN:Spawn() +

Will re-spawn a group based on a given index.

+
SPAWN:SpawnFromUnit(HostUnit, OuterRadius, InnerRadius, SpawnIndex) +

Will spawn a group from a hosting unit.

+
SPAWN:SpawnGroupName(SpawnIndex) +

Will return the SpawnGroupName either with with a specific count number or without any count.

+
SPAWN:SpawnInZone(Zone, SpawnIndex) +

Will spawn a Group within a given ZONE.

+
SPAWN:SpawnScheduleStart() +

Will start the spawning scheduler.

+
SPAWN:SpawnScheduleStop() +

Will stop the scheduled spawning scheduler.

+
SPAWN:SpawnScheduled(SpawnTime, SpawnTimeVariation) +

Spawns new groups at varying time intervals.

+
SPAWN:SpawnWithIndex(SpawnIndex) +

Will spawn a group with a specified index number.

+
SPAWN:UnControlled() +

Will spawn a plane group in uncontrolled mode...

+
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:_GetGroupFromDCSUnit(DCSUnit) +

Return the group within the SpawnGroups collection with input a DCSUnit.

+
SPAWN:_GetGroupIndexFromDCSUnit(DCSUnit) +

Get the group index from a DCSUnit.

+
SPAWN:_GetLastIndex() +

Return the last maximum index that can be used.

+
SPAWN:_GetPrefixFromDCSUnit(DCSUnit) +

Return the prefix of a DCSUnit.

+
SPAWN:_GetSpawnIndex(SpawnIndex) +

Get the next index of the groups to be spawned.

+
SPAWN:_GetTemplate(SpawnTemplatePrefix) +

Gets the Group Template from the ME environment definition.

+
SPAWN:_InitializeSpawnGroups(SpawnIndex) +

Initalize the SpawnGroups collection.

+
SPAWN:_OnBirth(event) + +
SPAWN:_OnDeadOrCrash(event) +

Obscolete

+
SPAWN:_OnLand(event) +

Will detect AIR Units landing...

+
SPAWN:_OnTakeOff(event) +

Will detect AIR Units taking off...

+
SPAWN:_Prepare(SpawnTemplatePrefix, SpawnIndex) +

Prepares the new Group Template.

+
SPAWN:_RandomizeRoute(SpawnIndex) +

Internal function randomizing the routes.

+
SPAWN:_RandomizeTemplate(SpawnIndex) + +
SPAWN:_Scheduler() +

This function is called automatically by the Spawning scheduler.

+
SPAWN:_SpawnCleanUpScheduler() + +
SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) + +
+ +

Global(s)

+
+
+ + #SPAWN + +SPAWN + +
+
+ + + +
+
+

Type Spawn

+ +

Type SPAWN

+ +

SPAWN Class

+ +

Field(s)

+
+
+ + +SPAWN:Array(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY) + +
+
+ +

Makes the groups visible before start (like a batallion).

+ + +

The method will take the position of the group as the first position in the array.

+ +

Parameters

+
    +
  • + +

    #number SpawnAngle :

    +
        The angle in degrees how the groups and each unit of the group will be positioned.
+
    + +
    • +
  • + +

    #number SpawnWidth :

    +
         The amount of Groups that will be positioned on the X axis.
+
    + +
    • +
  • + +

    #number SpawnDeltaX :

    +
       The space between each Group on the X-axis.
+
    + +
    • +
  • + +

    #number SpawnDeltaY :

    +
         The space between each Group on the Y-axis.
+
    + +
    • +
+

Return value

+ +

#SPAWN: +self

+ +

Usage:

+ 
-- Define an array of Groups.
+Spawn_BE_Ground = SPAWN:New( 'BE Ground' ):Limit( 2, 24 ):Visible( 90, "Diamond", 10, 100, 50 )
+ +
+
+
+
+ + +SPAWN.ClassName + +
+
+ + + +
+
+
+
+ + +SPAWN:CleanUp(SpawnCleanUpInterval) + +
+
+ +

CleanUp groups when they are still alive, but inactive.

+ + +

When groups are still alive and have become inactive due to damage and are unable to contribute anything, then this group will be removed at defined intervals in seconds.

+ +

Parameter

+
    +
  • + +

    #string SpawnCleanUpInterval : +The interval to check for inactive groups within seconds.

    + +
    • +
+

Return value

+ +

#SPAWN: +self

+ +

Usage:

+ 
Spawn_Helicopter:CleanUp( 20 )  -- CleanUp the spawning of the helicopters every 20 seconds when they become inactive.
+ +
+
+
+
+ + +SPAWN:GetFirstAliveGroup(SpawnCursor) + +
+
+ +

Find the first alive group.

+ +

Parameter

+
    +
  • + +

    #number SpawnCursor : +A number holding the index from where to find the first group from.

    + +
    • +
+

Return values

+
    +
  1. + +

    GROUP#GROUP, #number: +The group found, the new index where the group was found.

    + +
    2. +
  2. + +

    #nil, #nil: +When no group is found, #nil is returned.

    + +
    3. +
+
+
+
+
+ + +SPAWN:GetGroupFromIndex(SpawnIndex) + +
+
+ +

Get the group from an index.

+ + +

Returns the group from the SpawnGroups list. +If no index is given, it will return the first group in the list.

+ +

Parameter

+
    +
  • + +

    #number SpawnIndex : +The index of the group to return.

    + +
    • +
+

Return value

+ +

GROUP#GROUP:

+ + +
+
+
+
+ + +SPAWN:GetLastAliveGroup() + +
+
+ +

Find the last alive group during runtime.

+ +
+
+
+
+ + +SPAWN:GetNextAliveGroup(SpawnCursor) + +
+
+ +

Find the next alive group.

+ +

Parameter

+
    +
  • + +

    #number SpawnCursor : +A number holding the last found previous index.

    + +
    • +
+

Return values

+
    +
  1. + +

    GROUP#GROUP, #number: +The group found, the new index where the group was found.

    + +
    2. +
  2. + +

    #nil, #nil: +When no group is found, #nil is returned.

    + +
    3. +
+
+
+
+
+ + +SPAWN:GetSpawnIndexFromGroup(SpawnGroup) + +
+
+ +

Get the index from a given group.

+ + +

The function will search the name of the group for a #, and will return the number behind the #-mark.

+ +

Parameter

+
    +
  • + +

    SpawnGroup :

    + +
    • +
+
+
+
+
+ + +SPAWN:Limit(SpawnMaxUnitsAlive, SpawnMaxGroups) + +
+
+ +

Limits the Maximum amount of Units that can be alive at the same time, and the maximum amount of groups that can be spawned.

+ + +

Note that this method is exceptionally important to balance 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... +When a SPAWN.New is executed and the limit of the amount of units alive is reached, then no new spawn will happen of the group, until some of these units of the spawn object will be destroyed.

+ +

Parameters

+
    +
  • + +

    #number SpawnMaxUnitsAlive : +The maximum amount of units that can be alive at runtime.

    + +
    • +
  • + +

    #number SpawnMaxGroups : +The maximum amount of groups that can be spawned. When the limit is reached, then no more actual 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 defines that there are no maximum group limits, but there are limits on the maximum of units that can be alive at the same time.

    + +
    • +
+

Return value

+ +

#SPAWN: +self

+ +

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:New(SpawnTemplatePrefix) + +
+
+ +

Creates the main object to spawn a GROUP defined in the DCS ME.

+ +

Parameter

+
    +
  • + +

    #string SpawnTemplatePrefix : +is the name of the Group in the ME that defines the Template. Each new group will have the name starting with SpawnTemplatePrefix.

    + +
    • +
+

Return value

+ +

#SPAWN:

+ + +

Usages:

+
    + 
  • -- NATO helicopters engaging in the battle field.
+Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' )
    • + 
  • local Plane = SPAWN:New( "Plane" ) -- Creates a new local variable that can initiate new planes with the name "Plane#ddd" using the template "Plane" as defined within the ME.
    • +
+ +
+
+
+
+ + +SPAWN:NewWithAlias(SpawnTemplatePrefix, SpawnAliasPrefix) + +
+
+ +

Creates a new SPAWN instance to create new groups based on the defined template and using a new alias for each new group.

+ +

Parameters

+
    +
  • + +

    #string SpawnTemplatePrefix : +is the name of the Group in the ME that defines the Template.

    + +
    • +
  • + +

    #string SpawnAliasPrefix : +is the name that will be given to the Group at runtime.

    + +
    • +
+

Return value

+ +

#SPAWN:

+ + +

Usages:

+
    + 
  • -- NATO helicopters engaging in the battle field.
+Spawn_BE_KA50 = SPAWN:NewWithAlias( 'BE KA-50@RAMP-Ground Defense', 'Helicopter Attacking a City' )
    • + 
  • local PlaneWithAlias = SPAWN:NewWithAlias( "Plane", "Bomber" ) -- Creates a new local variable that can instantiate new planes with the name "Bomber#ddd" using the template "Plane" as defined within the ME.
    • +
+ +
+
+
+
+ + +SPAWN:RandomizeRoute(SpawnStartPoint, SpawnEndPoint, SpawnRadius) + +
+
+ +

Randomizes the defined route of the SpawnTemplatePrefix group in the ME.

+ + +

This is very useful to define extra variation of the behaviour of groups.

+ +

Parameters

+
    +
  • + +

    #number SpawnStartPoint : +is the waypoint where the randomization begins. +Note that the StartPoint = 0 equaling the point where the group is spawned.

    + +
    • +
  • + +

    #number SpawnEndPoint : +is the waypoint where the randomization ends counting backwards. +This parameter is useful to avoid randomization to end at a waypoint earlier than the last waypoint on the route.

    + +
    • +
  • + +

    #number SpawnRadius : +is the radius in meters in which the randomization of the new waypoints, with the original waypoint of the original template located in the middle ...

    + +
    • +
+

Return value

+ +

#SPAWN:

+ + +

Usage:

+ 
-- NATO helicopters engaging in the battle field. 
+-- The KA-50 has waypoints Start point ( =0 or SP ), 1, 2, 3, 4, End point (= 5 or 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 radius of 2000 meters.
+Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):RandomizeRoute( 2, 2, 2000 )
+ +
+
+
+
+ + +SPAWN:RandomizeTemplate(SpawnTemplatePrefixTable) + +
+
+ +

This function is rather complicated to understand.

+ + +

But I'll try to explain. +This function becomes useful when you need to spawn groups with random templates of groups defined within the mission editor, +but they will all follow the same Template route and have the same prefix name. +In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.

+ +

Parameter

+
    +
  • + +

    #string SpawnTemplatePrefixTable : +A table with the names of the groups defined within the mission editor, from which one will be choosen when a new group will be spawned.

    + +
    • +
+

Return value

+ +

#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' SpawnTemplatePrefixes.
+-- 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:ReSpawn(SpawnIndex) + +
+
+ +

Will re-spawn a group based on a given index.

+ + +

Note: Uses DATABASE module defined in MOOSE.

+ +

Parameter

+
    +
  • + +

    #string SpawnIndex : +The index of the group to be spawned.

    + +
    • +
+

Return value

+ +

GROUP#GROUP: +The group that was spawned. You can use this group for further actions.

+ +
+
+
+
+ + +SPAWN:Repeat() + +
+
+ +

For planes and helicopters, when these groups 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 runtime environment.

+ + +

This function is used to re-spawn automatically (so no extra call is needed anymore) the same group after it has 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 re-spawn from the original airbase where it took off. +So ensure that the routes for groups that respawn, always return to the original airbase, or players may get confused ...

+ +

Return value

+ +

#SPAWN: +self

+ +

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:RepeatOnEngineShutDown() + +
+
+ +

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

+ +

Return value

+ + +

SPAWN

+ +
+
+
+
+ + +SPAWN:RepeatOnLanding() + +
+
+ + + +
+
+
+
+ + +SPAWN:Spawn() + +
+
+ +

Will re-spawn a group based on a given index.

+ + +

Note: Uses DATABASE module defined in MOOSE.

+ +

Return value

+ +

GROUP#GROUP: +The group that was spawned. You can use this group for further actions.

+ +
+
+
+
+ + +SPAWN:SpawnFromUnit(HostUnit, OuterRadius, InnerRadius, SpawnIndex) + +
+
+ +

Will spawn a group from a hosting unit.

+ + +

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. +Note that each point in the route assigned to the spawning group is reset to the point of the spawn. +You can use the returned group to further define the route to be followed.

+ +

Parameters

+
    +
  • + +

    Unit#UNIT HostUnit : +The air or ground unit dropping or unloading the group.

    + +
    • +
  • + +

    #number OuterRadius : +The outer radius in meters where the new group will be spawned.

    + +
    • +
  • + +

    #number InnerRadius : +The inner radius in meters where the new group will NOT be spawned.

    + +
    • +
  • + +

    #number SpawnIndex : +(Optional) The index which group to spawn within the given zone.

    + +
    • +
+

Return values

+
    +
  1. + +

    Group#GROUP: +that was spawned.

    + +
    2. +
  2. + +

    #nil: +Nothing was spawned.

    + +
    3. +
+
+
+
+
+ + +SPAWN:SpawnGroupName(SpawnIndex) + +
+
+ +

Will return the SpawnGroupName either with with a specific count number or without any count.

+ +

Parameter

+
    +
  • + +

    #number SpawnIndex : +Is the number of the Group that is to be spawned.

    + +
    • +
+

Return value

+ + +

string SpawnGroupName

+ +
+
+
+
+ + +SPAWN:SpawnInZone(Zone, SpawnIndex) + +
+
+ +

Will spawn a Group within a given ZONE.

+ +

Parameters

+
    +
  • + +

    #ZONE Zone : +The zone where the group is to be spawned.

    + +
    • +
  • + +

    #number SpawnIndex : +(Optional) The index which group to spawn within the given zone.

    + +
    • +
+

Return values

+
    +
  1. + +

    GROUP#GROUP: +that was spawned.

    + +
    2. +
  2. + +

    #nil: +when nothing was spawned.

    + +
    3. +
+
+
+
+
+ + +SPAWN:SpawnScheduleStart() + +
+
+ +

Will start the spawning scheduler.

+ + +

Note: This function is called automatically when SPAWN.Scheduled is called.

+ +
+
+
+
+ + +SPAWN:SpawnScheduleStop() + +
+
+ +

Will stop the scheduled spawning scheduler.

+ +
+
+
+
+ + +SPAWN:SpawnScheduled(SpawnTime, SpawnTimeVariation) + +
+
+ +

Spawns new groups at 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

+
    +
  • + +

    #number SpawnTime : +The time interval defined in seconds between each new spawn of new groups.

    + +
    • +
  • + +

    #number SpawnTimeVariation : +The variation to be applied on the defined time interval between each new spawn. +The variation is a number between 0 and 1, representing the %-tage of variation to be applied on the time interval.

    + +
    • +
+

Return value

+ +

#SPAWN: +self

+ +

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:SpawnWithIndex(SpawnIndex) + +
+
+ +

Will spawn a group with a specified index number.

+ + +

Uses DATABASE global object defined in MOOSE.

+ +

Parameter

+
    +
  • + +

    SpawnIndex :

    + +
    • +
+

Return value

+ +

GROUP#GROUP: +The group that was spawned. You can use this group for further actions.

+ +
+
+
+
+ + +SPAWN:UnControlled() + +
+
+ +

Will spawn a plane group in uncontrolled mode...

+ + +

This will be similar to the uncontrolled flag setting in the ME.

+ +

Return value

+ +

#SPAWN: +self

+ +
+
+
+
+ + +SPAWN:_GetGroupCategoryID(SpawnPrefix) + +
+
+ +

Gets the CategoryID of the Group with the given SpawnPrefix

+ +

Parameter

+
    +
  • + +

    SpawnPrefix :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetGroupCoalitionID(SpawnPrefix) + +
+
+ +

Gets the CoalitionID of the Group with the given SpawnPrefix

+ +

Parameter

+
    +
  • + +

    SpawnPrefix :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetGroupCountryID(SpawnPrefix) + +
+
+ +

Gets the CountryID of the Group with the given SpawnPrefix

+ +

Parameter

+
    +
  • + +

    SpawnPrefix :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetGroupFromDCSUnit(DCSUnit) + +
+
+ +

Return the group within the SpawnGroups collection with input a DCSUnit.

+ +

Parameter

+
    +
  • + +

    DCSUnit :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetGroupIndexFromDCSUnit(DCSUnit) + +
+
+ +

Get the group index from a DCSUnit.

+ + +

The method will search for a #-mark, and will return the index behind the #-mark of the DCSUnit. +It will return nil of no prefix was found.

+ +

Parameter

+
    +
  • + +

    DCSUnit : +The DCS unit to be searched.

    + +
    • +
+

Return values

+
    +
  1. + +

    #string: +The prefix

    + +
    2. +
  2. + +

    #nil: +Nothing found

    + +
    3. +
+
+
+
+
+ + +SPAWN:_GetLastIndex() + +
+
+ +

Return the last maximum index that can be used.

+ +
+
+
+
+ + +SPAWN:_GetPrefixFromDCSUnit(DCSUnit) + +
+
+ +

Return the prefix of a DCSUnit.

+ + +

The method will search for a #-mark, and will return the text before the #-mark. +It will return nil of no prefix was found.

+ +

Parameter

+
    +
  • + +

    DCSUnit : +The DCS unit to be searched.

    + +
    • +
+

Return values

+
    +
  1. + +

    #string: +The prefix

    + +
    2. +
  2. + +

    #nil: +Nothing found

    + +
    3. +
+
+
+
+
+ + +SPAWN:_GetSpawnIndex(SpawnIndex) + +
+
+ +

Get the next index of the groups to be spawned.

+ + +

This function is complicated, as it is used at several spaces.

+ +

Parameter

+
    +
  • + +

    SpawnIndex :

    + +
    • +
+
+
+
+
+ + +SPAWN:_GetTemplate(SpawnTemplatePrefix) + +
+
+ +

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.

+ +

Parameter

+
    +
  • + +

    SpawnTemplatePrefix :

    + +
    • +
+
+
+
+
+ + +SPAWN:_InitializeSpawnGroups(SpawnIndex) + +
+
+ +

Initalize the SpawnGroups collection.

+ +

Parameter

+
    +
  • + +

    SpawnIndex :

    + +
    • +
+
+
+
+
+ + +SPAWN:_OnBirth(event) + +
+
+ + + + +

TODO Need to delete this... _Database does this now ...

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +SPAWN:_OnDeadOrCrash(event) + +
+
+ +

Obscolete

+ +

Parameter

+
    +
  • + +

    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.

+ +

Parameter

+
    +
  • + +

    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.

+ +

Parameter

+
    +
  • + +

    event :

    + +
    • +
+
+
+
+
+ + +SPAWN:_Prepare(SpawnTemplatePrefix, SpawnIndex) + +
+
+ +

Prepares the new Group Template.

+ +

Parameters

+
    +
  • + +

    SpawnTemplatePrefix :

    + +
    • +
  • + +

    SpawnIndex :

    + +
    • +
+
+
+
+
+ + +SPAWN:_RandomizeRoute(SpawnIndex) + +
+
+ +

Internal function randomizing the routes.

+ +

Parameter

+
    +
  • + +

    #number SpawnIndex : +The index of the group to be spawned.

    + +
    • +
+

Return value

+ +

#SPAWN:

+ + +
+
+
+
+ + +SPAWN:_RandomizeTemplate(SpawnIndex) + +
+
+ + + +

Parameter

+
    +
  • + +

    SpawnIndex :

    + +
    • +
+
+
+
+
+ + +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.

+ +
+
+
+
+ + +SPAWN:_SpawnCleanUpScheduler() + +
+
+ + + +
+
+
+
+ + +SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) + +
+
+ + + +

Parameters

+
    +
  • + +

    SpawnIndex :

    + +
    • +
  • + +

    SpawnRootX :

    + +
    • +
  • + +

    SpawnRootY :

    + +
    • +
  • + +

    SpawnX :

    + +
    • +
  • + +

    SpawnY :

    + +
    • +
  • + +

    SpawnAngle :

    + +
    • +
+
+
+ +

Type ZONE

+ +
+ +
+ + diff --git a/docs/TASK.html b/docs/TASK.html new file mode 100644 index 000000000..8127fa097 --- /dev/null +++ b/docs/TASK.html @@ -0,0 +1,1656 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module 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.

+ +

Global(s)

+ + + + + +
TASK + +
+

Type TASK

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TASK.ActiveStage + +
TASK.AddFlareBlue(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a BLUE FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddFlareGreen(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a GREEN FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddFlareOrange(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, an ORANGE FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddFlareRed(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a RED FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddFlareWhite(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a WHITE FLARE will be fired by an optional SignalUnitNames.

+
TASK.AddGoalCompletion(string, string, number, self, GoalVerb, GoalTask, GoalIncrease) +

Adds an Additional Goal for the TASK to be achieved.

+
TASK:AddSignal(SignalUnitNames, SignalType, SignalColor, SignalHeight) +

Work function to set signal events within a TASK.

+
TASK.AddSmokeBlue(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a BLUE SMOKE will be fired by an optional SignalUnitNames.

+
TASK.AddSmokeGreen(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a GREEN SMOKE will be fired by an optional SignalUnitNames.

+
TASK.AddSmokeOrange(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, an ORANGE SMOKE will be fired by an optional SignalUnitNames.

+
TASK.AddSmokeRed(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a RED SMOKE will be fired by an optional SignalUnitNames.

+
TASK.AddSmokeWhite(table, number, self, SignalUnitNames, SignalHeight) +

When the CLIENT is approaching the landing zone, a WHITE SMOKE will be fired by an optional SignalUnitNames.

+
TASK.Cargos + +
TASK.ClassName + +
TASK:Done() +

Sets a TASK to status Done.

+
TASK:Failed() +

Sets a TASK to status failed.

+
TASK.GetGoalCompletion(?, self, GoalVerb) +

Returns if the additional Goal for the TASK was completed.

+
TASK.GetGoalCount(?, self, GoalVerb) +

Gets the total of Goals currently achieved within the TASK of the GoalVerb.

+
TASK.GetGoalPercentage(?, self, GoalVerb) +

Gets the percentage of Goals currently achieved within the TASK of the GoalVerb.

+
TASK:GetGoalProgress() +

Get progress of a TASK.

+
TASK.GetGoalTotal(?, self, GoalVerb) +

Gets the total of Goals to be achieved within the TASK of the GoalVerb.

+
TASK:GetGoals() +

Returns the Goals of a TASK

+
TASK.Goal(?, self, GoalVerb) +

Returns if a TASK has Goal(s).

+
TASK.GoalTasks + +
TASK.IncreaseGoalCount(number, ?, self, GoalCountIncrease, GoalVerb) +

Increments the total of Goals currently achieved within the TASK of the GoalVerb, with the given GoalCountIncrease.

+
TASK:Init() + +
TASK:IsDone() +

Returns if a TASK is done.

+
TASK:IsFailed() +

Returns if a TASk has failed.

+
TASK:IsGoalReached() +

Returns if all the Goals of the TASK were achieved.

+
TASK.LandingZones + +
TASK.MenuAction(Parameter) + +
TASK.Mission + +
TASK.Name + +
TASK:New() +

Instantiates a new TASK Base.

+
TASK:Reset(Mission, Client) + +
TASK.SIGNAL + +
TASK.SetGoalCount(number, ?, self, GoalCount, GoalVerb) +

Sets the total of Goals currently achieved within the TASK of the GoalVerb.

+
TASK.SetGoalTotal(number, ?, self, GoalTotal, GoalVerb) +

Sets the total Goals to be achieved of the Goal Name

+
TASK:SetStage(StageSequenceIncrement) + +
TASK.ShowGoalProgress(MISSION, CLIENT, self, Mission, Client) +

Show progress of a TASK.

+
TASK.Stage + +
TASK:StageExecute() + +
TASK.Stages + +
TASK.TaskDone + +
TASK.TaskFailed + +
+ +

Global(s)

+
+
+ + #TASK + +TASK + +
+
+ + + +
+
+

Type TASK

+ +

The TASK class

+ +

Field(s)

+
+
+ + #number + +TASK.ActiveStage + +
+
+ + + +
+
+
+
+ + +TASK.AddFlareBlue(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a BLUE FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddFlareGreen(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a GREEN FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddFlareOrange(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, an ORANGE FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddFlareRed(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a RED FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddFlareWhite(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a WHITE FLARE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddGoalCompletion(string, string, number, self, GoalVerb, GoalTask, GoalIncrease) + +
+
+ +

Adds an Additional Goal for the TASK to be achieved.

+ +

Parameters

+
    +
  • + +

    string : +GoalVerb is the name of the Goal of the TASK.

    + +
    • +
  • + +

    string : +GoalTask is a text describing the Goal of the TASK to be achieved.

    + +
    • +
  • + +

    number : +GoalIncrease is a number by which the Goal achievement is increasing.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
  • + +

    GoalTask :

    + +
    • +
  • + +

    GoalIncrease :

    + +
    • +
+
+
+
+
+ + +TASK:AddSignal(SignalUnitNames, SignalType, SignalColor, SignalHeight) + +
+
+ +

Work function to set signal events within a TASK.

+ +

Parameters

+
    +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalType :

    + +
    • +
  • + +

    SignalColor :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeBlue(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a BLUE SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeGreen(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a GREEN SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeOrange(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, an ORANGE SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeRed(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a RED SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + +TASK.AddSmokeWhite(table, number, self, SignalUnitNames, SignalHeight) + +
+
+ +

When the CLIENT is approaching the landing zone, a WHITE SMOKE will be fired by an optional SignalUnitNames.

+ +

Parameters

+
    +
  • + +

    table : +string SignalUnitNames 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.

    + +
    • +
  • + +

    number : +SignalHeight Altitude that the Signal should be fired...

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    SignalUnitNames :

    + +
    • +
  • + +

    SignalHeight :

    + +
    • +
+
+
+
+
+ + + +TASK.Cargos + +
+
+ + + +
+
+
+
+ + #string + +TASK.ClassName + +
+
+ + + +
+
+
+
+ + +TASK:Done() + +
+
+ +

Sets a TASK to status Done.

+ +
+
+
+
+ + +TASK:Failed() + +
+
+ +

Sets a TASK to status failed.

+ +
+
+
+
+ + +TASK.GetGoalCompletion(?, self, GoalVerb) + +
+
+ +

Returns if the additional Goal for the TASK was completed.

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

string Goals

+ +
+
+
+
+ + +TASK.GetGoalCount(?, self, GoalVerb) + +
+
+ +

Gets the total of Goals currently achieved within the TASK of the GoalVerb.

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK.GetGoalPercentage(?, self, GoalVerb) + +
+
+ +

Gets the percentage of Goals currently achieved within the TASK of the GoalVerb.

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK:GetGoalProgress() + +
+
+ +

Get progress of a TASK.

+ +

Return value

+ + +

string GoalsText

+ +
+
+
+
+ + +TASK.GetGoalTotal(?, self, GoalVerb) + +
+
+ +

Gets the total of Goals to be achieved within the TASK of the GoalVerb.

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+
+
+
+
+ + +TASK:GetGoals() + +
+
+ +

Returns the Goals of a TASK

+ +

Return value

+ + +

@table Goals

+ +
+
+
+
+ + +TASK.Goal(?, self, GoalVerb) + +
+
+ +

Returns if a TASK has Goal(s).

+ +

Parameters

+
    +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

bool

+ +
+
+
+
+ + + +TASK.GoalTasks + +
+
+ + + +
+
+
+
+ + +TASK.IncreaseGoalCount(number, ?, self, GoalCountIncrease, GoalVerb) + +
+
+ +

Increments the total of Goals currently achieved within the TASK of the GoalVerb, with the given GoalCountIncrease.

+ +

Parameters

+
    +
  • + +

    number : +GoalCountIncrease is the number of new Goals achieved within the TASK.

    + +
    • +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalCountIncrease :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK:Init() + +
+
+ + + +
+
+
+
+ + +TASK:IsDone() + +
+
+ +

Returns if a TASK is done.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + +TASK:IsFailed() + +
+
+ +

Returns if a TASk has failed.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + +TASK:IsGoalReached() + +
+
+ +

Returns if all the Goals of the TASK were achieved.

+ +

Return value

+ + +

bool

+ +
+
+
+
+ + + +TASK.LandingZones + +
+
+ + + +
+
+
+
+ + +TASK.MenuAction(Parameter) + +
+
+ + + +

Parameter

+
    +
  • + +

    Parameter :

    + +
    • +
+
+
+
+
+ + + +TASK.Mission + +
+
+ + + +
+
+
+
+ + #string + +TASK.Name + +
+
+ + + +
+
+
+
+ + +TASK:New() + +
+
+ +

Instantiates a new TASK Base.

+ + +

Should never be used. Interface Class.

+ +

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK:Reset(Mission, Client) + +
+
+ + + +

Parameters

+
    +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
+
+
+
+
+ + + +TASK.SIGNAL + +
+
+ + + + +

Defines the different signal types with a Task.

+ +
+
+
+
+ + +TASK.SetGoalCount(number, ?, self, GoalCount, GoalVerb) + +
+
+ +

Sets the total of Goals currently achieved within the TASK of the GoalVerb.

+ +

Parameters

+
    +
  • + +

    number : +GoalCount is the total number of Goals achieved within the TASK.

    + +
    • +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalCount :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+

Return value

+ + +

TASK

+ +
+
+
+
+ + +TASK.SetGoalTotal(number, ?, self, GoalTotal, GoalVerb) + +
+
+ +

Sets the total Goals to be achieved of the Goal Name

+ +

Parameters

+
    +
  • + +

    number : +GoalTotal is the number of times the GoalVerb needs to be achieved.

    + +
    • +
  • + +

    ? : +tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    GoalTotal :

    + +
    • +
  • + +

    GoalVerb :

    + +
    • +
+
+
+
+
+ + +TASK:SetStage(StageSequenceIncrement) + +
+
+ + + +

Parameter

+
    +
  • + +

    StageSequenceIncrement :

    + +
    • +
+
+
+
+
+ + +TASK.ShowGoalProgress(MISSION, CLIENT, self, Mission, Client) + +
+
+ +

Show progress of a TASK.

+ +

Parameters

+
    +
  • + +

    MISSION :

    +
    Mission         Group structure describing the Mission.
+
    + +
    • +
  • + +

    CLIENT : +Client Group structure describing the Client.

    + +
    • +
  • + +

    self :

    + +
    • +
  • + +

    Mission :

    + +
    • +
  • + +

    Client :

    + +
    • +
+
+
+
+
+ + + +TASK.Stage + +
+
+ + + +
+
+
+
+ + +TASK:StageExecute() + +
+
+ + + +
+
+
+
+ + + +TASK.Stages + +
+
+ + + +
+
+
+
+ + #boolean + +TASK.TaskDone + +
+
+ + + +
+
+
+
+ + #boolean + +TASK.TaskFailed + +
+
+ + + +
+
+ +
+ +
+ + diff --git a/docs/Unit.html b/docs/Unit.html new file mode 100644 index 000000000..6763591c1 --- /dev/null +++ b/docs/Unit.html @@ -0,0 +1,383 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Unit

+ +

UNIT Classes

+ +

Global(s)

+ + + + + +
UNIT + +
+

Type UNIT

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNIT.CategoryName + +
UNIT.ClassName + +
UNIT:GetCallSign() + +
UNIT:GetCategoryName() + +
UNIT:GetDCSUnit() + +
UNIT:GetID() + +
UNIT:GetName() + +
UNIT:GetPointVec2() + +
UNIT:GetPositionVec3() + +
UNIT:GetPrefix() + +
UNIT:GetTypeName() + +
UNIT:IsAlive() + +
UNIT:New(DCSUnit) + +
UNIT:OtherUnitInRadius(AwaitUnit, Radius) + +
+ +

Global(s)

+
+
+ + #UNIT + +UNIT + +
+
+ + + +
+
+

Type Unit

+ +

Type UNIT

+ +

The UNIT class

+ +

Field(s)

+
+
+ + + +UNIT.CategoryName + +
+
+ + + +
+
+
+
+ + #string + +UNIT.ClassName + +
+
+ + + +
+
+
+
+ + +UNIT:GetCallSign() + +
+
+ + + +
+
+
+
+ + +UNIT:GetCategoryName() + +
+
+ + + +
+
+
+
+ + +UNIT:GetDCSUnit() + +
+
+ + + +
+
+
+
+ + +UNIT:GetID() + +
+
+ + + +
+
+
+
+ + +UNIT:GetName() + +
+
+ + + +
+
+
+
+ + +UNIT:GetPointVec2() + +
+
+ + + +
+
+
+
+ + +UNIT:GetPositionVec3() + +
+
+ + + +
+
+
+
+ + +UNIT:GetPrefix() + +
+
+ + + +
+
+
+
+ + +UNIT:GetTypeName() + +
+
+ + + +
+
+
+
+ + +UNIT:IsAlive() + +
+
+ + + +
+
+
+
+ + +UNIT:New(DCSUnit) + +
+
+ + + +

Parameter

+
    +
  • + +

    DCSUnit :

    + +
    • +
+
+
+
+
+ + +UNIT:OtherUnitInRadius(AwaitUnit, Radius) + +
+
+ + + +

Parameters

+
    +
  • + +

    AwaitUnit :

    + +
    • +
  • + +

    Radius :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/docs/Zone.html b/docs/Zone.html new file mode 100644 index 000000000..ca709f522 --- /dev/null +++ b/docs/Zone.html @@ -0,0 +1,198 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module Zone

+ +

ZONE Classes

+ +

Global(s)

+ + + + + +
ZONE + +
+

Type ZONE

+ + + + + + + + + + + + + + + + + + + + + +
ZONE.ClassName + +
ZONE:GetPointVec2() + +
ZONE:GetRadius() + +
ZONE:GetRandomPoint() + +
ZONE:New(ZoneName) + +
+ +

Global(s)

+
+
+ + #ZONE + +ZONE + +
+
+ + + +
+
+

Type Zone

+ +

Type ZONE

+ +

The ZONE class

+ +

Field(s)

+
+
+ + #string + +ZONE.ClassName + +
+
+ + + +
+
+
+
+ + +ZONE:GetPointVec2() + +
+
+ + + +
+
+
+
+ + +ZONE:GetRadius() + +
+
+ + + +
+
+
+
+ + +ZONE:GetRandomPoint() + +
+
+ + + +
+
+
+
+ + +ZONE:New(ZoneName) + +
+
+ + + +

Parameter

+
    +
  • + +

    ZoneName :

    + +
    • +
+
+
+ +
+ +
+ + diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 000000000..210f8058c --- /dev/null +++ b/docs/index.html @@ -0,0 +1,219 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Base +

BASE The base class for all the classes defined within MOOSE.

+
CARGO +

CARGO Classes

+
CLEANUP +

CLEANUP Classes

+
Client +

CLIENT Classes

+
DEPLOYTASK +

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

+
DESTROYBASETASK +

A DESTROYBASETASK will monitor the destruction of Groups and Units.

+
DESTROYGROUPSTASK +

DESTROYGROUPSTASK

+
DESTROYRADARSTASK +

Task class to destroy radar installations.

+
DESTROYUNITTYPESTASK +

Set TASK to destroy certain unit types.

+
Database +

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

+
Escort +

Taking the lead of AI escorting your flight.

+
GOHOMETASK +

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

+
Group +

A GROUP class abstraction of a DCSGroup class.

+
MISSION +

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

+
MOVEMENT +

Limit the simultaneous movement of Groups within a running Mission.

+
Menu +

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

+
Message +

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

+
NOTASK +

A NOTASK is a dummy activity...

+
PICKUPTASK +

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

+
ROUTETASK +

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

+
STAGE +

Stages within a TASK within a MISSION.

+
Sead +

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

+
Spawn +

Dynamic spawning of groups (and units).

+
TASK +

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

+
Unit +

UNIT Classes

+
Zone +

ZONE Classes

+
routines +

Various routines

+
+
+ +
+ + diff --git a/docs/routines.html b/docs/routines.html new file mode 100644 index 000000000..48e8087f8 --- /dev/null +++ b/docs/routines.html @@ -0,0 +1,1188 @@ + + + + + + +
+
+ +
+
+
+
+ +
+

Module routines

+ +

Various routines

+ +

Global(s)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alive + +
ChooseInfantry(TeleportPrefixTable, TeleportMax) + +
EscortCarrier(CarrierGroup, EscortPrefix, EscortLastWayPoint, EscortEngagementDistanceMax, EscortTargetTypes) + +
EscortCount + +
EscortMissionName + +
GetUnitHeight(CheckUnit) + +
GroupAlive(groupName) + +
LandCarrier(CarrierGroup, LandingZonePrefix) + +
MessageToAll(MsgText, MsgTime, MsgName) + +
MessageToBlue(MsgText, MsgTime, MsgName) + +
MessageToUnit(UnitName, MsgText, MsgTime, MsgName) + +
MusicRegister(SndRef, SndFile, SndTime) + +
MusicReset(flg) + +
MusicToPlayer(SndRef, PlayerName, SndContinue) + +
PlaneActivate(groupNameFormat, flg) + +
PlayerGroup + +
SendMessageToCarrier(CarrierGroup, CarrierMessage) + +
SpawnSettings + +
SpawnedInfantry + +
Su34AttackCarlVinson(groupName) + +
Su34AttackNorth(groupName) + +
Su34AttackWest(groupName) + +
Su34Destroyed(groupName) + +
Su34Hold(groupName) + +
Su34IsDead() + +
Su34Menu(groupName) + +
Su34MenuPath + +
Su34Menus + +
Su34Orbit(groupName) + +
Su34OverviewStatus() + +
Su34RTB(groupName) + +
Su34Status + +
Su34TakeOff(groupName) + +
TeleportPrefixTableCount + +
TeleportPrefixTableIndex + +
UpdateBoardMsg() + +
_MusicTable + +
boardMsgAll + +
boardMsgRed + +
getCarrierHeight(CarrierGroup) + +
lookup_table + +
routines + +
spairs(t, order) + +
+

Global(s)

+
+
+ + + +Alive + +
+
+ + + +
+
+
+
+ + +ChooseInfantry(TeleportPrefixTable, TeleportMax) + +
+
+ + + +

Parameters

+
    +
  • + +

    TeleportPrefixTable :

    + +
    • +
  • + +

    TeleportMax :

    + +
    • +
+
+
+
+
+ + +EscortCarrier(CarrierGroup, EscortPrefix, EscortLastWayPoint, EscortEngagementDistanceMax, EscortTargetTypes) + +
+
+ + + +

Parameters

+
    +
  • + +

    CarrierGroup :

    + +
    • +
  • + +

    EscortPrefix :

    + +
    • +
  • + +

    EscortLastWayPoint :

    + +
    • +
  • + +

    EscortEngagementDistanceMax :

    + +
    • +
  • + +

    EscortTargetTypes :

    + +
    • +
+
+
+
+
+ + #number + +EscortCount + +
+
+ + + +
+
+
+
+ + + +EscortMissionName + +
+
+ + + +
+
+
+
+ + +GetUnitHeight(CheckUnit) + +
+
+ + + +

Parameter

+
    +
  • + +

    CheckUnit :

    + +
    • +
+
+
+
+
+ + +GroupAlive(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +LandCarrier(CarrierGroup, LandingZonePrefix) + +
+
+ + + +

Parameters

+
    +
  • + +

    CarrierGroup :

    + +
    • +
  • + +

    LandingZonePrefix :

    + +
    • +
+
+
+
+
+ + +MessageToAll(MsgText, MsgTime, MsgName) + +
+
+ + + +

Parameters

+
    +
  • + +

    MsgText :

    + +
    • +
  • + +

    MsgTime :

    + +
    • +
  • + +

    MsgName :

    + +
    • +
+
+
+
+
+ + +MessageToBlue(MsgText, MsgTime, MsgName) + +
+
+ + + +

Parameters

+
    +
  • + +

    MsgText :

    + +
    • +
  • + +

    MsgTime :

    + +
    • +
  • + +

    MsgName :

    + +
    • +
+
+
+
+
+ + +MessageToUnit(UnitName, MsgText, MsgTime, MsgName) + +
+
+ + + +

Parameters

+
    +
  • + +

    UnitName :

    + +
    • +
  • + +

    MsgText :

    + +
    • +
  • + +

    MsgTime :

    + +
    • +
  • + +

    MsgName :

    + +
    • +
+
+
+
+
+ + +MusicRegister(SndRef, SndFile, SndTime) + +
+
+ + + +

Parameters

+
    +
  • + +

    SndRef :

    + +
    • +
  • + +

    SndFile :

    + +
    • +
  • + +

    SndTime :

    + +
    • +
+
+
+
+
+ + +MusicReset(flg) + +
+
+ + + +

Parameter

+
    +
  • + +

    flg :

    + +
    • +
+
+
+
+
+ + +MusicToPlayer(SndRef, PlayerName, SndContinue) + +
+
+ + + +

Parameters

+
    +
  • + +

    SndRef :

    + +
    • +
  • + +

    PlayerName :

    + +
    • +
  • + +

    SndContinue :

    + +
    • +
+
+
+
+
+ + +PlaneActivate(groupNameFormat, flg) + +
+
+ + + +

Parameters

+
    +
  • + +

    groupNameFormat :

    + +
    • +
  • + +

    flg :

    + +
    • +
+
+
+
+
+ + + +PlayerGroup + +
+
+ + + +
+
+
+
+ + +SendMessageToCarrier(CarrierGroup, CarrierMessage) + +
+
+ + + +

Parameters

+
    +
  • + +

    CarrierGroup :

    + +
    • +
  • + +

    CarrierMessage :

    + +
    • +
+
+
+
+
+ + + +SpawnSettings + +
+
+ + + +
+
+
+
+ + #number + +SpawnedInfantry + +
+
+ + + +
+
+
+
+ + +Su34AttackCarlVinson(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34AttackNorth(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34AttackWest(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34Destroyed(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34Hold(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34IsDead() + +
+
+ + + +
+
+
+
+ + +Su34Menu(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + + +Su34MenuPath + +
+
+ + + +
+
+
+
+ + #number + +Su34Menus + +
+
+ + + +
+
+
+
+ + +Su34Orbit(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +Su34OverviewStatus() + +
+
+ + + +
+
+
+
+ + +Su34RTB(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + + +Su34Status + +
+
+ + + +
+
+
+
+ + +Su34TakeOff(groupName) + +
+
+ + + +

Parameter

+
    +
  • + +

    groupName :

    + +
    • +
+
+
+
+
+ + +TeleportPrefixTableCount + +
+
+ + + +
+
+
+
+ + + +TeleportPrefixTableIndex + +
+
+ + + +
+
+
+
+ + +UpdateBoardMsg() + +
+
+ + + +
+
+
+
+ + + +_MusicTable + +
+
+ + + +
+
+
+
+ + + +boardMsgAll + +
+
+ + + +
+
+
+
+ + + +boardMsgRed + +
+
+ + + +
+
+
+
+ + +getCarrierHeight(CarrierGroup) + +
+
+ + + +

Parameter

+
    +
  • + +

    CarrierGroup :

    + +
    • +
+
+
+
+
+ + + +lookup_table + +
+
+ + + +
+
+
+
+ + + +routines + +
+
+ + + +
+
+
+
+ + +spairs(t, order) + +
+
+ + + +

Parameters

+
    +
  • + +

    t :

    + +
    • +
  • + +

    order :

    + +
    • +
+
+
+

Type routines

+ +
+ +
+ + diff --git a/docs/stylesheet.css b/docs/stylesheet.css new file mode 100644 index 000000000..1b82635b5 --- /dev/null +++ b/docs/stylesheet.css @@ -0,0 +1,269 @@ +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: bullet; + 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; } + +body, p, td, th { font-size: .95em; line-height: 1.2em;} + +p, ul { margin: 10px 0 0 10px;} + +strong { font-weight: bold;} + +em { font-style: italic;} + +h1 { + font-size: 1.5em; + margin: 25px 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; +} + +p:first-child { + margin-top: 0px; +} + +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; + 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: 18em; + vertical-align: top; + background-color: #f0f0f0; + overflow: scroll; + position: fixed; + height:100%; +} + +#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: 18em; + padding: 1em; + 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; } +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; } +table.function_list td.summary { width: 100%; } + +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;} +