From abf84e121f0140e5a201f696249df401a94368fb Mon Sep 17 00:00:00 2001 From: FlightControl_Master Date: Thu, 26 Oct 2017 19:22:18 +0200 Subject: [PATCH] Documentation --- docs/Documentation/AI_Patrol.html | 3 + docs/Documentation/Cargo.html | 2 +- docs/Documentation/Designate.html | 3 +- docs/Documentation/Detection.html | 3 +- docs/Documentation/Fsm.html | 3 +- docs/Documentation/Positionable.html | 1 - docs/Documentation/Spawn.html | 139 +++++++++++++++++++++++++-- docs/Documentation/Spot.html | 4 + docs/Documentation/Task_Cargo.html | 3 +- docs/Documentation/ZoneGoal.html | 4 + 10 files changed, 146 insertions(+), 19 deletions(-) diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html index 004acc069..45a2143e2 100644 --- a/docs/Documentation/AI_Patrol.html +++ b/docs/Documentation/AI_Patrol.html @@ -936,6 +936,9 @@ Use the method AIPATROLZONE.M + +

This table contains the targets detected during patrol.

+
diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index 64107dd30..6d992a859 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -2269,7 +2269,6 @@ The amount of seconds to delay the action.

- CARGO_CRATE.CargoCarrier @@ -3698,6 +3697,7 @@ The range till cargo will board.

+ CARGO_UNIT.CargoCarrier diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html index 1f8e3673b..73252897d 100644 --- a/docs/Documentation/Designate.html +++ b/docs/Documentation/Designate.html @@ -1106,7 +1106,7 @@ function below will use the range 1-7 just in case

- + #number DESIGNATE.LaseDuration @@ -1160,7 +1160,6 @@ function below will use the range 1-7 just in case

- DESIGNATE.LaserCodes diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index f9bc34671..86ba51e64 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -2482,7 +2482,6 @@ The index of the DetectedItem.

- #number DETECTION_BASE.DetectedItemMax @@ -4060,7 +4059,7 @@ Return false to cancel Transition.

- #number + DETECTION_BASE.RefreshTimeInterval diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index 9580fc0e5..8f30460d8 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -1608,7 +1608,7 @@ A string defining the start state.

- + #string FSM._StartState @@ -1907,7 +1907,6 @@ A string defining the start state.

- FSM.current diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html index 680f960e5..7605224ac 100644 --- a/docs/Documentation/Positionable.html +++ b/docs/Documentation/Positionable.html @@ -2017,7 +2017,6 @@ The height in meters to add to the altitude of the positionable.

- Core.Spot#SPOT POSITIONABLE.Spot diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index c17bcf5bb..ba128c5d0 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -473,19 +473,19 @@ and any spaces before and after the resulting name are removed.

- SPAWN:SpawnFromStatic(HostStatic, SpawnIndex) + SPAWN:SpawnFromStatic(HostStatic, MinHeight, MaxHeight, SpawnIndex)

Will spawn a group from a hosting static.

- SPAWN:SpawnFromUnit(HostUnit, SpawnIndex) + SPAWN:SpawnFromUnit(HostUnit, MinHeight, MaxHeight, SpawnIndex)

Will spawn a group from a hosting unit.

- SPAWN:SpawnFromVec2(Vec2, SpawnIndex) + SPAWN:SpawnFromVec2(Vec2, MinHeight, MaxHeight, SpawnIndex)

Will spawn a group from a Vec2 in 3D space.

@@ -533,7 +533,7 @@ and any spaces before and after the resulting name are removed.

- SPAWN:SpawnInZone(Zone, RandomizeGroup, SpawnIndex) + SPAWN:SpawnInZone(Zone, RandomizeGroup, MinHeight, MaxHeight, SpawnIndex)

Will spawn a Group within a given Zone.

@@ -848,6 +848,12 @@ and any spaces before and after the resulting name are removed.

SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) + + + + SPAWN.uncontrolled + + @@ -2512,7 +2518,7 @@ Nothing was spawned.

-SPAWN:SpawnFromStatic(HostStatic, SpawnIndex) +SPAWN:SpawnFromStatic(HostStatic, MinHeight, MaxHeight, SpawnIndex)
@@ -2533,6 +2539,18 @@ The static dropping or unloading the group.

  • +

    #number MinHeight : +(optional) The minimum height to spawn an airborne group into the zone.

    + +
    • +
  • + +

    #number MaxHeight : +(optional) The maximum height to spawn an airborne group into the zone.

    + +
    • +
  • +

    #number SpawnIndex : (optional) The index which group to spawn within the given zone.

    @@ -2553,13 +2571,24 @@ Nothing was spawned.

    • +

    Usage:

    + 
    
+  local SpawnStatic = STATIC:FindByName( StaticName )
+
+  -- Spawn from the static position at the height specified in the ME of the group template!
+  SpawnAirplanes:SpawnFromStatic( SpawnStatic )  
+  
+  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
+  SpawnAirplanes:SpawnFromStatic( SpawnStatic, 2000, 4000 )  
+
    +
    -SPAWN:SpawnFromUnit(HostUnit, SpawnIndex) +SPAWN:SpawnFromUnit(HostUnit, MinHeight, MaxHeight, SpawnIndex)
    @@ -2581,6 +2610,18 @@ The air or ground unit dropping or unloading the group.

  • +

    #number MinHeight : +(optional) The minimum height to spawn an airborne group into the zone.

    + +
    • +
  • + +

    #number MaxHeight : +(optional) The maximum height to spawn an airborne group into the zone.

    + +
    • +
  • +

    #number SpawnIndex : (optional) The index which group to spawn within the given zone.

    @@ -2601,13 +2642,24 @@ Nothing was spawned.

    • +

    Usage:

    + 
    
+  local SpawnStatic = STATIC:FindByName( StaticName )
+
+  -- Spawn from the static position at the height specified in the ME of the group template!
+  SpawnAirplanes:SpawnFromUnit( SpawnStatic )  
+  
+  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
+  SpawnAirplanes:SpawnFromUnit( SpawnStatic, 2000, 4000 )  
+
    +
    -SPAWN:SpawnFromVec2(Vec2, SpawnIndex) +SPAWN:SpawnFromVec2(Vec2, MinHeight, MaxHeight, SpawnIndex)
    @@ -2629,6 +2681,18 @@ The Vec2 coordinates where to spawn the group.

  • +

    #number MinHeight : +(optional) The minimum height to spawn an airborne group into the zone.

    + +
    • +
  • + +

    #number MaxHeight : +(optional) The maximum height to spawn an airborne group into the zone.

    + +
    • +
  • +

    #number SpawnIndex : (optional) The index which group to spawn within the given zone.

    @@ -2649,6 +2713,17 @@ Nothing was spawned.

    • +

    Usage:

    + 
    
+  local SpawnVec2 = ZONE:New( ZoneName ):GetVec2()
+
+  -- Spawn at the zone center position at the height specified in the ME of the group template!
+  SpawnAirplanes:SpawnFromVec2( SpawnVec2 )  
+  
+  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
+  SpawnAirplanes:SpawnFromVec2( SpawnVec2, 2000, 4000 )  
+
    +
    @@ -2806,7 +2881,7 @@ SpawnGroupName

    -SPAWN:SpawnInZone(Zone, RandomizeGroup, SpawnIndex) +SPAWN:SpawnInZone(Zone, RandomizeGroup, MinHeight, MaxHeight, SpawnIndex)
    @@ -2834,6 +2909,18 @@ The zone where the group is to be spawned.

  • +

    #number MinHeight : +(optional) The minimum height to spawn an airborne group into the zone.

    + +
    • +
  • + +

    #number MaxHeight : +(optional) The maximum height to spawn an airborne group into the zone.

    + +
    • +
  • +

    #number SpawnIndex : (optional) The index which group to spawn within the given zone.

    @@ -2854,6 +2941,26 @@ when nothing was spawned.

    • +

    Usage:

    + 
    
+  local SpawnZone = ZONE:New( ZoneName )
+
+  -- Spawn at the zone center position at the height specified in the ME of the group template!
+  SpawnAirplanes:SpawnFromZone( SpawnZone )  
+  
+  -- Spawn in the zone at a random position at the height specified in the Me of the group template.
+  SpawnAirplanes:SpawnFromZone( SpawnZone, true )  
+  
+  -- Spawn in the zone at a random position at the height randomized between 2000 and 4000 meters.
+  SpawnAirplanes:SpawnFromUnit( SpawnZone, true, 2000, 4000 )  
+
+  -- Spawn at the zone center position at the height randomized between 2000 and 4000 meters.
+  SpawnAirplanes:SpawnFromUnit( SpawnZone, false, 2000, 4000 )  
+  
+  -- Spawn at the zone center position at the height randomized between 2000 and 4000 meters.
+  SpawnAirplanes:SpawnFromUnit( SpawnZone, nil, 2000, 4000 )  
+
    +
    @@ -3276,7 +3383,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
    - #boolean + SPAWN.SpawnUnControlled @@ -3880,6 +3987,20 @@ True = Continue Scheduler

    + +
    +
    +
    + + + +SPAWN.uncontrolled + +
    +
    + + +
    diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html index d6706e2ed..2ca8c13de 100644 --- a/docs/Documentation/Spot.html +++ b/docs/Documentation/Spot.html @@ -775,6 +775,7 @@ true if it is lasing

    + SPOT.ScheduleID @@ -788,6 +789,7 @@ true if it is lasing

    + SPOT.SpotIR @@ -801,6 +803,7 @@ true if it is lasing

    + SPOT.SpotLaser @@ -814,6 +817,7 @@ true if it is lasing

    + SPOT.Target diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index 968104c7e..1a964bad5 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -562,7 +562,7 @@ based on the tasking capabilities defined in Task#TA
    - Core.Cargo#CARGO + FSM_PROCESS.Cargo @@ -576,7 +576,6 @@ based on the tasking capabilities defined in Task#TA
    - FSM_PROCESS.DeployZone diff --git a/docs/Documentation/ZoneGoal.html b/docs/Documentation/ZoneGoal.html index 8120d650d..cd85537f6 100644 --- a/docs/Documentation/ZoneGoal.html +++ b/docs/Documentation/ZoneGoal.html @@ -489,6 +489,7 @@ The name of the player.

    + ZONE_GOAL.SmokeTime @@ -497,6 +498,9 @@ The name of the player.

    + +

    self.SmokeColor = nil

    +