Module AirbasePolice
-Functional -- This module monitors airbases traffic.
+Functional -- The AIRBASEPOLICE classes monitor airbase traffic and regulate speed while taxiing.
-
1) AirbasePolice#AIRBASEPOLICE_BASE class, extends Base#BASE
-The AirbasePolice#AIRBASEPOLICE_BASE class provides the main methods to monitor CLIENT behaviour at airbases. -CLIENTS should not be allowed to:
- --
-
- Don't taxi faster than 40 km/h. -
- Don't take-off on taxiways. -
- Avoid to hit other planes on the airbase. -
- Obey ground control orders. -
2) AirbasePolice#AIRBASEPOLICE_CAUCASUS class, extends AirbasePolice#AIRBASEPOLICE_BASE
-All the airbases on the caucasus map can be monitored using this class. -If you want to monitor specific airbases, you need to use the AIRBASEPOLICE_BASE.Monitor() method, which takes a table or airbase names. -The following names can be given: - * AnapaVityazevo - * Batumi - * Beslan - * Gelendzhik - * Gudauta - * Kobuleti - * KrasnodarCenter - * KrasnodarPashkovsky - * Krymsk - * Kutaisi - * MaykopKhanskaya - * MineralnyeVody - * Mozdok - * Nalchik - * Novorossiysk - * SenakiKolkhi - * SochiAdler - * Soganlug - * SukhumiBabushara - * TbilisiLochini - * Vaziani
- -3) AirbasePolice#AIRBASEPOLICE_NEVADA class, extends AirbasePolice#AIRBASEPOLICE_BASE
-All the airbases on the NEVADA map can be monitored using this class. -If you want to monitor specific airbases, you need to use the AIRBASEPOLICE_BASE.Monitor() method, which takes a table or airbase names. -The following names can be given: - * Nellis - * McCarran - * Creech - * Groom Lake
-Contributions: Dutch Baron - Concept & Testing
Author: FlightControl - Framework Design & Programming
++
Global(s)
| AIRBASEPOLICE_BASE |
-
+ Base class for AIRBASEPOLICE implementations. |
| AIRBASEPOLICE_CAUCASUS |
+AIRBASEPOLICE_CAUCASUS, extends #AIRBASEPOLICE_BASE+
The AIRBASEPOLICE_CAUCASUS class monitors the speed of the airplanes at the airbase during taxi. |
| AIRBASEPOLICE_NEVADA |
+AIRBASEPOLICE_NEVADA, extends #AIRBASEPOLICE_BASE+ +
The AIRBASEPOLICE_NEVADA class monitors the speed of the airplanes at the airbase during taxi. + |
+
| SSB | +AIRBASEPOLICE_BASE.AirbaseNames | + | + +
| AIRBASEPOLICE_BASE:Monitor(AirbaseNames) | +
+ Monitor a table of airbase names. + |
+
| AIRBASEPOLICE_BASE:New(SetClient, Airbases) | +
+ Creates a new AIRBASEPOLICE_BASE object. |
| AIRBASEPOLICE_BASE.SetClient | + | +
| AIRBASEPOLICE_BASE:_AirbaseMonitor() | ++ |
Type AIRBASEPOLICE_CAUCASUS
| AIRBASEPOLICE_CAUCASUS.SetClient | +AIRBASEPOLICE_CAUCASUS:New(SetClient) |
-
+ Creates a new AIRBASEPOLICE_CAUCASUS object. |
Type AIRBASEPOLICE_NEVADA
| AIRBASEPOLICE_NEVADA.Airbases | -- - | -||
| AIRBASEPOLICE_NEVADA.ClassName | -- - | -||
| AIRBASEPOLICE_NEVADA:New(SetClient) |
Creates a new AIRBASEPOLICE_NEVADA object. @@ -243,27 +220,104 @@ The following names can be given:
| ||
| CARGO_CRATE | +
+CARGO_CRATE class, extends #CARGO_REPRESENTABLE+ +The CARGO_CRATE class defines a cargo that is represented by a UNIT object within the simulator, and can be transported by a carrier. |
||
| CARGO_REPRESENTABLE |
-
+ Models CARGO that is representable by a Unit. |
||
| CARGO:__UnLoad(DelaySeconds, ToPointVec2) |
UnLoads the cargo to a Carrier. + |
+
Type CARGO_CRATE
+ | CARGO_CRATE.CargoCarrier | ++ + | +
| CARGO_CRATE.CargoObject | ++ + | +
| CARGO_CRATE:New(CrateName, Type, Name, Weight, ReportRadius, NearRadius, CargoCrateName) | +
+ CARGO_CRATE Constructor. + |
+
| CARGO_CRATE.OnUnLoadedCallBack | ++ + | +
| CARGO_CRATE:onenterLoaded(Event, From, To, CargoCarrier) | +
+ Loaded State. + |
+
| CARGO_CRATE:onenterUnLoaded(Event, From, To, Core, ToPointVec2) | +
+ Enter UnLoaded State. |
Type CARGO_REPRESENTABLE
| CARGO_REPRESENTABLE:Destroy() | +
+ CARGO_REPRESENTABLE Destructor. + |
+ ||
| CARGO_REPRESENTABLE:New(Type, Name, Weight, ReportRadius, NearRadius, CargoObject) |
CARGO_REPRESENTABLE Constructor. @@ -808,12 +863,6 @@ | CARGO_UNIT.CargoObject | - | -
| CARGO_UNIT:Destroy() | -
- CARGO_UNIT Destructor. |
||
SPAWN class, extends Base#BASE+-- + The SPAWN class allows to spawn dynamically new groups. |
SPAWN:InitRandomizeTemplate(SpawnTemplatePrefixTable) |
This method is rather complicated to understand. + |
+
+ |
| SPAWN:InitRandomizeTemplatePrefixes(SpawnTemplatePrefixes) | +
+ Randomize templates to be used as the unit representatives for the Spawned group, defined by specifying the prefix names. + |
+ ||
| SPAWN:InitRandomizeTemplateSet(SpawnTemplateSet) | +
+ Randomize templates to be used as the unit representatives for the Spawned group, defined using a SET_GROUP object. |
||
| SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) | + | +||
| SPAWN.uncontrolled | ++ |
SPAWN class, extends Base#BASE
+-- 
+
The SPAWN class allows to spawn dynamically new groups.
-Each SPAWN object needs to be have a related template group setup in the Mission Editor (ME), +
Each SPAWN object needs to be have related template groups setup in the Mission Editor (ME),
which is a normal group with the Late Activation flag set.
This template group will never be activated in your mission.
SPAWN uses that template group to reference to all the characteristics
@@ -1825,6 +1852,99 @@ Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150
- + +SPAWN:InitRandomizeTemplatePrefixes(SpawnTemplatePrefixes) + + +
-
+
+
Randomize templates to be used as the unit representatives for the Spawned group, defined by specifying the prefix names.
+ + +This method 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 SpawnTemplatePrefixes: +A string or a list of string that contains the prefixes of the groups that are possible unit representatives of the group to be spawned.
+
Return value
+ + + + +Usage:
+
+ +-- NATO Tank Platoons invading Gori. + +-- Choose between different 'US Tank Platoon Templates' configurations to be spawned for the +-- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SPAWN objects. + +-- 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_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 ) +Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 ) +Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
+ -
+
+
-
+
- + + +SPAWN:InitRandomizeTemplateSet(SpawnTemplateSet) + + +
-
+
+
Randomize templates to be used as the unit representatives for the Spawned group, defined using a SET_GROUP object.
+ + +This method 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
+-
+
-
+
+
+ +Core.Set#SET_GROUP SpawnTemplateSet: +A SET_GROUP object set, that contains the groups that are possible unit representatives of the group to be spawned.
+
Return value
+ + + + +Usage:
+
+ +-- NATO Tank Platoons invading Gori. + +-- Choose between different 'US Tank Platoon Template' configurations to be spawned for the +-- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SPAWN objects. + +-- 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_PlatoonSet = SET_GROUP:New():FilterPrefixes( "US Tank Platoon Templates" ):FilterOnce() + +--- Now use the Spawn_US_PlatoonSet to define the templates using InitRandomizeTemplateSet. +Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 ) +Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 ) +Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
+ -
+
+
-
+
- + SPAWN:InitRandomizeUnits(RandomizeUnits, OuterRadius, InnerRadius) @@ -3165,7 +3285,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
-
- #boolean
+
SPAWN.SpawnUnControlled
@@ -3189,7 +3309,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
-
Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.
+When the first Spawn executes, all the Groups need to be made visible before start.
-
+
- + + + +SPAWN.uncontrolled + + +
- + + +
Respawn the Unit using a (tweaked) template of the parent Group.
-
+
- + + +STATIC:ReSpawn(Coordinate, Heading) + + +
-
+
+
Respawn the Unit using a (tweaked) template of the parent Group.
+ +Parameters
+-
+
-
+
+
+ +Core.Point#COORDINATE Coordinate: +The coordinate where to spawn the new Static.
+ -
+
+
+ +#number Heading: +The heading of the unit respawn.
+
-
+
+
-
@@ -322,6 +357,8 @@ Raise an error if not found.
Type UNIT
+
diff --git a/docs/Documentation/StaticObject.html b/docs/Documentation/StaticObject.html
index ac871f1ab..edaaceef9 100644
--- a/docs/Documentation/StaticObject.html
+++ b/docs/Documentation/StaticObject.html
@@ -105,6 +105,7 @@
-
+
FSM_PROCESS.DeployZone
@@ -639,7 +641,7 @@ based on the tasking capabilities defined in Task#TA
-
-
+ #number
TASK_CARGO.CargoLimit
diff --git a/docs/Documentation/Task_PICKUP.html b/docs/Documentation/Task_PICKUP.html
index 79f2d5cf5..481dedc9f 100644
--- a/docs/Documentation/Task_PICKUP.html
+++ b/docs/Documentation/Task_PICKUP.html
@@ -105,6 +105,7 @@
- Zone
- ZoneCaptureCoalition
- ZoneGoal
+- ZoneGoalCargo
- ZoneGoalCoalition
- env
- land
diff --git a/docs/Documentation/Unit.html b/docs/Documentation/Unit.html index ce18f49cc..c3e4be0f3 100644 --- a/docs/Documentation/Unit.html +++ b/docs/Documentation/Unit.html @@ -105,6 +105,7 @@- Zone
- ZoneCaptureCoalition
- ZoneGoal
+- ZoneGoalCargo
- ZoneGoalCoalition
- env
- land
@@ -152,6 +153,12 @@Type
UNIT+ +UNIT:Destroy() ++ +Destroys the UNIT.
+UNIT:Find(DCSUnit) Finds a UNIT from the _DATABASE using a DCSUnit object.
@@ -498,6 +505,24 @@ If you want to obtain the complete 3D position including ori�- + +UNIT:Destroy() + + +
-
+
+
Destroys the UNIT.
+ +Return value
+ +#nil: +The DCS Unit is not existing or alive.
+ +
+
-
+
-
+
UNIT:Find(DCSUnit)
diff --git a/docs/Documentation/UserFlag.html b/docs/Documentation/UserFlag.html
index 032664ca1..f6d9f1f3f 100644
--- a/docs/Documentation/UserFlag.html
+++ b/docs/Documentation/UserFlag.html
@@ -105,6 +105,7 @@
- Zone
- ZoneCaptureCoalition
- ZoneGoal
+- ZoneGoalCargo
- ZoneGoalCoalition
- env
- land
@@ -143,6 +144,12 @@Type
USERFLAG
@@ -1676,7 +1683,7 @@ self+ +USERFLAG:Get(Number) ++ +Get the userflag Number.
+USERFLAG:Is(Number) Check if the userflag has a value of Number.
@@ -201,6 +208,37 @@- + +USERFLAG:Get(Number) + + +
-
+
+
Get the userflag Number.
+ +Parameter
+-
+
-
+
+
+ +Number:
+
Return value
+ +#number: +Number The number value to be checked if it is the same as the userflag.
+ +Usage:
+
+ +local BlueVictory = USERFLAG:New( "VictoryBlue" ) + local BlueVictoryValue = BlueVictory:Get() -- Get the UserFlag VictoryBlue value. +
+ -
+
+
-
+
-
+
USERFLAG:Is(Number)
diff --git a/docs/Documentation/UserSound.html b/docs/Documentation/UserSound.html
index a4254e451..9d2cfbecd 100644
--- a/docs/Documentation/UserSound.html
+++ b/docs/Documentation/UserSound.html
@@ -105,6 +105,7 @@
- Zone
- ZoneCaptureCoalition
- ZoneGoal
+- ZoneGoalCargo
- ZoneGoalCoalition
- env
- land
diff --git a/docs/Documentation/Utils.html b/docs/Documentation/Utils.html index 231da148a..c04656808 100644 --- a/docs/Documentation/Utils.html +++ b/docs/Documentation/Utils.html @@ -105,6 +105,7 @@- Zone
- ZoneCaptureCoalition
- ZoneGoal
+- ZoneGoalCargo
- ZoneGoalCoalition
- env
- land
diff --git a/docs/Documentation/Zone.html b/docs/Documentation/Zone.html index 3d3024456..10096ce01 100644 --- a/docs/Documentation/Zone.html +++ b/docs/Documentation/Zone.html @@ -105,6 +105,7 @@- Zone
- ZoneCaptureCoalition
- ZoneGoal
+- ZoneGoalCargo
- ZoneGoalCoalition
- env
- land
@@ -431,7 +432,13 @@ZONE_POLYGON:New(ZoneName, ZoneGroup) - +Constructor to create a ZONE_POLYGON instance, taking the zone name and the name of the Group#GROUP defined within the Mission Editor.
+Constructor to create a ZONE_POLYGON instance, taking the zone name and the Group#GROUP defined within the Mission Editor.
++ ZONE_POLYGON:NewFromGroupName(ZoneName, GroupName) ++ Constructor to create a ZONE_POLYGON instance, taking the zone name and the name of the Group#GROUP defined within the Mission Editor.
-
-
Constructor to create a ZONE_POLYGON instance, taking the zone name and the name of the Group#GROUP defined within the Mission Editor.
+Constructor to create a ZONE_POLYGON instance, taking the zone name and the Group#GROUP defined within the Mission Editor.
The Group#GROUP waypoints define the polygon corners. The first and the last point are automatically connected by ZONE_POLYGON.
@@ -1701,6 +1708,42 @@ The GROUP waypoints as defined within the Mission Editor define the polygon shap#ZONE_POLYGON: self
+
+
-
+
- + + +ZONE_POLYGON:NewFromGroupName(ZoneName, GroupName) + + +
-
+
+
Constructor to create a ZONE_POLYGON instance, taking the zone name and the name of the Group#GROUP defined within the Mission Editor.
+ + +The Group#GROUP waypoints define the polygon corners. The first and the last point are automatically connected by ZONE_POLYGON.
+ +Parameters
+-
+
-
+
+
+ +#string ZoneName: +Name of the zone.
+ -
+
+
+ +#string GroupName: +The group name of the GROUP defining the waypoints within the Mission Editor to define the polygon shape.
+
Return value
+ +#ZONE_POLYGON: +self
+ -
+
+
- Zone
- ZoneCaptureCoalition
- ZoneGoal
+- ZoneGoalCargo
- ZoneGoalCoalition
- env
- land
diff --git a/docs/Documentation/ZoneGoal.html b/docs/Documentation/ZoneGoal.html index 10026f42f..854e07ffe 100644 --- a/docs/Documentation/ZoneGoal.html +++ b/docs/Documentation/ZoneGoal.html @@ -105,6 +105,7 @@- Zone
- ZoneCaptureCoalition
- ZoneGoal
+- ZoneGoalCargo
- ZoneGoalCoalition
- env
- land
@@ -488,6 +489,7 @@ The name of the player.-
+
ZONE_GOAL.SmokeTime
@@ -496,6 +498,9 @@ The name of the player.
+
+
self.SmokeColor = nil
+
-
diff --git a/docs/Documentation/ZoneGoalCargo.html b/docs/Documentation/ZoneGoalCargo.html
new file mode 100644
index 000000000..99a89cda2
--- /dev/null
+++ b/docs/Documentation/ZoneGoalCargo.html
@@ -0,0 +1,1150 @@
+
+
+
+
+
+
+
- + + #ZONE_GOAL_CARGO + +ZONE_GOAL_CARGO + + +
-
+
+
ZONEGOALCARGO class, extends ZoneGoal#ZONE_GOAL
+ +ZONEGOALCARGO models processes that have a Goal with a defined achievement involving a Zone and Cargo.
+ + +Derived classes implement the ways how the achievements can be realized.
+ +1. ZONEGOALCARGO constructor
+ +-
+
- ZONEGOALCARGO.New(): Creates a new ZONEGOALCARGO object. +
2. ZONEGOALCARGO is a finite state machine (FSM).
+ +2.1 ZONEGOALCARGO States
+ +-
+
- Deployed: The Zone has been captured by an other coalition. +
- Airborne: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone. +
- Loaded: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone. +
- Empty: The Zone is empty. There is not valid unit in the Zone. +
2.2 ZONEGOALCARGO Events
+ +-
+
- Capture: The Zone has been captured by an other coalition. +
- Attack: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone. +
- Guard: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone. +
- Empty: The Zone is empty. There is not valid unit in the Zone. +
2.3 ZONEGOALCARGO State Machine
+ + +
+ - + + +ZONE_GOAL_CARGO:Attack() + + +
-
+
+
Attack Trigger for ZONEGOALCARGO
+ +
+ - + + +ZONE_GOAL_CARGO:Capture() + + +
-
+
+
Capture Trigger for ZONEGOALCARGO
+ +
+ - + + + +ZONE_GOAL_CARGO.Coalition + + +
- + + + + +
- + + +ZONE_GOAL_CARGO:Empty() + + +
-
+
+
Empty Trigger for ZONEGOALCARGO
+ +
+ - + + +ZONE_GOAL_CARGO:GetCoalition() + + +
-
+
+
Get the owning coalition of the zone.
+ +Return value
+ +DCSCoalition.DCSCoalition#coalition: +Coalition.
+ +
+ - + + +ZONE_GOAL_CARGO:GetCoalitionName() + + +
-
+
+
Get the owning coalition name of the zone.
+ +Return value
+ +#string: +Coalition name.
+ +
+ - + + +ZONE_GOAL_CARGO:Guard() + + +
-
+
+
Guard Trigger for ZONEGOALCARGO
+ +
+ - + + +ZONE_GOAL_CARGO:IsAttacked() + + +
- + + + + +
- + + +ZONE_GOAL_CARGO:IsCaptured() + + +
- + + + + +
- + + +ZONE_GOAL_CARGO:IsEmpty() + + +
- + + + + +
- + + +ZONE_GOAL_CARGO:IsGuarded() + + +
- + + + + +
- + + +ZONE_GOAL_CARGO:Mark() + + +
-
+
+
Mark.
+ +
+ - + + + +ZONE_GOAL_CARGO.MarkBlue + + +
- + + + + +
- + + + +ZONE_GOAL_CARGO.MarkRed + + +
- + + + + +
- + + +ZONE_GOAL_CARGO:New(Zone, Coalition) + + +
-
+
+
ZONEGOALCARGO Constructor.
+ +Parameters
+-
+
-
+
+
+ +Core.Zone#ZONE Zone: +A Zone object with the goal to be achieved.
+ -
+
+
+ +DCSCoalition.DCSCoalition#coalition Coalition: +The initial coalition owning the zone.
+
Return value
+ + + + +
+ -
+
+
- + + +ZONE_GOAL_CARGO:OnAfterAttack(From, Event, To) + + +
-
+
+
Attack Handler OnAfter for ZONEGOALCARGO
+ +Parameters
+-
+
-
+
+
+ +#string From:
+ -
+
+
+ +#string Event:
+ -
+
+
+ +#string To:
+
+ -
+
+
- + + +ZONE_GOAL_CARGO:OnAfterCapture(From, Event, To) + + +
-
+
+
Capture Handler OnAfter for ZONEGOALCARGO
+ +Parameters
+-
+
-
+
+
+ +#string From:
+ -
+
+
+ +#string Event:
+ -
+
+
+ +#string To:
+
+ -
+
+
- + + +ZONE_GOAL_CARGO:OnAfterEmpty(From, Event, To) + + +
-
+
+
Empty Handler OnAfter for ZONEGOALCARGO
+ +Parameters
+-
+
-
+
+
+ +#string From:
+ -
+
+
+ +#string Event:
+ -
+
+
+ +#string To:
+
+ -
+
+
- + + +ZONE_GOAL_CARGO:OnAfterGuard(From, Event, To) + + +
-
+
+
Guard Handler OnAfter for ZONEGOALCARGO
+ +Parameters
+-
+
-
+
+
+ +#string From:
+ -
+
+
+ +#string Event:
+ -
+
+
+ +#string To:
+
+ -
+
+
- + + +ZONE_GOAL_CARGO:OnBeforeAttack(From, Event, To) + + +
-
+
+
Attack Handler OnBefore for ZONEGOALCARGO
+ +Parameters
+-
+
-
+
+
+ +#string From:
+ -
+
+
+ +#string Event:
+ -
+
+
+ +#string To:
+
Return value
+ +#boolean:
+ + +
+ -
+
+
- + + +ZONE_GOAL_CARGO:OnBeforeCapture(From, Event, To) + + +
-
+
+
Capture Handler OnBefore for ZONEGOALCARGO
+ +Parameters
+-
+
-
+
+
+ +#string From:
+ -
+
+
+ +#string Event:
+ -
+
+
+ +#string To:
+
Return value
+ +#boolean:
+ + +
+ -
+
+
- + + +ZONE_GOAL_CARGO:OnBeforeEmpty(From, Event, To) + + +
-
+
+
Empty Handler OnBefore for ZONEGOALCARGO
+ +Parameters
+-
+
-
+
+
+ +#string From:
+ -
+
+
+ +#string Event:
+ -
+
+
+ +#string To:
+
Return value
+ +#boolean:
+ + +
+ -
+
+
- + + +ZONE_GOAL_CARGO:OnBeforeGuard(From, Event, To) + + +
-
+
+
Guard Handler OnBefore for ZONEGOALCARGO
+ +Parameters
+-
+
-
+
+
+ +#string From:
+ -
+
+
+ +#string Event:
+ -
+
+
+ +#string To:
+
Return value
+ +#boolean:
+ + +
+ -
+
+
- + + + +ZONE_GOAL_CARGO.ScheduleStatusZone + + +
- + + + + +
- + + +ZONE_GOAL_CARGO:SetCoalition(Coalition) + + +
-
+
+
Set the owning coalition of the zone.
+ +Parameter
+-
+
-
+
+
+ +DCSCoalition.DCSCoalition#coalition Coalition:
+
+ -
+
+
- + + + +ZONE_GOAL_CARGO.SmokeScheduler + + +
- + + + + +
- + + + +ZONE_GOAL_CARGO.States + + +
- + + + + +
- + + +ZONE_GOAL_CARGO:StatusZone() + + +
-
+
+
Check status Coalition ownership.
+ +
+ - + + +ZONE_GOAL_CARGO:__Attack(Delay) + + +
-
+
+
Attack Asynchronous Trigger for ZONEGOALCARGO
+ +Parameter
+-
+
-
+
+
+ +#number Delay:
+
+ -
+
+
- + + +ZONE_GOAL_CARGO:__Capture(Delay) + + +
-
+
+
Capture Asynchronous Trigger for ZONEGOALCARGO
+ +Parameter
+-
+
-
+
+
+ +#number Delay:
+
+ -
+
+
- + + +ZONE_GOAL_CARGO:__Empty(Delay) + + +
-
+
+
Empty Asynchronous Trigger for ZONEGOALCARGO
+ +Parameter
+-
+
-
+
+
+ +#number Delay:
+
+ -
+
+
- + + +ZONE_GOAL_CARGO:__Guard(Delay) + + +
-
+
+
Guard Asynchronous Trigger for ZONEGOALCARGO
+ +Parameter
+-
+
-
+
+
+ +#number Delay:
+
+ -
+
+
- + + +ZONE_GOAL_CARGO:onafterGuard() + + +
-
+
+
When started, check the Coalition status.
+ +
+ - + + +ZONE_GOAL_CARGO:onenterAttacked() + + +
- + + + + +
- + + +ZONE_GOAL_CARGO:onenterCaptured() + + +
- + + + + +
- + + +ZONE_GOAL_CARGO:onenterEmpty() + + +
- + + + + +
- + + +ZONE_GOAL_CARGO:onenterGuarded() + + +
-
+
+
Bound.
+ +
+ - Zone
- ZoneCaptureCoalition
- ZoneGoal +
- ZoneGoalCargo
- ZoneGoalCoalition
- env
- land diff --git a/docs/Documentation/env.html b/docs/Documentation/env.html index 0e1265037..a8e2e77c2 100644 --- a/docs/Documentation/env.html +++ b/docs/Documentation/env.html @@ -105,6 +105,7 @@
- Zone
- ZoneCaptureCoalition
- ZoneGoal +
- ZoneGoalCargo
- ZoneGoalCoalition
- env
- land diff --git a/docs/Documentation/index.html b/docs/Documentation/index.html index c61e305dc..59b168ce2 100644 --- a/docs/Documentation/index.html +++ b/docs/Documentation/index.html @@ -105,6 +105,7 @@
- Zone
- ZoneCaptureCoalition
- ZoneGoal +
- ZoneGoalCargo
- ZoneGoalCoalition
- env
- land @@ -275,7 +276,7 @@ even when there are hardly any players in the mission.
- Zone
- ZoneCaptureCoalition
- ZoneGoal +
- ZoneGoalCargo
- ZoneGoalCoalition
- env
- land diff --git a/docs/Documentation/routines.html b/docs/Documentation/routines.html index e5e6fbc2e..22f0e9cea 100644 --- a/docs/Documentation/routines.html +++ b/docs/Documentation/routines.html @@ -105,6 +105,7 @@
- Zone
- ZoneCaptureCoalition
- ZoneGoal +
- ZoneGoalCargo
- ZoneGoalCoalition
- env
- land diff --git a/docs/Presentations/AIRBASEPOLICE/Dia1.JPG b/docs/Presentations/AIRBASEPOLICE/Dia1.JPG new file mode 100644 index 000000000..80970f0f2 Binary files /dev/null and b/docs/Presentations/AIRBASEPOLICE/Dia1.JPG differ
++ +++ ++ ++ + diff --git a/docs/Documentation/ZoneGoalCoalition.html b/docs/Documentation/ZoneGoalCoalition.html index b1964b864..84a90c12d 100644 --- a/docs/Documentation/ZoneGoalCoalition.html +++ b/docs/Documentation/ZoneGoalCoalition.html @@ -105,6 +105,7 @@++ +Module
+ +ZoneGoalCargoFunctional (WIP) -- Base class that models processes to achieve goals involving a Zone and Cargo.
+ + + +
+ +ZONEGOALCARGO models processes that have a Goal with a defined achievement involving a Zone and Cargo.
+ +
+Derived classes implement the ways how the achievements can be realized.
+ +Author: Sven Van de Velde (FlightControl)
+ +
+ + +Global(s)
++
++ +ZONE_GOAL_CARGO ++ +ZONEGOALCARGO class, extends ZoneGoal#ZONE_GOAL
+ +ZONEGOALCARGO models processes that have a Goal with a defined achievement involving a Zone and Cargo.
+Type
+ZONE_GOAL_CARGO+
+ ++ +ZONE_GOAL_CARGO:Attack() ++ +Attack Trigger for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO:Capture() ++ +Capture Trigger for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO.Coalition ++ + ++ +ZONE_GOAL_CARGO:Empty() ++ +Empty Trigger for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO:GetCoalition() ++ +Get the owning coalition of the zone.
++ +ZONE_GOAL_CARGO:GetCoalitionName() ++ +Get the owning coalition name of the zone.
++ +ZONE_GOAL_CARGO:Guard() ++ +Guard Trigger for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO:IsAttacked() ++ + ++ +ZONE_GOAL_CARGO:IsCaptured() ++ + ++ +ZONE_GOAL_CARGO:IsEmpty() ++ + ++ +ZONE_GOAL_CARGO:IsGuarded() ++ + ++ +ZONE_GOAL_CARGO:Mark() ++ +Mark.
++ +ZONE_GOAL_CARGO.MarkBlue ++ + ++ +ZONE_GOAL_CARGO.MarkRed ++ + ++ +ZONE_GOAL_CARGO:New(Zone, Coalition) ++ +ZONEGOALCARGO Constructor.
++ +ZONE_GOAL_CARGO:OnAfterAttack(From, Event, To) ++ +Attack Handler OnAfter for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO:OnAfterCapture(From, Event, To) ++ +Capture Handler OnAfter for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO:OnAfterEmpty(From, Event, To) ++ +Empty Handler OnAfter for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO:OnAfterGuard(From, Event, To) ++ +Guard Handler OnAfter for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO:OnBeforeAttack(From, Event, To) ++ +Attack Handler OnBefore for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO:OnBeforeCapture(From, Event, To) ++ +Capture Handler OnBefore for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO:OnBeforeEmpty(From, Event, To) ++ +Empty Handler OnBefore for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO:OnBeforeGuard(From, Event, To) ++ +Guard Handler OnBefore for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO.ScheduleStatusZone ++ + ++ +ZONE_GOAL_CARGO:SetCoalition(Coalition) ++ +Set the owning coalition of the zone.
++ +ZONE_GOAL_CARGO.SmokeScheduler ++ + ++ +ZONE_GOAL_CARGO.States ++ + ++ +ZONE_GOAL_CARGO:StatusZone() ++ +Check status Coalition ownership.
++ +ZONE_GOAL_CARGO:__Attack(Delay) ++ +Attack Asynchronous Trigger for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO:__Capture(Delay) ++ +Capture Asynchronous Trigger for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO:__Empty(Delay) ++ +Empty Asynchronous Trigger for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO:__Guard(Delay) ++ +Guard Asynchronous Trigger for ZONEGOALCARGO
++ +ZONE_GOAL_CARGO:onafterGuard() ++ +When started, check the Coalition status.
++ +ZONE_GOAL_CARGO:onenterAttacked() ++ + ++ +ZONE_GOAL_CARGO:onenterCaptured() ++ + ++ +ZONE_GOAL_CARGO:onenterEmpty() ++ + ++ +ZONE_GOAL_CARGO:onenterGuarded() ++ +Bound.
+Global(s)
+-
+
Type
+ +ZoneGoalCargoType
+ZONE_GOAL_CARGOField(s)
+-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
AirbasePolice - Functional -- This module monitors airbases traffic.
+Functional -- The AIRBASEPOLICE classes monitor airbase traffic and regulate speed while taxiing.
@@ -616,7 +617,7 @@ and creates a CSV file logging the scoring events and results for use at team or Spawn - Functional -- Spawn dynamically new GROUPs in your missions.
+Core -- SPAWN class dynamically spawns new groups of units in your missions.
@@ -732,6 +733,12 @@ which are excellent tools to be reused in an OO environment!. +ZoneGoal Functional (WIP) -- Base class that models processes to achieve goals involving a Zone.
++ ZoneGoalCargo ++ Functional (WIP) -- Base class that models processes to achieve goals involving a Zone and Cargo.
diff --git a/docs/Documentation/land.html b/docs/Documentation/land.html index 0df69e015..edb13ac44 100644 --- a/docs/Documentation/land.html +++ b/docs/Documentation/land.html @@ -105,6 +105,7 @@
-
-
+ #number
TASK_CARGO.CargoLimit
diff --git a/docs/Documentation/Task_PICKUP.html b/docs/Documentation/Task_PICKUP.html
index 79f2d5cf5..481dedc9f 100644
--- a/docs/Documentation/Task_PICKUP.html
+++ b/docs/Documentation/Task_PICKUP.html
@@ -105,6 +105,7 @@