diff --git a/Documentation/Base.html b/Documentation/Base.html index acc2db22f..de608bcaf 100644 --- a/Documentation/Base.html +++ b/Documentation/Base.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • @@ -127,6 +130,12 @@ BASE:EnableEvents()

    Enable the event listeners for the class.

    + + + + BASE:Event() + +

    Returns the event dispatcher

    @@ -467,6 +476,24 @@ A #table or any field.

    #BASE:

    + + +
    +
    + + +BASE:Event() + +
    +
    + +

    Returns the event dispatcher

    + +

    Return value

    + +

    Event#EVENT:

    + +
    diff --git a/Documentation/CARGO.html b/Documentation/CARGO.html index d8ed385dc..30d778ea2 100644 --- a/Documentation/CARGO.html +++ b/Documentation/CARGO.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/CLEANUP.html b/Documentation/CLEANUP.html index 38ddbe76b..4d2aa04a7 100644 --- a/Documentation/CLEANUP.html +++ b/Documentation/CLEANUP.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • @@ -139,27 +142,33 @@ - CLEANUP:_EventAddForCleanUp(event) + CLEANUP:_EventAddForCleanUp(event, Event)

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

    - CLEANUP:_EventCrash(event) + CLEANUP:_EventCrash(event, Event)

    Detects if a crash event occurs.

    - CLEANUP:_EventHitCleanUp(event) + CLEANUP:_EventHitCleanUp(event, Event)

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

    - CLEANUP:_EventShot(event) + CLEANUP:_EventShot(event, Event)

    Detects if a unit shoots a missile.

    + + + + CLEANUP:_OnEventBirth(Event) + + @@ -394,7 +403,7 @@ The Unit name ...

    -CLEANUP:_EventAddForCleanUp(event) +CLEANUP:_EventAddForCleanUp(event, Event)
    @@ -404,12 +413,17 @@ The Unit name ...

    If this is the case, add the Group to the CLEANUP List.

    -

    Parameter

    +

    Parameters

    @@ -418,7 +432,7 @@ The Unit name ...

    -CLEANUP:_EventCrash(event) +CLEANUP:_EventCrash(event, Event)
    @@ -428,12 +442,17 @@ The Unit name ...

    Crashed units go into a CleanUpList for removal.

    -

    Parameter

    +

    Parameters

    @@ -442,7 +461,7 @@ The Unit name ...

    -CLEANUP:_EventHitCleanUp(event) +CLEANUP:_EventHitCleanUp(event, Event)
    @@ -452,12 +471,17 @@ The Unit name ...

    If this is the case, destroy the unit.

    -

    Parameter

    +

    Parameters

    @@ -466,7 +490,7 @@ The Unit name ...

    -CLEANUP:_EventShot(event) +CLEANUP:_EventShot(event, Event)
    @@ -476,12 +500,38 @@ The Unit name ...

    If this occurs within one of the zones, then the weapon used must be destroyed.

    -

    Parameter

    +

    Parameters

    +
    +
    +
    +
    + + +CLEANUP:_OnEventBirth(Event) + +
    +
    + + + +

    Parameter

    +
    diff --git a/Documentation/Client.html b/Documentation/Client.html index 267f2232c..6ea751dae 100644 --- a/Documentation/Client.html +++ b/Documentation/Client.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • @@ -92,7 +95,7 @@ Note that clients are NOT the same as groups, they are NOT necessarily alive. - CLIENT:Alive(CallBack) + CLIENT:Alive(CallBack, ...)

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

    @@ -167,6 +170,12 @@ Note that clients are NOT the same as groups, they are NOT necessarily alive. CLIENT.ClientName + + + + CLIENT.ClientParameters + + @@ -400,20 +409,25 @@ is the text defining the Mission briefing.

    -CLIENT:Alive(CallBack) +CLIENT:Alive(CallBack, ...)

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

    -

    Parameter

    +

    Parameters

    Return value

    @@ -587,6 +601,20 @@ Function.

    +
    +
    +
    +
    + + + +CLIENT.ClientParameters + +
    +
    + + +
    diff --git a/Documentation/DCSAirbase.html b/Documentation/DCSAirbase.html index 06def6538..5ba906d1e 100644 --- a/Documentation/DCSAirbase.html +++ b/Documentation/DCSAirbase.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/DCSCoalitionObject.html b/Documentation/DCSCoalitionObject.html index 620eb80ef..e0a1741e8 100644 --- a/Documentation/DCSCoalitionObject.html +++ b/Documentation/DCSCoalitionObject.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/DCSCommand.html b/Documentation/DCSCommand.html index 3e3bda254..e5cb77601 100644 --- a/Documentation/DCSCommand.html +++ b/Documentation/DCSCommand.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/DCSController.html b/Documentation/DCSController.html index c82205e73..05bd95b0e 100644 --- a/Documentation/DCSController.html +++ b/Documentation/DCSController.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/DCSGroup.html b/Documentation/DCSGroup.html index 95570211c..9f2258624 100644 --- a/Documentation/DCSGroup.html +++ b/Documentation/DCSGroup.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/DCSObject.html b/Documentation/DCSObject.html index e91080656..017a27b88 100644 --- a/Documentation/DCSObject.html +++ b/Documentation/DCSObject.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/DCSTask.html b/Documentation/DCSTask.html index f61a7da26..4f42d8760 100644 --- a/Documentation/DCSTask.html +++ b/Documentation/DCSTask.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/DCSTypes.html b/Documentation/DCSTypes.html index 65ec9e2d2..7eb5381e2 100644 --- a/Documentation/DCSTypes.html +++ b/Documentation/DCSTypes.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/DCSUnit.html b/Documentation/DCSUnit.html index 36e77d5a5..7b78a1fd6 100644 --- a/Documentation/DCSUnit.html +++ b/Documentation/DCSUnit.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/DCSWorld.html b/Documentation/DCSWorld.html new file mode 100644 index 000000000..e1dc25088 --- /dev/null +++ b/Documentation/DCSWorld.html @@ -0,0 +1,609 @@ + + + + + + +
    +
    + +
    +
    +
    +
    + +
    +

    Module DCSWorld

    + + + +

    Global(s)

    + + + + + +
    world + +
    +

    Type world

    + + + + + +
    world.event + +
    + +

    Type world.event

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    world.event.S_EVENT_BASE_CAPTURED + +
    world.event.S_EVENT_BIRTH + +
    world.event.S_EVENT_CRASH + +
    world.event.S_EVENT_DEAD + +
    world.event.S_EVENT_EJECTION + +
    world.event.S_EVENT_ENGINE_SHUTDOWN + +
    world.event.S_EVENT_ENGINE_STARTUP + +
    world.event.S_EVENT_HIT + +
    world.event.S_EVENT_HUMAN_FAILURE + +
    world.event.S_EVENT_INVALID + +
    world.event.S_EVENT_LAND + +
    world.event.S_EVENT_MAX + +
    world.event.S_EVENT_MISSION_END + +
    world.event.S_EVENT_MISSION_START + +
    world.event.S_EVENT_PILOT_DEAD + +
    world.event.S_EVENT_PLAYER_COMMENT + +
    world.event.S_EVENT_PLAYER_ENTER_UNIT + +
    world.event.S_EVENT_PLAYER_LEAVE_UNIT + +
    world.event.S_EVENT_REFUELING + +
    world.event.S_EVENT_REFUELING_STOP + +
    world.event.S_EVENT_SHOOTING_END + +
    world.event.S_EVENT_SHOOTING_START + +
    world.event.S_EVENT_SHOT + +
    world.event.S_EVENT_TAKEOFF + +
    world.event.S_EVENT_TOOK_CONTROL + +
    + +

    Global(s)

    +
    +
    + + #world + +world + +
    +
    + + + +
    +
    +

    Type DCSWorld

    + +

    Type world

    +

    Field(s)

    +
    +
    + + #world.event + +world.event + +
    +
    + + + +
    +
    + +

    Type world.event

    +

    Field(s)

    +
    +
    + + +world.event.S_EVENT_BASE_CAPTURED + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_BIRTH + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_CRASH + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_DEAD + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_EJECTION + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_ENGINE_SHUTDOWN + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_ENGINE_STARTUP + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_HIT + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_HUMAN_FAILURE + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_INVALID + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_LAND + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_MAX + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_MISSION_END + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_MISSION_START + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_PILOT_DEAD + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_PLAYER_COMMENT + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_PLAYER_ENTER_UNIT + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_PLAYER_LEAVE_UNIT + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_REFUELING + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_REFUELING_STOP + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_SHOOTING_END + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_SHOOTING_START + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_SHOT + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_TAKEOFF + +
    +
    + + + +
    +
    +
    +
    + + +world.event.S_EVENT_TOOK_CONTROL + +
    +
    + + + +
    +
    + +
    + +
    + + diff --git a/Documentation/DCStimer.html b/Documentation/DCStimer.html index f0d1c0309..1ee0f7a2c 100644 --- a/Documentation/DCStimer.html +++ b/Documentation/DCStimer.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/DEPLOYTASK.html b/Documentation/DEPLOYTASK.html index ca255eb58..846eb6968 100644 --- a/Documentation/DEPLOYTASK.html +++ b/Documentation/DEPLOYTASK.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/DESTROYBASETASK.html b/Documentation/DESTROYBASETASK.html index acfceb720..e239668bd 100644 --- a/Documentation/DESTROYBASETASK.html +++ b/Documentation/DESTROYBASETASK.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • @@ -97,7 +100,7 @@ - DESTROYBASETASK.EventDead(event, self) + DESTROYBASETASK:EventDead(Event)

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

    @@ -109,7 +112,7 @@ - DESTROYBASETASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupPrefixes, DestroyPercentage) + DESTROYBASETASK:New(DestroyGroupType, DestroyUnitType, <, DestroyPercentage, DestroyGroupPrefixes)

    Creates a new DESTROYBASETASK.

    @@ -188,25 +191,19 @@
    -DESTROYBASETASK.EventDead(event, self) +DESTROYBASETASK:EventDead(Event)

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

    -

    Parameters

    +

    Parameter

    • -

      event :

      -
          Event structure of DCS world.
-
      - -
      • -
    • - -

      self :

      +

      Event#EVENTDATA Event : +structure of MOOSE.

    @@ -230,7 +227,7 @@
    -DESTROYBASETASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupPrefixes, DestroyPercentage) +DESTROYBASETASK:New(DestroyGroupType, DestroyUnitType, <, DestroyPercentage, DestroyGroupPrefixes)
    @@ -241,52 +238,32 @@
    • -

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

      +

      #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".

      +

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

      +

      #list < : +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 :

      +

      #number 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.

    • DestroyGroupPrefixes :

      -
      • -
    • - -

      DestroyPercentage :

      -

    Return value

    @@ -332,6 +309,8 @@ umber DestroyPercentage defines the %-tage that needs to be destroyed to achieve
    +

    Type list

    + diff --git a/Documentation/DESTROYGROUPSTASK.html b/Documentation/DESTROYGROUPSTASK.html index dd4fc57c6..0307805d5 100644 --- a/Documentation/DESTROYGROUPSTASK.html +++ b/Documentation/DESTROYGROUPSTASK.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • @@ -88,13 +91,13 @@ - DESTROYGROUPSTASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyPercentage) + DESTROYGROUPSTASK:New(DestroyGroupType, DestroyUnitType, <, DestroyPercentage, DestroyGroupNames)

    Creates a new DESTROYGROUPSTASK.

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

    Report Goal Progress.

    @@ -150,7 +153,7 @@
    -DESTROYGROUPSTASK.New(string, string, table, ?, self, DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyPercentage) +DESTROYGROUPSTASK:New(DestroyGroupType, DestroyUnitType, <, DestroyPercentage, DestroyGroupNames)
    @@ -161,53 +164,35 @@
    @@ -216,7 +201,7 @@ umber DestroyPercentage defines the %-tage that needs to be destroyed to achieve
    -DESTROYGROUPSTASK.ReportGoalProgress(Group, Unit, self, DestroyGroup, DestroyUnit) +DESTROYGROUPSTASK:ReportGoalProgress(DestroyGroup, DestroyUnit)
    @@ -227,35 +212,27 @@ umber DestroyPercentage defines the %-tage that needs to be destroyed to achieve +

    Return value

    + +

    #number: +The DestroyCount reflecting the amount of units destroyed within the group.

    +
    +

    Type list

    + diff --git a/Documentation/DESTROYRADARSTASK.html b/Documentation/DESTROYRADARSTASK.html index d95a35e7d..26d37714a 100644 --- a/Documentation/DESTROYRADARSTASK.html +++ b/Documentation/DESTROYRADARSTASK.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/DESTROYUNITTYPESTASK.html b/Documentation/DESTROYUNITTYPESTASK.html index 77cd3064d..48e9b5d50 100644 --- a/Documentation/DESTROYUNITTYPESTASK.html +++ b/Documentation/DESTROYUNITTYPESTASK.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/Database.html b/Documentation/Database.html index e66bf3247..0e988cba7 100644 --- a/Documentation/Database.html +++ b/Documentation/Database.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • @@ -69,12 +72,6 @@

    Global(s)

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -190,60 +133,12 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -268,30 +163,6 @@ - - - - - - - - - - - - - - - - @@ -306,20 +177,6 @@
    - - -ClientGroup - -
    -
    - - - -
    -
    -
    -
    - #DATABASE DATABASE @@ -334,134 +191,9 @@
    - - -DATABASECategory - -
    -
    - - - -
    -
    -
    -
    - - - -DATABASECoalition - -
    -
    - - - -
    -
    -
    -
    - - - -InitGroup - -
    -
    - - - -
    -
    -
    -
    - - - -InitUnitDesc - -
    -
    - - - -
    -
    -
    -
    - - -LogClose() - -
    -
    - - - -
    -
    -
    -
    - - - -TargetGroup - -
    -
    - - - -
    -
    -
    -
    - - - -TargetUnitDesc - -
    -
    - - - -
    -
    -
    -
    - - - -nHours - -
    -
    - - - -
    -
    -
    -
    - - - -nMins - -
    -
    - - - -
    -
    -
    -
    - - - -nSecs + Database#DATABASE + +_Database
    @@ -602,48 +334,6 @@ 
    -- 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 :

      - -
      • -
    @@ -658,155 +348,6 @@ DBObject = DATABASE:New() - -
    -
    -
    - - -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 :

      - -
      • -
    @@ -887,97 +428,6 @@ This method is used by the SPAWN class.

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

    -
    diff --git a/Documentation/Escort.html b/Documentation/Escort.html index 3afd42ee6..a75e3f26f 100644 --- a/Documentation/Escort.html +++ b/Documentation/Escort.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/Event.html b/Documentation/Event.html new file mode 100644 index 000000000..9e5bd862b --- /dev/null +++ b/Documentation/Event.html @@ -0,0 +1,1678 @@ + + + + + + +
    +
    + +
    +
    +
    +
    + +
    +

    Module Event

    + +

    The EVENT class models an efficient event handling process between other classes and its units, weapons.

    + +

    Global(s)

    +
    ClientGroup - -
    DATABASE @@ -82,61 +79,7 @@
    DATABASECategory - -
    DATABASECoalition - -
    InitGroup - -
    InitUnitDesc - -
    LogClose() - -
    TargetGroup - -
    TargetUnitDesc - -
    nHours - -
    nMins - -
    nSecs_Database 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.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.
    + + + + + + + + +
    EVENT + +
    _EVENTDISPATCHER +

    Declare the event dispatcher based on the EVENT class

    +
    +

    Type EVENT

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    EVENT.ClassID + +
    EVENT.ClassName + +
    EVENT:EventText(EventID) + +
    EVENT.Events + +
    EVENT:Init(EventID, EventClass) +

    Initializes the Events structure for the event

    +
    EVENT:New() + +
    EVENT:OnBirth(EventFunction, EventSelf) +

    Set a new listener for an SEVENTBIRTH event, and registers the unit born.

    +
    EVENT:OnBirthForTemplate(EventGroup, EventFunction, EventSelf, EventTemplate) +

    Create an OnBirth event handler for a group

    +
    EVENT:OnBirthForUnit(EventDCSUnitName, EventFunction, EventSelf) +

    Set a new listener for an SEVENTBIRTH event.

    +
    EVENT:OnCrash(EventFunction, EventSelf) +

    Set a new listener for an SEVENTCRASH event.

    +
    EVENT:OnCrashForTemplate(EventGroup, EventFunction, EventSelf, EventTemplate) +

    Create an OnCrash event handler for a group

    +
    EVENT:OnCrashForUnit(EventDCSUnitName, EventFunction, EventSelf) +

    Set a new listener for an SEVENTCRASH event.

    +
    EVENT:OnDead(EventFunction, EventSelf) +

    Set a new listener for an SEVENTDEAD event.

    +
    EVENT:OnDeadForTemplate(EventGroup, EventFunction, EventSelf, EventTemplate) +

    Create an OnDead event handler for a group

    +
    EVENT:OnDeadForUnit(EventDCSUnitName, EventFunction, EventSelf) +

    Set a new listener for an SEVENTDEAD event.

    +
    EVENT:OnEngineShutDownForTemplate(EventTemplate, EventFunction, EventSelf) +

    Create an OnDead event handler for a group

    +
    EVENT:OnEngineShutDownForUnit(EventDCSUnitName, EventFunction, EventSelf) +

    Set a new listener for an SEVENTENGINE_SHUTDOWN event.

    +
    EVENT:OnEngineStartUpForUnit(EventDCSUnitName, EventFunction, EventSelf) +

    Set a new listener for an SEVENTENGINE_STARTUP event.

    +
    EVENT:OnEventForTemplate(EventTemplate, EventFunction, EventSelf, OnEventFunction) +

    Create an OnDead event handler for a group

    +
    EVENT:OnEventForUnit(EventDCSUnitName, EventFunction, EventSelf, EventID) +

    Set a new listener for an SEVENTX event

    +
    EVENT:OnEventGeneric(EventFunction, EventSelf, EventID) +

    Set a new listener for an SEVENTX event independent from a unit or a weapon.

    +
    EVENT:OnHit(EventFunction, EventSelf) +

    Set a new listener for an SEVENTHIT event.

    +
    EVENT:OnHitForUnit(EventDCSUnitName, EventFunction, EventSelf) +

    Set a new listener for an SEVENTHIT event.

    +
    EVENT:OnLandForTemplate(EventTemplate, EventFunction, EventSelf) +

    Create an OnDead event handler for a group

    +
    EVENT:OnLandForUnit(EventDCSUnitName, EventFunction, EventSelf) +

    Set a new listener for an SEVENTLAND event.

    +
    EVENT:OnPilotDeadForUnit(EventDCSUnitName, EventFunction, EventSelf) +

    Set a new listener for an SEVENTPILOT_DEAD event.

    +
    EVENT:OnShot(EventFunction, EventSelf) +

    Set a new listener for an SEVENTSHOT event.

    +
    EVENT:OnShotForUnit(EventDCSUnitName, EventFunction, EventSelf) +

    Set a new listener for an SEVENTSHOT event for a unit.

    +
    EVENT:OnTakeOffForTemplate(EventTemplate, EventFunction, EventSelf) +

    Create an OnDead event handler for a group

    +
    EVENT:OnTakeOffForUnit(EventDCSUnitName, EventFunction, EventSelf) +

    Set a new listener for an SEVENTTAKEOFF event.

    +
    EVENT:onEvent(Event) + +
    + +

    Type EVENT.Events

    + + + + + +
    EVENT.Events.IniUnit + +
    + +

    Type EVENTDATA

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    EVENTDATA.IniDCSGroup + +
    EVENTDATA.IniDCSGroupName + +
    EVENTDATA.IniDCSUnit + +
    EVENTDATA.IniDCSUnitName + +
    EVENTDATA.TgtDCSGroup + +
    EVENTDATA.TgtDCSGroupName + +
    EVENTDATA.TgtDCSUnit + +
    EVENTDATA.TgtDCSUnitName + +
    EVENTDATA.Weapon + +
    EVENTDATA.WeaponName + +
    EVENTDATA.WeaponTgtDCSUnit + +
    EVENTDATA.id + +
    EVENTDATA.initiator + +
    EVENTDATA.target + +
    EVENTDATA.weapon + +
    + +

    Global(s)

    +
    +
    + + #EVENT + +EVENT + +
    +
    + + + +
    +
    +
    +
    + + #EVENT + +_EVENTDISPATCHER + +
    +
    + +

    Declare the event dispatcher based on the EVENT class

    + +
    +
    +

    Type Event

    + +

    Type EVENT

    + +

    The EVENT structure

    + +

    Field(s)

    +
    +
    + + #number + +EVENT.ClassID + +
    +
    + + + +
    +
    +
    +
    + + #string + +EVENT.ClassName + +
    +
    + + + +
    +
    +
    +
    + + +EVENT:EventText(EventID) + +
    +
    + + + +

    Parameter

    + +
    +
    +
    +
    + + #EVENT.Events + +EVENT.Events + +
    +
    + + + +
    +
    +
    +
    + + +EVENT:Init(EventID, EventClass) + +
    +
    + +

    Initializes the Events structure for the event

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT.Events:

    + + +
    +
    +
    +
    + + +EVENT:New() + +
    +
    + + + +
    +
    +
    +
    + + +EVENT:OnBirth(EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTBIRTH event, and registers the unit born.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnBirthForTemplate(EventGroup, EventFunction, EventSelf, EventTemplate) + +
    +
    + +

    Create an OnBirth event handler for a group

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnBirthForUnit(EventDCSUnitName, EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTBIRTH event.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnCrash(EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTCRASH event.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnCrashForTemplate(EventGroup, EventFunction, EventSelf, EventTemplate) + +
    +
    + +

    Create an OnCrash event handler for a group

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnCrashForUnit(EventDCSUnitName, EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTCRASH event.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnDead(EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTDEAD event.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnDeadForTemplate(EventGroup, EventFunction, EventSelf, EventTemplate) + +
    +
    + +

    Create an OnDead event handler for a group

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnDeadForUnit(EventDCSUnitName, EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTDEAD event.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnEngineShutDownForTemplate(EventTemplate, EventFunction, EventSelf) + +
    +
    + +

    Create an OnDead event handler for a group

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnEngineShutDownForUnit(EventDCSUnitName, EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTENGINE_SHUTDOWN event.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnEngineStartUpForUnit(EventDCSUnitName, EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTENGINE_STARTUP event.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnEventForTemplate(EventTemplate, EventFunction, EventSelf, OnEventFunction) + +
    +
    + +

    Create an OnDead event handler for a group

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnEventForUnit(EventDCSUnitName, EventFunction, EventSelf, EventID) + +
    +
    + +

    Set a new listener for an SEVENTX event

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnEventGeneric(EventFunction, EventSelf, EventID) + +
    +
    + +

    Set a new listener for an SEVENTX event independent from a unit or a weapon.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnHit(EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTHIT event.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnHitForUnit(EventDCSUnitName, EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTHIT event.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnLandForTemplate(EventTemplate, EventFunction, EventSelf) + +
    +
    + +

    Create an OnDead event handler for a group

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnLandForUnit(EventDCSUnitName, EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTLAND event.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnPilotDeadForUnit(EventDCSUnitName, EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTPILOT_DEAD event.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnShot(EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTSHOT event.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnShotForUnit(EventDCSUnitName, EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTSHOT event for a unit.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnTakeOffForTemplate(EventTemplate, EventFunction, EventSelf) + +
    +
    + +

    Create an OnDead event handler for a group

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:OnTakeOffForUnit(EventDCSUnitName, EventFunction, EventSelf) + +
    +
    + +

    Set a new listener for an SEVENTTAKEOFF event.

    + +

    Parameters

    + +

    Return value

    + +

    #EVENT:

    + + +
    +
    +
    +
    + + +EVENT:onEvent(Event) + +
    +
    + + + +

    Parameter

    + +
    +
    + +

    Type EVENT.Events

    + +

    The Events structure

    + +

    Field(s)

    +
    +
    + + #number + +EVENT.Events.IniUnit + +
    +
    + + + +
    +
    + +

    Type EVENTDATA

    + +

    The Event structure

    + +

    Field(s)

    +
    +
    + + +EVENTDATA.IniDCSGroup + +
    +
    + + + +
    +
    +
    +
    + + +EVENTDATA.IniDCSGroupName + +
    +
    + + + +
    +
    +
    +
    + + +EVENTDATA.IniDCSUnit + +
    +
    + + + +
    +
    +
    +
    + + +EVENTDATA.IniDCSUnitName + +
    +
    + + + +
    +
    +
    +
    + + +EVENTDATA.TgtDCSGroup + +
    +
    + + + +
    +
    +
    +
    + + +EVENTDATA.TgtDCSGroupName + +
    +
    + + + +
    +
    +
    +
    + + +EVENTDATA.TgtDCSUnit + +
    +
    + + + +
    +
    +
    +
    + + +EVENTDATA.TgtDCSUnitName + +
    +
    + + + +
    +
    +
    +
    + + +EVENTDATA.Weapon + +
    +
    + + + +
    +
    +
    +
    + + +EVENTDATA.WeaponName + +
    +
    + + + +
    +
    +
    +
    + + +EVENTDATA.WeaponTgtDCSUnit + +
    +
    + + + +
    +
    +
    +
    + + +EVENTDATA.id + +
    +
    + + + +
    +
    +
    +
    + + +EVENTDATA.initiator + +
    +
    + + + +
    +
    +
    +
    + + +EVENTDATA.target + +
    +
    + + + +
    +
    +
    +
    + + +EVENTDATA.weapon + +
    +
    + + + +
    +
    + + + + + + diff --git a/Documentation/GOHOMETASK.html b/Documentation/GOHOMETASK.html index fdacc71a3..b1ebecdcd 100644 --- a/Documentation/GOHOMETASK.html +++ b/Documentation/GOHOMETASK.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/Group.html b/Documentation/Group.html index 91a991562..3298e9321 100644 --- a/Documentation/Group.html +++ b/Documentation/Group.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/MISSION.html b/Documentation/MISSION.html index de9f3738d..81752775f 100644 --- a/Documentation/MISSION.html +++ b/Documentation/MISSION.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • @@ -387,6 +390,12 @@ A CLIENT needs to be registered within the MISSIONSCHEDULER.SchedulerId + + + + MISSIONSCHEDULER:Scoring(Scoring) + +

    Adds a mission scoring to the game.

    @@ -1522,6 +1531,27 @@ MISSIONSCHEDULER:RemoveMission( 'Russia Transport Troops SA-6' ) + + +
    +
    + + +MISSIONSCHEDULER:Scoring(Scoring) + +
    +
    + +

    Adds a mission scoring to the game.

    + +

    Parameter

    +
    diff --git a/Documentation/MOVEMENT.html b/Documentation/MOVEMENT.html index 6441a29d3..1fd0bfce1 100644 --- a/Documentation/MOVEMENT.html +++ b/Documentation/MOVEMENT.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • @@ -94,13 +97,13 @@ on defined intervals (currently every minute).

    - MOVEMENT:OnBirth(event) + MOVEMENT:OnBirth(Event)

    Captures the birth events when new Units were spawned.

    - MOVEMENT:OnDeadOrCrash(event) + MOVEMENT:OnDeadOrCrash(Event)

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

    @@ -186,7 +189,7 @@ on defined intervals (currently every minute).

    -MOVEMENT:OnBirth(event) +MOVEMENT:OnBirth(Event)
    @@ -197,7 +200,7 @@ on defined intervals (currently every minute).

    @@ -207,7 +210,7 @@ on defined intervals (currently every minute).

    -MOVEMENT:OnDeadOrCrash(event) +MOVEMENT:OnDeadOrCrash(Event)
    @@ -218,7 +221,7 @@ on defined intervals (currently every minute).

    diff --git a/Documentation/Menu.html b/Documentation/Menu.html index 533f237b1..a82742975 100644 --- a/Documentation/Menu.html +++ b/Documentation/Menu.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/Message.html b/Documentation/Message.html index fa82240cd..66c9d6c91 100644 --- a/Documentation/Message.html +++ b/Documentation/Message.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/NOTASK.html b/Documentation/NOTASK.html index d75b1a592..4fa604429 100644 --- a/Documentation/NOTASK.html +++ b/Documentation/NOTASK.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/PICKUPTASK.html b/Documentation/PICKUPTASK.html index c16da51ec..e9fcbf698 100644 --- a/Documentation/PICKUPTASK.html +++ b/Documentation/PICKUPTASK.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/ROUTETASK.html b/Documentation/ROUTETASK.html index da4d521b2..87dc106be 100644 --- a/Documentation/ROUTETASK.html +++ b/Documentation/ROUTETASK.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/STAGE.html b/Documentation/STAGE.html index fd863de03..bc38980e4 100644 --- a/Documentation/STAGE.html +++ b/Documentation/STAGE.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/Scoring.html b/Documentation/Scoring.html new file mode 100644 index 000000000..b70b673fb --- /dev/null +++ b/Documentation/Scoring.html @@ -0,0 +1,791 @@ + + + + + + +
    +
    + +
    +
    +
    +
    + +
    +

    Module Scoring

    + +

    Scoring system for MOOSE.

    + + +

    This scoring class calculates the hits and kills that players make within a simulation session. +Scoring is calculated using a defined algorithm. +With a small change in MissionScripting.lua, the scoring can also be logged in a CSV file, that can then be uploaded +to a database or a BI tool to publish the scoring results to the player community.

    + +

    Global(s)

    + + + + + + + + + + + + + + + + + + + + + +
    ClientGroup + +
    SCORING + +
    nHours + +
    nMins + +
    nSecs + +
    +

    Type SCORING

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    SCORING.AllScoresMenu + +
    SCORING.ClassID + +
    SCORING.ClassName + +
    SCORING:CloseCSV() + +
    SCORING.Menu + +
    SCORING:New(GameName) +

    Creates a new SCORING object to administer the scoring achieved by players.

    +
    SCORING:OpenCSV(ScoringCSV) +

    Opens a score CSV file to log the scores.

    +
    SCORING.Players +

    A collection of the current players that have joined the game.

    +
    SCORING:ReportScoreAll() + +
    SCORING:ReportScorePlayer() + +
    SCORING.RunTime + +
    SCORING:ScoreCSV(PlayerName, ScoreType, ScoreTimes, ScoreAmount, PlayerUnitName, PlayerUnitCoalition, PlayerUnitCategory, PlayerUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType) +

    Registers a score for a player.

    +
    SCORING:ScoreMenu() +

    Creates a score radio menu.

    +
    SCORING.ScoringCSV + +
    SCORING:SecondsToClock(sSeconds) + +
    SCORING:_AddMissionScore(MissionName, Score) +

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

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

    Registers Scores the players completing a Mission Task.

    +
    SCORING:_AddPlayerFromUnit(UnitData) +

    Add a new player entering a Unit.

    +
    SCORING:_EventOnDeadOrCrash(Event) +

    Track DEAD or CRASH events for the scoring.

    +
    SCORING:_EventOnHit(Event) +

    Handles the OnHit event for the scoring.

    +
    SCORING:_FollowPlayersScheduled() +

    Follows new players entering Clients within the DCSRTE.

    +
    + +

    Global(s)

    +
    +
    + + + +ClientGroup + +
    +
    + + + +
    +
    +
    +
    + + #SCORING + +SCORING + +
    +
    + + + +
    +
    +
    +
    + + + +nHours + +
    +
    + + + +
    +
    +
    +
    + + + +nMins + +
    +
    + + + +
    +
    +
    +
    + + + +nSecs + +
    +
    + + + +
    +
    +

    Type Scoring

    + +

    Type SCORING

    + +

    The Scoring class

    + +

    Field(s)

    +
    +
    + + + +SCORING.AllScoresMenu + +
    +
    + + + +
    +
    +
    +
    + + #number + +SCORING.ClassID + +
    +
    + + + +
    +
    +
    +
    + + #string + +SCORING.ClassName + +
    +
    + + + +
    +
    +
    +
    + + +SCORING:CloseCSV() + +
    +
    + + + +
    +
    +
    +
    + + + +SCORING.Menu + +
    +
    + + + +
    +
    +
    +
    + + +SCORING:New(GameName) + +
    +
    + +

    Creates a new SCORING object to administer the scoring achieved by players.

    + +

    Parameter

    +
      +
    • + +

      #string GameName : +The name of the game. This name is also logged in the CSV score file.

      + +
      • +
    +

    Return value

    + +

    #SCORING: +self

    + +

    Usage:

    + 
    -- Define a new scoring object for the mission Gori Valley.
+ScoringObject = SCORING:New( "Gori Valley" )
    + +
    +
    +
    +
    + + +SCORING:OpenCSV(ScoringCSV) + +
    +
    + +

    Opens a score CSV file to log the scores.

    + +

    Parameter

    +
      +
    • + +

      #string ScoringCSV :

      + +
      • +
    +

    Return value

    + +

    #SCORING: +self

    + +

    Usage:

    + 
    -- Open a new CSV file to log the scores of the game Gori Valley. Let the name of the CSV file begin with "Player Scores".
+ScoringObject = SCORING:New( "Gori Valley" )
+ScoringObject:OpenCSV( "Player Scores" )
    + +
    +
    +
    +
    + + +SCORING.Players + +
    +
    + +

    A collection of the current players that have joined the game.

    + +
    +
    +
    +
    + + +SCORING:ReportScoreAll() + +
    +
    + + + +
    +
    +
    +
    + + +SCORING:ReportScorePlayer() + +
    +
    + + + +
    +
    +
    +
    + + + +SCORING.RunTime + +
    +
    + + + +
    +
    +
    +
    + + +SCORING:ScoreCSV(PlayerName, ScoreType, ScoreTimes, ScoreAmount, PlayerUnitName, PlayerUnitCoalition, PlayerUnitCategory, PlayerUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType) + +
    +
    + +

    Registers a score for a player.

    + +

    Parameters

    +
      +
    • + +

      #string PlayerName : +The name of the player.

      + +
      • +
    • + +

      #string ScoreType : +The type of the score.

      + +
      • +
    • + +

      #string ScoreTimes : +The amount of scores achieved.

      + +
      • +
    • + +

      #string ScoreAmount : +The score given.

      + +
      • +
    • + +

      #string PlayerUnitName : +The unit name of the player.

      + +
      • +
    • + +

      #string PlayerUnitCoalition : +The coalition of the player unit.

      + +
      • +
    • + +

      #string PlayerUnitCategory : +The category of the player unit.

      + +
      • +
    • + +

      #string PlayerUnitType : +The type of the player unit.

      + +
      • +
    • + +

      #string TargetUnitName : +The name of the target unit.

      + +
      • +
    • + +

      #string TargetUnitCoalition : +The coalition of the target unit.

      + +
      • +
    • + +

      #string TargetUnitCategory : +The category of the target unit.

      + +
      • +
    • + +

      #string TargetUnitType : +The type of the target unit.

      + +
      • +
    +

    Return value

    + +

    #SCORING: +self

    + +
    +
    +
    +
    + + +SCORING:ScoreMenu() + +
    +
    + +

    Creates a score radio menu.

    + + +

    Can be accessed using Radio -> F10.

    + +

    Return value

    + +

    #SCORING: +self

    + +
    +
    +
    +
    + + + +SCORING.ScoringCSV + +
    +
    + + + +
    +
    +
    +
    + + +SCORING:SecondsToClock(sSeconds) + +
    +
    + + + +

    Parameter

    +
      +
    • + +

      sSeconds :

      + +
      • +
    +
    +
    +
    +
    + + +SCORING:_AddMissionScore(MissionName, Score) + +
    +
    + +

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

    + +

    Parameters

    +
      +
    • + +

      MissionName :

      + +
      • +
    • + +

      Score :

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

    Registers Scores the players completing a Mission Task.

    + +

    Parameters

    +
      +
    • + +

      PlayerUnit :

      + +
      • +
    • + +

      MissionName :

      + +
      • +
    • + +

      Score :

      + +
      • +
    +
    +
    +
    +
    + + +SCORING:_AddPlayerFromUnit(UnitData) + +
    +
    + +

    Add a new player entering a Unit.

    + +

    Parameter

    +
      +
    • + +

      UnitData :

      + +
      • +
    +
    +
    +
    +
    + + +SCORING:_EventOnDeadOrCrash(Event) + +
    +
    + +

    Track DEAD or CRASH events for the scoring.

    + +

    Parameter

    + +
    +
    +
    +
    + + +SCORING:_EventOnHit(Event) + +
    +
    + +

    Handles the OnHit event for the scoring.

    + +

    Parameter

    + +
    +
    +
    +
    + + +SCORING:_FollowPlayersScheduled() + +
    +
    + +

    Follows new players entering Clients within the DCSRTE.

    + + +

    TODO: Need to see if i can catch this also with an event. It will eliminate the schedule ...

    + +
    +
    + +
    + +
    + + diff --git a/Documentation/Sead.html b/Documentation/Sead.html index d11fc919f..95c47ee9e 100644 --- a/Documentation/Sead.html +++ b/Documentation/Sead.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • @@ -82,7 +85,7 @@ - SEAD:EventShot(event) + SEAD:EventShot(Event)

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

    @@ -147,7 +150,7 @@
    -SEAD:EventShot(event) +SEAD:EventShot(Event)
    @@ -161,7 +164,7 @@ diff --git a/Documentation/Spawn.html b/Documentation/Spawn.html index e2427bf1a..21d159c33 100644 --- a/Documentation/Spawn.html +++ b/Documentation/Spawn.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • @@ -326,9 +329,9 @@ You can use the GROUP object to do further actions with - SPAWN:SpawnInZone(Zone, SpawnIndex) + SPAWN:SpawnInZone(Zone, ZoneRandomize, SpawnIndex) -

    Will spawn a Group within a given ZONE.

    +

    Will spawn a Group within a given Zone#ZONE.

    @@ -1420,23 +1423,33 @@ SpawnGroupName

    -SPAWN:SpawnInZone(Zone, SpawnIndex) +SPAWN:SpawnInZone(Zone, ZoneRandomize, SpawnIndex)
    -

    Will spawn a Group within a given ZONE.

    +

    Will spawn a Group within a given Zone#ZONE.

    + + +

    Once the group is spawned within the zone, it will continue on its route. +The first waypoint (where the group is spawned) is replaced with the zone coordinates.

    Parameters

    -

    Type ZONE

    - diff --git a/Documentation/StaticObject.html b/Documentation/StaticObject.html index b5f1e3915..9f6847026 100644 --- a/Documentation/StaticObject.html +++ b/Documentation/StaticObject.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/TASK.html b/Documentation/TASK.html index 12c34a734..bc244726c 100644 --- a/Documentation/TASK.html +++ b/Documentation/TASK.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • @@ -217,7 +220,7 @@ - TASK.Goal(?, self, GoalVerb) + TASK:Goal(GoalVerb)

    Returns if a TASK has Goal(s).

    @@ -1147,29 +1150,19 @@ tring GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given
    -TASK.Goal(?, self, GoalVerb) +TASK:Goal(GoalVerb)

    Returns if a TASK has Goal(s).

    -

    Parameters

    +

    Parameter

    diff --git a/Documentation/Unit.html b/Documentation/Unit.html index 0f36031dd..985e6a1e7 100644 --- a/Documentation/Unit.html +++ b/Documentation/Unit.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/Zone.html b/Documentation/Zone.html index 10d8c170a..1b9c3cb4b 100644 --- a/Documentation/Zone.html +++ b/Documentation/Zone.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/env.html b/Documentation/env.html index 665f4519f..959ef7350 100644 --- a/Documentation/env.html +++ b/Documentation/env.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/index.html b/Documentation/index.html index 63942937d..50958b731 100644 --- a/Documentation/index.html +++ b/Documentation/index.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • @@ -138,6 +141,12 @@ DCSUnit + + + + DCSWorld + + @@ -186,6 +195,12 @@ Escort

    Taking the lead of AI escorting your flight.

    + + + + Event + +

    The EVENT class models an efficient event handling process between other classes and its units, weapons.

    @@ -246,6 +261,12 @@ STAGE

    Stages within a TASK within a MISSION.

    + + + + Scoring + +

    Scoring system for MOOSE.

    diff --git a/Documentation/land.html b/Documentation/land.html index 630ebb3b9..5399503ee 100644 --- a/Documentation/land.html +++ b/Documentation/land.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject
    • diff --git a/Documentation/routines.html b/Documentation/routines.html index 1125b647e..d33caf801 100644 --- a/Documentation/routines.html +++ b/Documentation/routines.html @@ -30,6 +30,7 @@
  • DCSTask
  • DCSTypes
  • DCSUnit
    • +
  • DCSWorld
  • DCStimer
  • DEPLOYTASK
  • DESTROYBASETASK
    • @@ -38,6 +39,7 @@
  • DESTROYUNITTYPESTASK
  • Database
  • Escort
    • +
  • Event
  • GOHOMETASK
  • Group
  • MISSION
    • @@ -48,6 +50,7 @@
  • PICKUPTASK
  • ROUTETASK
  • STAGE
    • +
  • Scoring
  • Sead
  • Spawn
  • StaticObject