diff --git a/Moose Development/Moose/Core/Velocity.lua b/Moose Development/Moose/Core/Velocity.lua index 333ad0f88..964d67577 100644 --- a/Moose Development/Moose/Core/Velocity.lua +++ b/Moose Development/Moose/Core/Velocity.lua @@ -7,7 +7,7 @@ -- -- ==== -- --- @module Base +-- @module Velocity do -- Velocity diff --git a/docs/Documentation/AI_A2A.html b/docs/Documentation/AI_A2A.html index 5e103cb10..5849fab1f 100644 --- a/docs/Documentation/AI_A2A.html +++ b/docs/Documentation/AI_A2A.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/AI_A2A_Cap.html b/docs/Documentation/AI_A2A_Cap.html index 1214e389c..2a8471e1f 100644 --- a/docs/Documentation/AI_A2A_Cap.html +++ b/docs/Documentation/AI_A2A_Cap.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/AI_A2A_Dispatcher.html b/docs/Documentation/AI_A2A_Dispatcher.html index 28847ec95..269af1489 100644 --- a/docs/Documentation/AI_A2A_Dispatcher.html +++ b/docs/Documentation/AI_A2A_Dispatcher.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/AI_A2A_GCI.html b/docs/Documentation/AI_A2A_GCI.html index 358950dbe..6541c5258 100644 --- a/docs/Documentation/AI_A2A_GCI.html +++ b/docs/Documentation/AI_A2A_GCI.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/AI_A2A_Patrol.html b/docs/Documentation/AI_A2A_Patrol.html index 2f9ca1713..4c7a43bc0 100644 --- a/docs/Documentation/AI_A2A_Patrol.html +++ b/docs/Documentation/AI_A2A_Patrol.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/AI_BAI.html b/docs/Documentation/AI_BAI.html index db7f6d7b2..ae56eb113 100644 --- a/docs/Documentation/AI_BAI.html +++ b/docs/Documentation/AI_BAI.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/AI_Balancer.html b/docs/Documentation/AI_Balancer.html index b86c9b795..c49d9921a 100644 --- a/docs/Documentation/AI_Balancer.html +++ b/docs/Documentation/AI_Balancer.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/AI_Cap.html b/docs/Documentation/AI_Cap.html index 51e1f251d..02c5864e9 100644 --- a/docs/Documentation/AI_Cap.html +++ b/docs/Documentation/AI_Cap.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/AI_Cas.html b/docs/Documentation/AI_Cas.html index f5c68b456..9d3885963 100644 --- a/docs/Documentation/AI_Cas.html +++ b/docs/Documentation/AI_Cas.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/AI_Formation.html b/docs/Documentation/AI_Formation.html index 448e249c7..790f66235 100644 --- a/docs/Documentation/AI_Formation.html +++ b/docs/Documentation/AI_Formation.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html index 004acc069..9e1850d93 100644 --- a/docs/Documentation/AI_Patrol.html +++ b/docs/Documentation/AI_Patrol.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/ATC_Ground.html b/docs/Documentation/ATC_Ground.html index 81ff95eae..7ae6c9afc 100644 --- a/docs/Documentation/ATC_Ground.html +++ b/docs/Documentation/ATC_Ground.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Account.html b/docs/Documentation/Account.html index 9f3fd9603..6f60d4cb1 100644 --- a/docs/Documentation/Account.html +++ b/docs/Documentation/Account.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Airbase.html b/docs/Documentation/Airbase.html index a95339f80..fa6abc332 100644 --- a/docs/Documentation/Airbase.html +++ b/docs/Documentation/Airbase.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Assign.html b/docs/Documentation/Assign.html index 7e288992b..c49fd73d2 100644 --- a/docs/Documentation/Assign.html +++ b/docs/Documentation/Assign.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Base.html b/docs/Documentation/Base.html index 40149e468..1d8f7889f 100644 --- a/docs/Documentation/Base.html +++ b/docs/Documentation/Base.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • @@ -115,9 +116,12 @@

    Module Base

    -

    Core -- VELOCITY models a speed, which can be expressed in various formats according the Settings.

    +

    Core -- BASE forms the basis of the MOOSE framework.

    +

    Each class within the MOOSE framework derives from BASE.

    + +

    Banner Image

    @@ -130,126 +134,435 @@

    Global(s)

    - + - +
    VELOCITYBASE -

    VELOCITY class, extends Base#BASE

    +

    1) #BASE class

    -

    VELOCITY models a speed, which can be expressed in various formats according the Settings.

    +

    All classes within the MOOSE framework are derived from the BASE class.
    VELOCITY_POSITIONABLEFORMATION -

    VELOCITY_POSITIONABLE class, extends Base#BASE

    -

    VELOCITY_POSITIONABLE monitors the speed of an Positionable in the simulation, which can be expressed in various formats according the Settings.
    -

    Type VELOCITY

    +

    Type BASE

    - + - + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    VELOCITY:Get()BASE.ClassID -

    Get the velocity in Mps (meters per second).

    +

    The ID number of the class.
    VELOCITY:GetKmph()BASE.ClassName -

    Get the velocity in Kmph (kilometers per hour).

    +

    The name of the class.
    VELOCITY:GetMiph()BASE.ClassNameAndID -

    Get the velocity in Miph (miles per hour).

    +

    The name of the class concatenated with the ID number of the class.
    VELOCITY:GetText(Settings)BASE:ClearState(Object, StateName) -

    Get the velocity in text, according the player Settings.

    +
    VELOCITY:New(VelocityMps)BASE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) -

    VELOCITY Constructor.

    +

    Creation of a Birth Event.
    VELOCITY:Set(VelocityMps)BASE:CreateEventCrash(EventTime, Initiator) -

    Set the velocity in Mps (meters per second).

    +

    Creation of a Crash Event.
    VELOCITY:SetKmph(VelocityKmph)BASE:CreateEventTakeoff(EventTime, Initiator) -

    Set the velocity in Kmph (kilometers per hour).

    +

    Creation of a Takeoff Event.
    VELOCITY:SetMiph(VelocityMiph)BASE:E(Arguments) -

    Set the velocity in Miph (miles per hour).

    +

    Log an exception which will be traced always.
    VELOCITY:ToString(Controllable, Settings, VelocityGroup)BASE:EventDispatcher() -

    Get the velocity in text, according the player or default Settings.

    +

    Returns the event dispatcher
    VELOCITY.VelocityBASE:EventRemoveAll() +

    Remove all subscribed events

    +
    BASE:F(Arguments) +

    Trace a function call.

    +
    BASE:F2(Arguments) +

    Trace a function call level 2.

    +
    BASE:F3(Arguments) +

    Trace a function call level 3.

    +
    BASE:GetClassID() +

    Get the ClassID of the class instance.

    +
    BASE:GetClassName() +

    Get the ClassName of the class instance.

    +
    BASE:GetClassNameAndID() +

    Get the ClassName + ClassID of the class instance.

    +
    BASE:GetEventPriority() +

    Get the Class Event processing Priority.

    +
    BASE:GetParent(Child, FromClass) +

    This is the worker method to retrieve the Parent class.

    +
    BASE:GetState(Object, Key) +

    Get a Value given a Key from the Object.

    +
    BASE:HandleEvent(Event, EventFunction) +

    Subscribe to a DCS Event.

    +
    BASE:Inherit(Child, Parent) +

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

    +
    BASE:IsInstanceOf(ClassName) +

    This is the worker method to check if an object is an (sub)instance of a class.

    +
    BASE:IsTrace() +

    Enquires if tracing is on (for the class).

    +
    BASE:New() +

    BASE constructor.

    +
    BASE:OnEvent(EventData) +

    Occurs when an object is completely destroyed.

    +
    BASE:OnEventBaseCaptured(EventData) +

    Occurs when a ground unit captures either an airbase or a farp.

    +
    BASE:OnEventBirth(EventData) +

    Occurs when any object is spawned into the mission.

    +
    BASE:OnEventCrash(EventData) +

    Occurs when any aircraft crashes into the ground and is completely destroyed.

    +
    BASE:OnEventDead(EventData) +

    Occurs when an object is dead.

    +
    BASE:OnEventEjection(EventData) +

    Occurs when a pilot ejects from an aircraft +initiator : The unit that has ejected

    +
    BASE:OnEventEngineShutdown(EventData) +

    Occurs when any aircraft shuts down its engines.

    +
    BASE:OnEventEngineStartup(EventData) +

    Occurs when any aircraft starts its engines.

    +
    BASE:OnEventHit(EventData) +

    Occurs whenever an object is hit by a weapon.

    +
    BASE:OnEventHumanFailure(EventData) +

    Occurs when any system fails on a human controlled aircraft.

    +
    BASE:OnEventLand(EventData) +

    Occurs when an aircraft lands at an airbase, farp or ship +initiator : The unit that has landed +place: Object that the unit landed on.

    +
    BASE:OnEventMissionEnd(EventData) +

    Occurs when a mission ends

    +
    BASE:OnEventMissionStart(EventData) +

    Occurs when a mission starts

    +
    BASE:OnEventPilotDead(EventData) +

    Occurs when the pilot of an aircraft is killed.

    +
    BASE:OnEventPlayerEnterUnit(EventData) +

    Occurs when any player assumes direct control of a unit.

    +
    BASE:OnEventPlayerLeaveUnit(EventData) +

    Occurs when any player relieves control of a unit to the AI.

    +
    BASE:OnEventRefueling(EventData) +

    Occurs when an aircraft connects with a tanker and begins taking on fuel.

    +
    BASE:OnEventRefuelingStop(EventData) +

    Occurs when an aircraft is finished taking fuel.

    +
    BASE:OnEventShootingEnd(EventData) +

    Occurs when any unit stops firing its weapon.

    +
    BASE:OnEventShootingStart(EventData) +

    Occurs when any unit begins firing a weapon that has a high rate of fire.

    +
    BASE:OnEventShot(EventData) +

    Occurs whenever any unit in a mission fires a weapon.

    +
    BASE:OnEventTakeoff(EventData) +

    Occurs when an aircraft takes off from an airbase, farp, or ship.

    +
    BASE:ScheduleOnce(Start, SchedulerFunction, ...) +

    Schedule a new time event.

    +
    BASE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) +

    Schedule a new time event.

    +
    BASE:ScheduleStop(SchedulerFunction) +

    Stops the Schedule.

    +
    BASE.SchedulerObject + +
    BASE:SetEventPriority(EventPriority) +

    Set the Class Event processing Priority.

    +
    BASE:SetState(Object, Key, Value) +

    Set a state or property of the Object given a Key and a Value.

    +
    BASE:T(Arguments) +

    Trace a function logic level 1.

    +
    BASE:T2(Arguments) +

    Trace a function logic level 2.

    +
    BASE:T3(Arguments) +

    Trace a function logic level 3.

    +
    BASE:TraceAll(TraceAll) +

    Trace all methods in MOOSE

    +
    BASE:TraceClass(Class) +

    Set tracing for a class

    +
    BASE:TraceClassMethod(Class, Method) +

    Set tracing for a specific method of class

    +
    BASE:TraceLevel(Level) +

    Set trace level

    +
    BASE:TraceOnOff(TraceOnOff) +

    Set trace on or off +Note that when trace is off, no debug statement is performed, increasing performance! +When Moose is loaded statically, (as one file), tracing is switched off by default.

    +
    BASE:UnHandleEvent(Event) +

    UnSubscribe to a DCS event.

    +
    BASE._ + +
    BASE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) +

    Trace a function call.

    +
    BASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) +

    Trace a function logic.

    +
    BASE.__ + +
    BASE:onEvent(event)
    -

    Type VELOCITY_POSITIONABLE

    +

    Type FORMATION

    - + - - - - - - - - - - - - - - - - - - - - - + @@ -260,375 +573,636 @@
    - #VELOCITY - -VELOCITY + #BASE + +BASE
    -

    VELOCITY class, extends Base#BASE

    +

    1) #BASE class

    -

    VELOCITY models a speed, which can be expressed in various formats according the Settings.

    +

    All classes within the MOOSE framework are derived from the BASE class.

    - -

    1. VELOCITY constructor

    +

    +BASE provides facilities for :

      -
    • VELOCITY.New(): Creates a new VELOCITY object.
      • +
    • The construction and inheritance of MOOSE classes.
      • +
    • The class naming and numbering system.
      • +
    • The class hierarchy search system.
      • +
    • The tracing of information or objects during mission execution for debuggin purposes.
      • +
    • The subscription to DCS events for event handling in MOOSE objects.
    +

    Note: The BASE class is an abstract class and is not meant to be used directly.

    + +

    1.1) BASE constructor

    + +

    Any class derived from BASE, will use the Base#BASE.New constructor embedded in the Base#BASE.Inherit method. +See an example at the Base#BASE.New method how this is done.

    + +

    1.2) Trace information for debugging

    + +

    The BASE class contains trace methods to trace progress within a mission execution of a certain object. +These trace methods are inherited by each MOOSE class interiting BASE, soeach object created from derived class from BASE can use the tracing methods to trace its execution.

    + +

    Any type of information can be passed to these tracing methods. See the following examples:

    + +
    self:E( "Hello" )
+
    + +

    Result in the word "Hello" in the dcs.log.

    + +
    local Array = { 1, nil, "h", { "a","b" }, "x" }
+self:E( Array )
+
    + +

    Results with the text [1]=1,[3]="h",[4]={[1]="a",[2]="b"},[5]="x"} in the dcs.log.

    + +
    local Object1 = "Object1"
+local Object2 = 3
+local Object3 = { Object 1, Object 2 }
+self:E( { Object1, Object2, Object3 } )
+
    + +

    Results with the text [1]={[1]="Object",[2]=3,[3]={[1]="Object",[2]=3}} in the dcs.log.

    + +
    local SpawnObject = SPAWN:New( "Plane" )
+local GroupObject = GROUP:FindByName( "Group" )
+self:E( { Spawn = SpawnObject, Group = GroupObject } )
+
    + +

    Results with the text [1]={Spawn={....),Group={...}} in the dcs.log.

    + +

    Below a more detailed explanation of the different method types for tracing.

    + +

    1.2.1) Tracing methods categories

    + +

    There are basically 3 types of tracing methods available:

    + +
      +
    • BASE.F: Used to trace the entrance of a function and its given parameters. An F is indicated at column 44 in the DCS.log file.
      • +
    • BASE.T: Used to trace further logic within a function giving optional variables or parameters. A T is indicated at column 44 in the DCS.log file.
      • +
    • BASE.E: Used to always trace information giving optional variables or parameters. An E is indicated at column 44 in the DCS.log file.
      • +
    + +

    1.2.2) Tracing levels

    + +

    There are 3 tracing levels within MOOSE.
    +These tracing levels were defined to avoid bulks of tracing to be generated by lots of objects.

    + +

    As such, the F and T methods have additional variants to trace level 2 and 3 respectively:

    + +
      +
    • BASE.F2: Trace the beginning of a function and its given parameters with tracing level 2.
      • +
    • BASE.F3: Trace the beginning of a function and its given parameters with tracing level 3.
      • +
    • BASE.T2: Trace further logic within a function giving optional variables or parameters with tracing level 2.
      • +
    • BASE.T3: Trace further logic within a function giving optional variables or parameters with tracing level 3.
      • +
    + +

    1.2.3) Trace activation.

    + +

    Tracing can be activated in several ways:

    + +
      +
    • Switch tracing on or off through the BASE.TraceOnOff() method.
      • +
    • Activate all tracing through the BASE.TraceAll() method.
      • +
    • Activate only the tracing of a certain class (name) through the BASE.TraceClass() method.
      • +
    • Activate only the tracing of a certain method of a certain class through the BASE.TraceClassMethod() method.
      • +
    • Activate only the tracing of a certain level through the BASE.TraceLevel() method.
      • +
    + +

    1.2.4) Check if tracing is on.

    + +

    The method BASE.IsTrace() will validate if tracing is activated or not.

    + +

    1.3 DCS simulator Event Handling

    + +

    The BASE class provides methods to catch DCS Events. These are events that are triggered from within the DCS simulator, +and handled through lua scripting. MOOSE provides an encapsulation to handle these events more efficiently.

    + +

    1.3.1 Subscribe / Unsubscribe to DCS Events

    + +

    At first, the mission designer will need to Subscribe to a specific DCS event for the class. +So, when the DCS event occurs, the class will be notified of that event. +There are two methods which you use to subscribe to or unsubscribe from an event.

    + + + +

    1.3.2 Event Handling of DCS Events

    + +

    Once the class is subscribed to the event, an Event Handling method on the object or class needs to be written that will be called +when the DCS event occurs. The Event Handling method receives an Event#EVENTDATA structure, which contains a lot of information +about the event that occurred.

    + +

    Find below an example of the prototype how to write an event handling function for two units:

    + +
     local Tank1 = UNIT:FindByName( "Tank A" )
+ local Tank2 = UNIT:FindByName( "Tank B" )
+
+ -- Here we subscribe to the Dead events. So, if one of these tanks dies, the Tank1 or Tank2 objects will be notified.
+ Tank1:HandleEvent( EVENTS.Dead )
+ Tank2:HandleEvent( EVENTS.Dead )
+
+ --- This function is an Event Handling function that will be called when Tank1 is Dead.
+ -- @param Wrapper.Unit#UNIT self 
+ -- @param Core.Event#EVENTDATA EventData
+ function Tank1:OnEventDead( EventData )
+
+   self:SmokeGreen()
+ end
+
+ --- This function is an Event Handling function that will be called when Tank2 is Dead.
+ -- @param Wrapper.Unit#UNIT self 
+ -- @param Core.Event#EVENTDATA EventData
+ function Tank2:OnEventDead( EventData )
+
+   self:SmokeBlue()
+ end
+
    + + + +

    See the Event module for more information about event handling.

    + +

    1.4) Class identification methods

    + +

    BASE provides methods to get more information of each object:

    + +
      +
    • BASE.GetClassID(): Gets the ID (number) of the object. Each object created is assigned a number, that is incremented by one.
      • +
    • BASE.GetClassName(): Gets the name of the object, which is the name of the class the object was instantiated from.
      • +
    • BASE.GetClassNameAndID(): Gets the name and ID of the object.
      • +
    + +

    1.5) All objects derived from BASE can have "States"

    + +

    A mechanism is in place in MOOSE, that allows to let the objects administer states.
    +States are essentially properties of objects, which are identified by a Key and a Value.

    + +

    The method BASE.SetState() can be used to set a Value with a reference Key to the object.
    +To read or retrieve a state Value based on a Key, use the BASE.GetState method.

    + +

    These two methods provide a very handy way to keep state at long lasting processes. +Values can be stored within the objects, and later retrieved or changed when needed. +There is one other important thing to note, the BASE.SetState() and BASE.GetState methods +receive as the first parameter the object for which the state needs to be set. +Thus, if the state is to be set for the same object as the object for which the method is used, then provide the same +object name to the method.

    + +

    1.10) Inheritance

    + +

    The following methods are available to implement inheritance

    + +
      +
    • BASE.Inherit: Inherits from a class.
      • +
    • BASE.GetParent: Returns the parent object from the object it is handling, or nil if there is no parent object.
      • +
    + +
    +
    - #VELOCITY_POSITIONABLE - -VELOCITY_POSITIONABLE + #FORMATION + +FORMATION
    -

    VELOCITY_POSITIONABLE class, extends Base#BASE

    - -

    VELOCITY_POSITIONABLE monitors the speed of an Positionable in the simulation, which can be expressed in various formats according the Settings.

    - - - -

    1. VELOCITY_POSITIONABLE constructor

    - -

    Type Base

    -

    Type VELOCITY

    +

    Type BASE

    Field(s)

    - -VELOCITY:Get() + +BASE.ClassID
    -

    Get the velocity in Mps (meters per second).

    - -

    Return value

    - -

    #number: -The velocity in meters per second.

    +

    The ID number of the class.

    - -VELOCITY:GetKmph() + +BASE.ClassName
    -

    Get the velocity in Kmph (kilometers per hour).

    - -

    Return value

    - -

    #number: -The velocity in kilometers per hour.

    +

    The name of the class.

    - -VELOCITY:GetMiph() + +BASE.ClassNameAndID
    -

    Get the velocity in Miph (miles per hour).

    - -

    Return value

    - -

    #number: -The velocity in miles per hour.

    +

    The name of the class concatenated with the ID number of the class.

    - -VELOCITY:GetText(Settings) + +BASE:ClearState(Object, StateName)
    -

    Get the velocity in text, according the player Settings.

    -

    Parameter

    - -

    Return value

    - -

    #string: -The velocity in text.

    - -
    -
    -
    -
    - - -VELOCITY:New(VelocityMps) - -
    -
    - -

    VELOCITY Constructor.

    - -

    Parameter

    -
      -
    • - -

      #number VelocityMps : -The velocity in meters per second.

      - -
      • -
    -

    Return value

    - -

    #VELOCITY:

    - - -
    -
    -
    -
    - - -VELOCITY:Set(VelocityMps) - -
    -
    - -

    Set the velocity in Mps (meters per second).

    - -

    Parameter

    -
      -
    • - -

      #number VelocityMps : -The velocity in meters per second.

      - -
      • -
    -

    Return value

    - -

    #VELOCITY:

    - - -
    -
    -
    -
    - - -VELOCITY:SetKmph(VelocityKmph) - -
    -
    - -

    Set the velocity in Kmph (kilometers per hour).

    - -

    Parameter

    -
      -
    • - -

      #number VelocityKmph : -The velocity in kilometers per hour.

      - -
      • -
    -

    Return value

    - -

    #VELOCITY:

    - - -
    -
    -
    -
    - - -VELOCITY:SetMiph(VelocityMiph) - -
    -
    - -

    Set the velocity in Miph (miles per hour).

    - -

    Parameter

    -
      -
    • - -

      #number VelocityMiph : -The velocity in miles per hour.

      - -
      • -
    -

    Return value

    - -

    #VELOCITY:

    - - -
    -
    -
    -
    - - -VELOCITY:ToString(Controllable, Settings, VelocityGroup) - -
    -
    - -

    Get the velocity in text, according the player or default Settings.

    Parameters

    -

    Return value

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

    Creation of a Birth Event.

    + +

    Parameters

    +
      +
    • -

      #string: -The velocity in text according the player or default Settings

      +

      Dcs.DCSTypes#Time EventTime : +The time stamp of the event.

      -
    -
    -
    -
    - - - -VELOCITY.Velocity - -
    -
    - - - -
    -
    - -

    Type VELOCITY_POSITIONABLE

    -

    Field(s)

    -
    -
    - - -VELOCITY_POSITIONABLE:Get() - -
    -
    - -

    Get the velocity in Mps (meters per second).

    - -

    Return value

    + +
  • -

    #number: -The velocity in meters per second.

    +

    Dcs.DCSWrapper.Object#Object Initiator : +The initiating object of the event.

    -
    • -
    -
    -
    - - -VELOCITY_POSITIONABLE:GetKmph() - -
    -
    - -

    Get the velocity in Kmph (kilometers per hour).

    - -

    Return value

    + +
  • -

    #number: -The velocity in kilometers per hour.

    +

    #string IniUnitName : +The initiating unit name.

    -
    • -
    -
    -
    - - -VELOCITY_POSITIONABLE:GetMiph() - -
    -
    - -

    Get the velocity in Miph (miles per hour).

    - -

    Return value

    + +
  • -

    #number: -The velocity in miles per hour.

    +

    place :

    +
    • +
  • + +

    subplace :

    + +
    • +
    - -VELOCITY_POSITIONABLE:New(Positionable) + +BASE:CreateEventCrash(EventTime, Initiator)
    -

    VELOCITY_POSITIONABLE Constructor.

    +

    Creation of a Crash Event.

    + +

    Parameters

    + +
    +
    +
    +
    + + +BASE:CreateEventTakeoff(EventTime, Initiator) + +
    +
    + +

    Creation of a Takeoff Event.

    + +

    Parameters

    + +
    +
    +
    +
    + + +BASE:E(Arguments) + +
    +
    + +

    Log an exception which will be traced always.

    + + +

    Can be anywhere within the function logic.

    Parameter

    +
    +
    +
    +
    + + +BASE:EventDispatcher() + +
    +
    + +

    Returns the event dispatcher

    + +

    Return value

    + +

    Core.Event#EVENT:

    + + +
    +
    +
    +
    + + +BASE:EventRemoveAll() + +
    +
    + +

    Remove all subscribed events

    + +

    Return value

    + +

    #BASE:

    + + +
    +
    +
    +
    + + +BASE:F(Arguments) + +
    +
    + +

    Trace a function call.

    + + +

    Must be at the beginning of the function logic.

    + +

    Parameter

    +
      +
    • + +

      Arguments : +A #table or any field.

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

    Trace a function call level 2.

    + + +

    Must be at the beginning of the function logic.

    + +

    Parameter

    +
      +
    • + +

      Arguments : +A #table or any field.

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

    Trace a function call level 3.

    + + +

    Must be at the beginning of the function logic.

    + +

    Parameter

    +
      +
    • + +

      Arguments : +A #table or any field.

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

    Get the ClassID of the class instance.

    + +

    Return value

    + +

    #string: +The ClassID of the class instance.

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

    Get the ClassName of the class instance.

    + +

    Return value

    + +

    #string: +The ClassName of the class instance.

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

    Get the ClassName + ClassID of the class instance.

    + + +

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

    + +

    Return value

    + +

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

    + +
    +
    +
    +
    + + +BASE:GetEventPriority() + +
    +
    + +

    Get the Class Event processing Priority.

    + + +

    The Event processing Priority is a number from 1 to 10, +reflecting the order of the classes subscribed to the Event to be processed.

    + +

    Return value

    + +

    #number: +The Event processing Priority.

    + +
    +
    +
    +
    + + +BASE:GetParent(Child, FromClass) + +
    +
    + +

    This is the worker method to retrieve the Parent class.

    + + +

    Note that the Parent class must be passed to call the parent class method.

    + +
    self:GetParent(self):ParentMethod()
+
+
+
    + +

    Parameters

    +
      +
    • + +

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

      + +
      • +
    • + +

      FromClass :

    Return value

    -

    #VELOCITY_POSITIONABLE:

    +

    #BASE:

    @@ -636,13 +1210,67 @@ The Positionable to monitor the speed.

    - - -VELOCITY_POSITIONABLE.Positionable + +BASE:GetState(Object, Key)
    +

    Get a Value given a Key from the Object.

    + + +

    Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

    + +

    Parameters

    +
      +
    • + +

      Object : +The object that holds the Value set by the Key.

      + +
      • +
    • + +

      Key : +The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

      + +
      • +
    +

    Return value

    + + +

    The Value retrieved.

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

    Subscribe to a DCS Event.

    + +

    Parameters

    +
      +
    • + +

      Core.Event#EVENTS Event :

      + +
      • +
    • + +

      #function EventFunction : +(optional) The function to be called when the event occurs for the unit.

      + +
      • +
    +

    Return value

    + +

    #BASE:

    @@ -650,27 +1278,1273 @@ The Positionable to monitor the speed.

    - -VELOCITY_POSITIONABLE:ToString() + +BASE:Inherit(Child, Parent)
    -

    Get the velocity in text, according the player or default Settings.

    +

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

    + +

    Parameters

    +
      +
    • + +

      Child : +is the Child class that inherits.

      + +
      • +
    • + +

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

      + +
      • +
    +

    Return value

    + +

    #BASE: +Child

    + +
    +
    +
    +
    + + +BASE:IsInstanceOf(ClassName) + +
    +
    + +

    This is the worker method to check if an object is an (sub)instance of a class.

    + + + +

    Examples:

    + +
      +

    • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

      • +

    • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

      • +

    • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

      • +

    • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

      • +

    • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

      • +
    + + +

    Parameter

    +
      +
    • + +

      ClassName : +is the name of the class or the class itself to run the check against

      + +
      • +
    +

    Return value

    + +

    #boolean:

    + + +
    +
    +
    +
    + + +BASE:IsTrace() + +
    +
    + +

    Enquires if tracing is on (for the class).

    Return value

    -

    #string: -The velocity in text according the player or default Settings

    +

    #boolean:

    + +
    +
    +
    +
    + + +BASE:New() + +
    +
    + +

    BASE constructor.

    + + + +

    This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

    + +
    function EVENT:New()
+  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
+  return self
+end
+  
+
    + +

    Return value

    + +

    #BASE:

    + + +
    +
    +
    +
    + + +BASE:OnEvent(EventData) + +
    +
    + +

    Occurs when an object is completely destroyed.

    + + +

    initiator : The unit that is was destroyed.

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventBaseCaptured(EventData) + +
    +
    + +

    Occurs when a ground unit captures either an airbase or a farp.

    + + +

    initiator : The unit that captured the base +place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventBirth(EventData) + +
    +
    + +

    Occurs when any object is spawned into the mission.

    + + +

    initiator : The unit that was spawned

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventCrash(EventData) + +
    +
    + +

    Occurs when any aircraft crashes into the ground and is completely destroyed.

    + + +

    initiator : The unit that has crashed

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventDead(EventData) + +
    +
    + +

    Occurs when an object is dead.

    + + +

    initiator : The unit that is dead.

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventEjection(EventData) + +
    +
    + +

    Occurs when a pilot ejects from an aircraft +initiator : The unit that has ejected

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventEngineShutdown(EventData) + +
    +
    + +

    Occurs when any aircraft shuts down its engines.

    + + +

    initiator : The unit that is stopping its engines.

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventEngineStartup(EventData) + +
    +
    + +

    Occurs when any aircraft starts its engines.

    + + +

    initiator : The unit that is starting its engines.

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventHit(EventData) + +
    +
    + +

    Occurs whenever an object is hit by a weapon.

    + + +

    initiator : The unit object the fired the weapon +weapon: Weapon object that hit the target +target: The Object that was hit.

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventHumanFailure(EventData) + +
    +
    + +

    Occurs when any system fails on a human controlled aircraft.

    + + +

    initiator : The unit that had the failure

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventLand(EventData) + +
    +
    + +

    Occurs when an aircraft lands at an airbase, farp or ship +initiator : The unit that has landed +place: Object that the unit landed on.

    + + +

    Can be an Airbase Object, FARP, or Ships

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventMissionEnd(EventData) + +
    +
    + +

    Occurs when a mission ends

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventMissionStart(EventData) + +
    +
    + +

    Occurs when a mission starts

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventPilotDead(EventData) + +
    +
    + +

    Occurs when the pilot of an aircraft is killed.

    + + +

    Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. +initiator : The unit that the pilot has died in.

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventPlayerEnterUnit(EventData) + +
    +
    + +

    Occurs when any player assumes direct control of a unit.

    + + +

    initiator : The unit that is being taken control of.

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventPlayerLeaveUnit(EventData) + +
    +
    + +

    Occurs when any player relieves control of a unit to the AI.

    + + +

    initiator : The unit that the player left.

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventRefueling(EventData) + +
    +
    + +

    Occurs when an aircraft connects with a tanker and begins taking on fuel.

    + + +

    initiator : The unit that is receiving fuel.

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventRefuelingStop(EventData) + +
    +
    + +

    Occurs when an aircraft is finished taking fuel.

    + + +

    initiator : The unit that was receiving fuel.

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventShootingEnd(EventData) + +
    +
    + +

    Occurs when any unit stops firing its weapon.

    + + +

    Event will always correspond with a shooting start event. +initiator : The unit that was doing the shooing.

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventShootingStart(EventData) + +
    +
    + +

    Occurs when any unit begins firing a weapon that has a high rate of fire.

    + + +

    Most common with aircraft cannons (GAU-8), autocannons, and machine guns. +initiator : The unit that is doing the shooing. +target: The unit that is being targeted.

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventShot(EventData) + +
    +
    + +

    Occurs whenever any unit in a mission fires a weapon.

    + + +

    But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:OnEventTakeoff(EventData) + +
    +
    + +

    Occurs when an aircraft takes off from an airbase, farp, or ship.

    + + +

    initiator : The unit that tookoff +place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

    + +

    Parameter

    + +
    +
    +
    +
    + + +BASE:ScheduleOnce(Start, SchedulerFunction, ...) + +
    +
    + +

    Schedule a new time event.

    + + +

    Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

    + +

    Parameters

    +
      +
    • + +

      #number Start : +Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

      + +
      • +
    • + +

      #function SchedulerFunction : +The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

      + +
      • +
    • + +

      #table ... : +Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

      + +
      • +
    +

    Return value

    + +

    #number: +The ScheduleID of the planned schedule.

    + +
    +
    +
    +
    + + +BASE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) + +
    +
    + +

    Schedule a new time event.

    + + +

    Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

    + +

    Parameters

    +
      +
    • + +

      #number Start : +Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

      + +
      • +
    • + +

      #number Repeat : +Specifies the interval in seconds when the scheduler will call the event function.

      + +
      • +
    • + +

      #number RandomizeFactor : +Specifies a randomization factor between 0 and 1 to randomize the Repeat.

      + +
      • +
    • + +

      #number Stop : +Specifies the amount of seconds when the scheduler will be stopped.

      + +
      • +
    • + +

      #function SchedulerFunction : +The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

      + +
      • +
    • + +

      #table ... : +Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

      + +
      • +
    +

    Return value

    + +

    #number: +The ScheduleID of the planned schedule.

    + +
    +
    +
    +
    + + +BASE:ScheduleStop(SchedulerFunction) + +
    +
    + +

    Stops the Schedule.

    + +

    Parameter

    +
      +
    • + +

      #function SchedulerFunction : +The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

      + +
      • +
    - -VELOCITY_POSITIONABLE.Velocity + +BASE.SchedulerObject + +
    +
    + + + +
    +
    +
    +
    + + +BASE:SetEventPriority(EventPriority) + +
    +
    + +

    Set the Class Event processing Priority.

    + + +

    The Event processing Priority is a number from 1 to 10, +reflecting the order of the classes subscribed to the Event to be processed.

    + +

    Parameter

    +
      +
    • + +

      #number EventPriority : +The Event processing Priority.

      + +
      • +
    +

    Return value

    + + +

    self

    + +
    +
    +
    +
    + + +BASE:SetState(Object, Key, Value) + +
    +
    + +

    Set a state or property of the Object given a Key and a Value.

    + + +

    Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

    + +

    Parameters

    +
      +
    • + +

      Object : +The object that will hold the Value set by the Key.

      + +
      • +
    • + +

      Key : +The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

      + +
      • +
    • + +

      Value : +The value to is stored in the object.

      + +
      • +
    +

    Return values

    +
      +
    1. + + +

      The Value set.

      + +
      2. +
    2. + +

      #nil: +The Key was not found and thus the Value could not be retrieved.

      + +
      3. +
    +
    +
    +
    +
    + + +BASE:T(Arguments) + +
    +
    + +

    Trace a function logic level 1.

    + + +

    Can be anywhere within the function logic.

    + +

    Parameter

    +
      +
    • + +

      Arguments : +A #table or any field.

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

    Trace a function logic level 2.

    + + +

    Can be anywhere within the function logic.

    + +

    Parameter

    +
      +
    • + +

      Arguments : +A #table or any field.

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

    Trace a function logic level 3.

    + + +

    Can be anywhere within the function logic.

    + +

    Parameter

    +
      +
    • + +

      Arguments : +A #table or any field.

      + +
      • +
    +
    +
    +
    +
    + + +BASE:TraceAll(TraceAll) + +
    +
    + +

    Trace all methods in MOOSE

    + +

    Parameter

    +
      +
    • + +

      #boolean TraceAll : +true = trace all methods in MOOSE.

      + +
      • +
    +
    +
    +
    +
    + + +BASE:TraceClass(Class) + +
    +
    + +

    Set tracing for a class

    + +

    Parameter

    +
      +
    • + +

      #string Class :

      + +
      • +
    +
    +
    +
    +
    + + +BASE:TraceClassMethod(Class, Method) + +
    +
    + +

    Set tracing for a specific method of class

    + +

    Parameters

    +
      +
    • + +

      #string Class :

      + +
      • +
    • + +

      #string Method :

      + +
      • +
    +
    +
    +
    +
    + + +BASE:TraceLevel(Level) + +
    +
    + +

    Set trace level

    + +

    Parameter

    +
      +
    • + +

      #number Level :

      + +
      • +
    +
    +
    +
    +
    + + +BASE:TraceOnOff(TraceOnOff) + +
    +
    + +

    Set trace on or off +Note that when trace is off, no debug statement is performed, increasing performance! +When Moose is loaded statically, (as one file), tracing is switched off by default.

    + + +

    So tracing must be switched on manually in your mission if you are using Moose statically. +When moose is loading dynamically (for moose class development), tracing is switched on by default.

    + +

    Parameter

    +
      +
    • + +

      #boolean TraceOnOff : +Switch the tracing on or off.

      + +
      • +
    +

    Usage:

    + 
    -- Switch the tracing On
+BASE:TraceOnOff( true )
+
+-- Switch the tracing Off
+BASE:TraceOnOff( false )
    + +
    +
    +
    +
    + + +BASE:UnHandleEvent(Event) + +
    +
    + +

    UnSubscribe to a DCS event.

    + +

    Parameter

    + +

    Return value

    + +

    #BASE:

    + + +
    +
    +
    +
    + + #BASE._ + +BASE._ + +
    +
    + + + +
    +
    +
    +
    + + +BASE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) + +
    +
    + +

    Trace a function call.

    + + +

    This function is private.

    + +

    Parameters

    +
      +
    • + +

      Arguments : +A #table or any field.

      + +
      • +
    • + +

      DebugInfoCurrentParam :

      + +
      • +
    • + +

      DebugInfoFromParam :

      + +
      • +
    +
    +
    +
    +
    + + +BASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) + +
    +
    + +

    Trace a function logic.

    + +

    Parameters

    +
      +
    • + +

      Arguments : +A #table or any field.

      + +
      • +
    • + +

      DebugInfoCurrentParam :

      + +
      • +
    • + +

      DebugInfoFromParam :

      + +
      • +
    +
    +
    +
    +
    + + #BASE.__ + +BASE.__ + +
    +
    + + + +
    +
    +
    +
    + + +BASE:onEvent(event) + +
    +
    + + + + +

    TODO: Complete Dcs.DCSTypes#Event structure.
    +- The main event handling function... This function captures all events generated for the class. + @param #BASE self + @param Dcs.DCSTypes#Event event

    + +

    Parameter

    +
      +
    • + +

      event :

      + +
      • +
    +
    +
    + +

    Type BASE._

    + +

    Type BASE.__

    + +

    Type FORMATION

    + +

    The Formation Class

    + +

    Field(s)

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

    A cone formation.

    + +
    +
    +
    +
    + + #string + +FORMATION.Vee
    diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index 64107dd30..3e999b6de 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • @@ -3698,6 +3699,7 @@ The range till cargo will board.

    + CARGO_UNIT.CargoCarrier diff --git a/docs/Documentation/CleanUp.html b/docs/Documentation/CleanUp.html index b1b2ac62a..6338da226 100644 --- a/docs/Documentation/CleanUp.html +++ b/docs/Documentation/CleanUp.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Client.html b/docs/Documentation/Client.html index aab1424b1..4176d7720 100644 --- a/docs/Documentation/Client.html +++ b/docs/Documentation/Client.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/CommandCenter.html b/docs/Documentation/CommandCenter.html index 1644bb348..67b9ecc2d 100644 --- a/docs/Documentation/CommandCenter.html +++ b/docs/Documentation/CommandCenter.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Controllable.html b/docs/Documentation/Controllable.html index d73c8c8ed..4685c619d 100644 --- a/docs/Documentation/Controllable.html +++ b/docs/Documentation/Controllable.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • @@ -317,6 +318,24 @@
    + + + + + + + + + + + + @@ -1839,6 +1858,66 @@ self

    + +CONTROLLABLE:OptionAlarmStateAuto() + +
    +
    + +

    Alarm state to Auto: AI will automatically switch alarm states based on the presence of threats.

    + + +

    The AI kind of cheats in this regard.

    + +

    Return value

    + +

    #CONTROLLABLE: +self

    + +
    +
    +
    +
    + + +CONTROLLABLE:OptionAlarmStateGreen() + +
    +
    + +

    Alarm state to Green: Group is not combat ready.

    + + +

    Sensors are stowed if possible.

    + +

    Return value

    + +

    #CONTROLLABLE: +self

    + +
    +
    +
    +
    + + +CONTROLLABLE:OptionAlarmStateRed() + +
    +
    + +

    Alarm state to Red: Group is combat ready and actively searching for targets.

    + +

    Return value

    + +

    #CONTROLLABLE: +self

    + +
    +
    +
    +
    + CONTROLLABLE:OptionROEHoldFire() diff --git a/docs/Documentation/DCSAirbase.html b/docs/Documentation/DCSAirbase.html index 5ed931154..d3aa90a32 100644 --- a/docs/Documentation/DCSAirbase.html +++ b/docs/Documentation/DCSAirbase.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/DCSCoalitionObject.html b/docs/Documentation/DCSCoalitionObject.html index 1cc18d3ca..cb2fe508a 100644 --- a/docs/Documentation/DCSCoalitionObject.html +++ b/docs/Documentation/DCSCoalitionObject.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/DCSCommand.html b/docs/Documentation/DCSCommand.html index 56fbc15b4..c2776fc3f 100644 --- a/docs/Documentation/DCSCommand.html +++ b/docs/Documentation/DCSCommand.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/DCSController.html b/docs/Documentation/DCSController.html index 4b0c7a8f8..74d16e392 100644 --- a/docs/Documentation/DCSController.html +++ b/docs/Documentation/DCSController.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/DCSGroup.html b/docs/Documentation/DCSGroup.html index 8ba1a322a..4d9c33b69 100644 --- a/docs/Documentation/DCSGroup.html +++ b/docs/Documentation/DCSGroup.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/DCSObject.html b/docs/Documentation/DCSObject.html index 6b8cc219c..8d3b72e39 100644 --- a/docs/Documentation/DCSObject.html +++ b/docs/Documentation/DCSObject.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/DCSTask.html b/docs/Documentation/DCSTask.html index d28f90330..bbf5baa91 100644 --- a/docs/Documentation/DCSTask.html +++ b/docs/Documentation/DCSTask.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/DCSTypes.html b/docs/Documentation/DCSTypes.html index 4aceb5449..a336575bf 100644 --- a/docs/Documentation/DCSTypes.html +++ b/docs/Documentation/DCSTypes.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/DCSUnit.html b/docs/Documentation/DCSUnit.html index 97cd036e3..6cf730ebf 100644 --- a/docs/Documentation/DCSUnit.html +++ b/docs/Documentation/DCSUnit.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/DCSVec3.html b/docs/Documentation/DCSVec3.html index 23b90c24e..875ba7bf9 100644 --- a/docs/Documentation/DCSVec3.html +++ b/docs/Documentation/DCSVec3.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/DCSWorld.html b/docs/Documentation/DCSWorld.html index a5f7a1eff..b730818f6 100644 --- a/docs/Documentation/DCSWorld.html +++ b/docs/Documentation/DCSWorld.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/DCSZone.html b/docs/Documentation/DCSZone.html index 7371708d9..c3b6be5e4 100644 --- a/docs/Documentation/DCSZone.html +++ b/docs/Documentation/DCSZone.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/DCScountry.html b/docs/Documentation/DCScountry.html index dbe9e2ec5..79609db55 100644 --- a/docs/Documentation/DCScountry.html +++ b/docs/Documentation/DCScountry.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/DCStimer.html b/docs/Documentation/DCStimer.html index 10633000b..f0dabbc94 100644 --- a/docs/Documentation/DCStimer.html +++ b/docs/Documentation/DCStimer.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/DCStrigger.html b/docs/Documentation/DCStrigger.html index bf4138cc4..fb1d038f7 100644 --- a/docs/Documentation/DCStrigger.html +++ b/docs/Documentation/DCStrigger.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Database.html b/docs/Documentation/Database.html index c38cf0965..80ad67e61 100644 --- a/docs/Documentation/Database.html +++ b/docs/Documentation/Database.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html index 9c043bfc3..f300b7ef9 100644 --- a/docs/Documentation/Designate.html +++ b/docs/Documentation/Designate.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • @@ -1106,7 +1107,7 @@ function below will use the range 1-7 just in case

    - #number + DESIGNATE.LaseDuration diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index 86ba51e64..c98a2e46c 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • @@ -2469,6 +2470,7 @@ The index of the DetectedItem.

    + #number DETECTION_BASE.DetectedItemCount @@ -2482,6 +2484,7 @@ The index of the DetectedItem.

    + #number DETECTION_BASE.DetectedItemMax diff --git a/docs/Documentation/DetectionManager.html b/docs/Documentation/DetectionManager.html index c6925b26f..479a1e818 100644 --- a/docs/Documentation/DetectionManager.html +++ b/docs/Documentation/DetectionManager.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Escort.html b/docs/Documentation/Escort.html index ed1e59e36..82be3f758 100644 --- a/docs/Documentation/Escort.html +++ b/docs/Documentation/Escort.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Event.html b/docs/Documentation/Event.html index 5815c4b0b..a7aa2559b 100644 --- a/docs/Documentation/Event.html +++ b/docs/Documentation/Event.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index 9580fc0e5..de2949f53 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • @@ -1608,7 +1609,7 @@ A string defining the start state.

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

    - FSM.current diff --git a/docs/Documentation/Goal.html b/docs/Documentation/Goal.html index 8abc4cea2..2ce5c04d5 100644 --- a/docs/Documentation/Goal.html +++ b/docs/Documentation/Goal.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Group.html b/docs/Documentation/Group.html index e65161b18..2e87093a8 100644 --- a/docs/Documentation/Group.html +++ b/docs/Documentation/Group.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Identifiable.html b/docs/Documentation/Identifiable.html index f8de45c2b..b108c3bfe 100644 --- a/docs/Documentation/Identifiable.html +++ b/docs/Documentation/Identifiable.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Menu.html b/docs/Documentation/Menu.html index 0959f549b..aaed17afa 100644 --- a/docs/Documentation/Menu.html +++ b/docs/Documentation/Menu.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Message.html b/docs/Documentation/Message.html index 8a1d2ed4a..6077791d6 100644 --- a/docs/Documentation/Message.html +++ b/docs/Documentation/Message.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/MissileTrainer.html b/docs/Documentation/MissileTrainer.html index d11f1379b..eb2909293 100644 --- a/docs/Documentation/MissileTrainer.html +++ b/docs/Documentation/MissileTrainer.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Mission.html b/docs/Documentation/Mission.html index 68e86d20c..626416cef 100644 --- a/docs/Documentation/Mission.html +++ b/docs/Documentation/Mission.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Movement.html b/docs/Documentation/Movement.html index 0615a2d0a..c3c16e25c 100644 --- a/docs/Documentation/Movement.html +++ b/docs/Documentation/Movement.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Object.html b/docs/Documentation/Object.html index 921140d94..24b2ac418 100644 --- a/docs/Documentation/Object.html +++ b/docs/Documentation/Object.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html index 0d83bdc5d..71741434e 100644 --- a/docs/Documentation/Point.html +++ b/docs/Documentation/Point.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • @@ -3495,6 +3496,7 @@ The y coordinate.

    + POINT_VEC2.z diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html index 680f960e5..7b0f35730 100644 --- a/docs/Documentation/Positionable.html +++ b/docs/Documentation/Positionable.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Process_JTAC.html b/docs/Documentation/Process_JTAC.html index ebbff4b32..35e9a46df 100644 --- a/docs/Documentation/Process_JTAC.html +++ b/docs/Documentation/Process_JTAC.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Process_Pickup.html b/docs/Documentation/Process_Pickup.html index bba9b0bef..719b1ee9c 100644 --- a/docs/Documentation/Process_Pickup.html +++ b/docs/Documentation/Process_Pickup.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Protect.html b/docs/Documentation/Protect.html index f18d5d4bf..de7a57685 100644 --- a/docs/Documentation/Protect.html +++ b/docs/Documentation/Protect.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Radio.html b/docs/Documentation/Radio.html index f25c70d73..5db376990 100644 --- a/docs/Documentation/Radio.html +++ b/docs/Documentation/Radio.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Rat.html b/docs/Documentation/Rat.html index ab1e58bea..5d974235f 100644 --- a/docs/Documentation/Rat.html +++ b/docs/Documentation/Rat.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • @@ -198,18 +199,48 @@
    + + + + + + + + + + + + + + + + + + + + @@ -221,19 +252,25 @@ - + - + + + + + @@ -246,6 +283,12 @@ + + + + @@ -288,12 +331,42 @@ + + + + + + + + + + + + + + + + + + + + @@ -312,12 +385,54 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -351,7 +466,7 @@ - + @@ -369,9 +484,9 @@ - + @@ -381,25 +496,25 @@ - + - + - + - + @@ -432,6 +547,12 @@ + + + + @@ -449,7 +570,7 @@ @@ -479,7 +600,7 @@ @@ -491,13 +612,19 @@ + + + + @@ -564,12 +691,30 @@ + + + + + + + + + + + + @@ -630,18 +775,18 @@ - - - - + + + + @@ -657,15 +802,21 @@ - + - + + + + + @@ -711,13 +862,13 @@ - + - + @@ -753,7 +904,7 @@ - + @@ -771,7 +922,7 @@ - + @@ -783,9 +934,15 @@ - + + + + + @@ -795,9 +952,39 @@ - + + + + + + + + + + + + + + + + + + + + + @@ -893,13 +1080,7 @@ - - - - @@ -911,7 +1092,13 @@ + + + + @@ -924,6 +1111,12 @@ + + + + @@ -936,6 +1129,12 @@ + + + + @@ -966,24 +1165,48 @@ + + + + + + + + + + + + + + + + @@ -1008,6 +1231,12 @@ + + + + @@ -1020,6 +1249,18 @@ + + + + + + + + @@ -1044,12 +1285,24 @@ + + + + + + + + @@ -1062,18 +1315,66 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    VELOCITY_POSITIONABLE:Get()FORMATION.Cone -

    Get the velocity in Mps (meters per second).

    +

    A cone formation.
    VELOCITY_POSITIONABLE:GetKmph() -

    Get the velocity in Kmph (kilometers per hour).

    -
    VELOCITY_POSITIONABLE:GetMiph() -

    Get the velocity in Miph (miles per hour).

    -
    VELOCITY_POSITIONABLE:New(Positionable) -

    VELOCITY_POSITIONABLE Constructor.

    -
    VELOCITY_POSITIONABLE.Positionable - -
    VELOCITY_POSITIONABLE:ToString() -

    Get the velocity in text, according the player or default Settings.

    -
    VELOCITY_POSITIONABLE.VelocityFORMATION.Vee CONTROLLABLE:New(ControllableName)

    Create a new CONTROLLABLE from a DCSControllable

    +
    CONTROLLABLE:OptionAlarmStateAuto() +

    Alarm state to Auto: AI will automatically switch alarm states based on the presence of threats.

    +
    CONTROLLABLE:OptionAlarmStateGreen() +

    Alarm state to Green: Group is not combat ready.

    +
    CONTROLLABLE:OptionAlarmStateRed() +

    Alarm state to Red: Group is combat ready and actively searching for targets.
    RAT.ATC +
    RAT:ATC_Clearance(n) +

    Max number of planes that get landing clearance of the RAT ATC.

    +
    RAT:ATC_Delay(time) +

    Delay between granting landing clearance for simultanious landings.
    RAT.ATCswitch -

    Enable/disable ATC if set to true/false.

    +

    Enable/disable ATC if set to true/false.

    +
    RAT:AddFriendlyAirportsToDepartures() +

    Add all friendly airports to the list of possible departures.

    +
    RAT:AddFriendlyAirportsToDestinations() +

    Add all friendly airports to the list of possible destinations
    RAT.AlphaDescent

    Default angle of descenti in degrees. A value of 3.6 follows the 3:1 rule of 3 miles of travel and 1000 ft descent.

    +
    RAT:ChangeAircraft(actype) +

    Change aircraft type.
    RAT:ClearForLanding(name) - +

    Clear flight for landing.
    RAT:Commute(switch)RAT:Commute() -

    Aircraft will commute between their departure and destination airports.

    +

    Aircraft will commute between their departure and destination airports or zones.
    RAT:ContinueJourney(switch)RAT:ContinueJourney()

    Aircraft will continue their journey from their destination.

    +
    RAT:DestinationZone() +

    Destinations are treated as zones.
    RAT:ExcludedAirports(ports)

    Airports, FARPs and ships explicitly excluded as departures and destinations.

    +
    RAT.FLcruise +

    Cruise altitude of aircraft. Default FL200 for planes and F005 for helos.
    RAT:MenuName(name)

    Set the name of the F10 submenu.

    +
    RAT.Ndeparture_Airports +

    Number of departure airports set via SetDeparture().

    +
    RAT.Ndeparture_Zones +

    Number of departure zones set via SetDeparture.

    +
    RAT.Ndestination_Airports +

    Number of destination airports set via SetDestination().

    +
    RAT.Ndestination_Zones +

    Number of destination zones set via SetDestination().
    RAT:New(groupname, alias)

    Create a new RAT object.

    +
    RAT:NoRespawn() +

    Aircraft will not get respawned when they finished their route.
    RAT.ROT

    RAT reaction to threat.

    +
    RAT:RadioFrequency(frequency) +

    Set radio frequency.

    +
    RAT:RadioModulation(modulation) +

    Set radio modulation.

    +
    RAT:RadioOFF() +

    Disable Radio.

    +
    RAT:RadioON() +

    Enable Radio.
    RAT:RespawnAfterLanding(delay)

    Make aircraft respawn the moment they land rather than at engine shut down.

    +
    RAT:RespawnAfterTakeoff() +

    Aircraft will be respawned directly after take-off.

    +
    RAT:ReturnZone() +

    Aircraft will fly to a random point within a zone and then return to its departure airport or zone.

    +
    RAT:SetAISkill(skill) +

    Set skill of AI aircraft.
    RAT:SetDeparture(names)RAT:SetDeparture(departurenames)

    Set possible departure ports.
    RAT:SetDestination(names)RAT:SetDestination(destinationnames) -

    Set name of destination airport for the AI aircraft.

    +

    Set name of destination airports or zones for the AI aircraft.
    RAT:SetFL(height)RAT:SetFL(FL)

    Set flight level.
    RAT:SetFLcruise(height)RAT:SetFLcruise(FL)

    Set flight level of cruising part.
    RAT:SetFLmax(height)RAT:SetFLmax(FL)

    Set max flight level.
    RAT:SetFLmin(height)RAT:SetFLmin(FL)

    Set min flight level.

    		RAT:SetMinDistance(dist)

    Set minimum distance between departure and destination.

    +
    RAT:SetParkingID(id) +

    Set parking id of aircraft.
    RAT:SetSpawnDelay(delay) -

    Set the delay before first group is spawned.

    +

    Set the delay before first group is spawned.

    RAT:StatusReports(switch) -

    Aircraft report status messages.

    +

    Aircraft report status update messages along the route.
    RAT:TimeDestroyInactive(time) -

    Set the time after which inactive groups will be destroyed.

    +

    Set the time after which inactive groups will be destroyed.

    RAT.Tinactive

    Time in seconds after which inactive units will be destroyed. Default is 300 seconds.

    +
    RAT:Uncontrolled() +

    Spawn aircraft in uncontolled state.
    RAT:_ATCStatus()

    ATC status report about flights.

    +
    RAT:_AddFriendlyAirports(ports) +

    Add names of all friendly airports to possible departure or destination airports if they are not already in the list.

    RAT:_AirportExists(name)

    Test if an airport exists on the current map.

    +
    RAT:_AnticipatedGroupName(index) +

    Anticipated group name from alias and spawn index.

    +
    RAT:_CheckConsistency() +

    Function checks consistency of user input and automatically adjusts parameters if necessary.
    RAT:_GetAirportsOfMap()

    Get all airports of the current map.

    -
    RAT:_GetDestinations(departure, q, minrange, maxrange) -

    Get all possible destination airports depending on departure position.
    RAT:_GetLife(group)

    Get (relative) life of first unit of a group.

    +
    RAT:_Heading(course) +

    Determine the heading for an aircraft to be entered in the route template.
    RAT:_MinDistance(alpha, beta, h)RAT:_MinDistance(alpha, beta, ha, hb) -

    Calculate min distance between departure and destination for given minimum flight level and climb/decent rates

    +

    Calculate minimum distance between departure and destination for given minimum flight level and climb/decent rates.
    RAT:_ModifySpawnTemplate(waypoints)RAT:_ModifySpawnTemplate(waypoints, livery)

    Modifies the template of the group to be spawned.

    +
    RAT:_NameInList(liste, name) +

    Check if a name/string is in a list or not.
    RAT:_PickDestination(destinations, _random)RAT:_PickDestination(departure, q, minrange, maxrange, random, landing) -

    Pick destination airport.

    +

    Pick destination airport or zone depending on departure position.
    RAT:_PlaceMarkers(waypoints)RAT:_PlaceMarkers(waypoints, index)

    Place markers of the waypoints.
    RAT:_SetMarker(text, wp)RAT:_SetMarker(text, wp, index)

    Set a marker visible for all on the F10 map.
    RAT:_SetRoute(Takeoff, _departure, _destination, takeoff)RAT:_SetRoute(Takeoff, Landing, _departure, _destination, takeoff, landing, _waypoint)

    Set the route of the AI plane.
    RAT:_SpawnWithRoute(_departure, _destination)RAT:_SpawnWithRoute(_departure, _destination, _takeoff, _landing, _livery, _waypoint)

    Spawn the AI aircraft with a route.

    +
    RAT:_TaskFunction(FunctionString, ...) +

    Task function.
    RAT:_Waypoint(Type, Coord, Speed, Altitude, Airport)RAT:_Waypoint(Running, Type, Coord, Speed, Altitude, Airport, index)

    Create a waypoint that can be used with the Route command.

    +
    RAT._WaypointFunction(group, rat, wp) +

    Function which is called after passing every waypoint.

    +
    RAT:_ZoneExists(name) +

    Test if a trigger zone defined in the mission editor exists.

    +
    RAT.actype + +
    RAT.addfriendlydepartures +

    Add all friendly airports to departures.

    +
    RAT.addfriendlydestinations +

    Add all friendly airports to destinations.
    RAT.departure_ports -

    Array containing the names of the destination airports.

    -
    RAT.departure_zones -

    Array containing the names of the departure zones.

    +

    Array containing the names of the destination airports or zones.
    RAT.destination_ports -

    Array containing the names of the destination airports.

    +

    Array containing the names of the destination airports or zones.

    +
    RAT.destinationzone +

    Destination is a zone and not an airport.
    RAT.f10menu

    Add an F10 menu for RAT.

    +
    RAT.frequency +

    Radio frequency used by the RAT groups.
    RAT.id

    Some ID to identify who we are in output of the DCS.log file.

    +
    RAT.landing +

    Landing type. Determines if we actually land at an airport or treat it as zone.
    RAT.mindist

    Min distance from departure to destination in meters. Default 5 km.

    +
    RAT.modulation +

    Ratio modulation. Either "FM" or "AM".
    RAT.ngroups

    Number of groups to be spawned in total.

    +
    RAT.norespawn +

    Aircraft will not be respawned after they have finished their route.
    RAT.onboard_num +
    RAT.parking_id +

    String with a special parking ID for the aircraft.
    RAT.placemarkers

    Place markers of waypoints on F10 map.

    +
    RAT.radio +

    If true/false disables radio messages from the RAT groups.
    RAT.reportstatus

    Aircraft report status.

    +
    RAT.respawn_after_takeoff +

    Aircraft will be respawned directly after take-off.
    RAT.respawn_delay

    Delay in seconds until repawn happens after landing.

    +
    RAT.return_zones +

    Array containing the names of the return zones.

    +
    RAT.returnzone +

    Zone where aircraft will fly to before returning to their departure airport.
    RAT.spawndelay

    Delay time in seconds before first spawning happens.

    +
    RAT.spawninitialized +

    If RAT:Spawn() was already called this RAT object is set to true to prevent users to call it again.
    RAT.spawninterval

    Interval between spawning units/groups. Note that we add a randomization of 50%.

    +
    RAT.status +

    RAT aircraft status.
    RAT.takeoff

    Takeoff type. 0=coldorhot.

    +
    RAT.templategroup +

    Group serving as template for the RAT aircraft.

    +
    RAT.type + +
    RAT.uncontrolled +

    If true aircraft are spawned in uncontrolled state and will only sit on their parking spots.

    RAT.unit

    RAT unit conversions.

    +
    RAT.version +

    RAT version.

    +
    RAT.waypointdescriptions +

    Table with strings for waypoint descriptions of markers.

    +
    RAT.waypointstatus +

    Table with strings of waypoint status.
    RAT.wp

    RAT waypoint type.

    +
    RAT.wp_final +

    Index of the final waypoint.

    +
    RAT.wp_holding +

    Index of the holding waypoint.
    @@ -1277,6 +1578,56 @@ It is possible to restrict the minimum cruise altitude by +
    + + +RAT:ATC_Clearance(n) + +
    +
    + +

    Max number of planes that get landing clearance of the RAT ATC.

    + + +

    This setting effects all RAT objects and groups!

    + +

    Parameter

    + +
    + +
    +
    + + +RAT:ATC_Delay(time) + +
    +
    + +

    Delay between granting landing clearance for simultanious landings.

    + + +

    This setting effects all RAT objects and groups!

    + +

    Parameter

    +
      +
    • + +

      #number time : +Delay time when the next aircraft will get landing clearance event if the previous one did not land yet. Default is 240 sec.

      + +
      • +
    @@ -1289,7 +1640,33 @@ It is possible to restrict the minimum cruise altitude by +
    + + +RAT:AddFriendlyAirportsToDepartures() + +
    +
    + +

    Add all friendly airports to the list of possible departures.

    + +
    +
    +
    +
    + + +RAT:AddFriendlyAirportsToDestinations() + +
    +
    + +

    Add all friendly airports to the list of possible destinations

    @@ -1305,6 +1682,32 @@ It is possible to restrict the minimum cruise altitude by +
    + + +RAT:ChangeAircraft(actype) + +
    +
    + +

    Change aircraft type.

    + + +

    This is a dirty hack which allows to change the aircraft type of the template group. +Note that all parameters like cruise speed, climb rate, range etc are still taken from the template group which likely leads to strange behaviour.

    + +

    Parameter

    +
    @@ -1330,13 +1733,17 @@ It is possible to restrict the minimum cruise altitude by -RAT:Commute(switch) +RAT:Commute()
    -

    Aircraft will commute between their departure and destination airports.

    +

    Aircraft will commute between their departure and destination airports or zones.

    - -

    Note, this option is not available if aircraft are spawned in air since they don't have a valid departure airport to fly back to.

    - -

    Parameter

    -
      -
    • - -

      #boolean switch : -Turn commute on=true or off=false. If no value is given switch=true.

      - -
      • -
    -RAT:ContinueJourney(switch) +RAT:ContinueJourney()
    @@ -1381,15 +1776,22 @@ Turn commute on=true or off=false. If no value is given switch=true.

    This means they are respawned at their destination and get a new random destination.

    -

    Parameter

    -
      -
    • - -

      #boolean switch : -Turn journey on=true or off=false. If no value is given switch=true.

      +
    +
    +
    +
    + + +RAT:DestinationZone() + +
    +
    + +

    Destinations are treated as zones.

    + + +

    Aircraft will not land but rather be despawned when they reach a random point in the zone.

    - -
    @@ -1408,7 +1810,7 @@ Turn journey on=true or off=false. If no value is given switch=true.

  • #boolean switch : -true=enable ATC, false=disable ATC.

    +Enable ATC (true) or Disable ATC (false). No argument means ATC enabled.

    • @@ -1434,6 +1836,20 @@ Name or table of names of excluded airports.

    + +
    +
    +
    + + #number + +RAT.FLcruise + +
    +
    + +

    Cruise altitude of aircraft. Default FL200 for planes and F005 for helos.

    +
    @@ -1496,7 +1912,7 @@ Name or table of names of excluded airports.

    + +
    +
    +
    + + #number + +RAT.Ndeparture_Airports + +
    +
    + +

    Number of departure airports set via SetDeparture().

    + +
    +
    +
    +
    + + #number + +RAT.Ndeparture_Zones + +
    +
    + +

    Number of departure zones set via SetDeparture.

    + +
    +
    +
    +
    + + #number + +RAT.Ndestination_Airports + +
    +
    + +

    Number of destination airports set via SetDestination().

    + +
    +
    +
    +
    + + #number + +RAT.Ndestination_Zones + +
    +
    + +

    Number of destination zones set via SetDestination().

    +
    @@ -1608,6 +2080,19 @@ If the group does not exist in the mission editor.

    + +RAT:NoRespawn() + +
    +
    + +

    Aircraft will not get respawned when they finished their route.

    + +
    +
    +
    +
    + RAT:PlaceMarkers(switch) @@ -1661,6 +2146,85 @@ true=yes, false=no.

    + +RAT:RadioFrequency(frequency) + +
    +
    + +

    Set radio frequency.

    + +

    Parameter

    +
      +
    • + +

      #number frequency : +Radio frequency.

      + +
      • +
    +
    +
    +
    +
    + + +RAT:RadioModulation(modulation) + +
    +
    + +

    Set radio modulation.

    + + +

    Default is AM.

    + +

    Parameter

    +
      +
    • + +

      #string modulation : +Either "FM" or "AM". If no value is given, modulation is set to AM.

      + +
      • +
    +
    +
    +
    +
    + + +RAT:RadioOFF() + +
    +
    + +

    Disable Radio.

    + + +

    Overrules the ME setting.

    + +
    +
    +
    +
    + + +RAT:RadioON() + +
    +
    + +

    Enable Radio.

    + + +

    Overrules the ME setting.

    + +
    +
    +
    +
    + RAT:RespawnAfterLanding(delay) @@ -1674,7 +2238,58 @@ true=yes, false=no.

  • #number delay : -(Optional) Delay in seconds until respawn happens after landing. Default is 180 seconds.

    +(Optional) Delay in seconds until respawn happens after landing. Default is 180 seconds. Minimum is 0.5 seconds.

    + +
    • + + +
    +
    +
    + + +RAT:RespawnAfterTakeoff() + +
    +
    + +

    Aircraft will be respawned directly after take-off.

    + +
    +
    +
    +
    + + +RAT:ReturnZone() + +
    +
    + +

    Aircraft will fly to a random point within a zone and then return to its departure airport or zone.

    + +
    +
    +
    +
    + + +RAT:SetAISkill(skill) + +
    +
    + +

    Set skill of AI aircraft.

    + + +

    Default is "High".

    + +

    Parameter

    +
      +
    • + +

      #string skill : +Skill, options are "Average", "Good", "High", "Excellent" and "Random". Parameter is case insensitive.

    @@ -1692,14 +2307,14 @@ true=yes, false=no.

    Set the climb rate.

    -

    Default is 1500 ft/min. This automatically sets the climb angle.

    +

    This automatically sets the climb angle.

    Parameter

    • #number rate : -Climb rate in ft/min.

      +Climb rate in ft/min. Default is 1500 ft/min. Minimum is 100 ft/min. Maximum is 15,000 ft/min.

    @@ -1813,7 +2428,7 @@ Cruising altitude ASL in meters.

    -RAT:SetDeparture(names) +RAT:SetDeparture(departurenames)
    @@ -1827,7 +2442,7 @@ Cruising altitude ASL in meters.

    • -

      #string names : +

      #string departurenames : Name or table of names of departure airports or zones.

      • @@ -1857,7 +2472,7 @@ Name or table of names of departure airports or zones.

    • Core.Zone#ZONE zone : -Zone in which the airports lie.

      +Zone in which the destination airports lie. Has to be a MOOSE zone.

    @@ -1882,7 +2497,7 @@ Zone in which the airports lie.

  • #number angle : -Angle of descent in degrees.

    +Angle of descent in degrees. Minimum is 0.5 deg. Maximum 50 deg.

    • @@ -1892,21 +2507,18 @@ Angle of descent in degrees.

    -RAT:SetDestination(names) +RAT:SetDestination(destinationnames)
    -

    Set name of destination airport for the AI aircraft.

    - - -

    If no name is given an airport from the friendly coalition(s) is chosen randomly.

    +

    Set name of destination airports or zones for the AI aircraft.

    Parameter

    • -

      #string names : +

      #string destinationnames : Name of the destination airport or table of destination airports.

      • @@ -1932,7 +2544,7 @@ Name of the destination airport or table of destination airports.

    • Core.Zone#ZONE zone : -Zone in which the airports lie.

      +Zone in which the departure airports lie. Has to be a MOOSE zone.

    @@ -1942,7 +2554,7 @@ Zone in which the airports lie.

    -RAT:SetFL(height) +RAT:SetFL(FL)
    @@ -1956,8 +2568,8 @@ Zone in which the airports lie.

    • -

      #number height : -FL in hundrets of feet. E.g. FL200 = 20000 ft ASL.

      +

      #number FL : +Fight Level in hundrets of feet. E.g. FL200 = 20000 ft ASL.

    @@ -1967,7 +2579,7 @@ FL in hundrets of feet. E.g. FL200 = 20000 ft ASL.

    -RAT:SetFLcruise(height) +RAT:SetFLcruise(FL)
    @@ -1982,8 +2594,8 @@ Default is FL200 for planes and FL005 for helicopters.

    • -

      #number height : -FL in hundrets of feet. E.g. FL200 = 20000 ft ASL.

      +

      #number FL : +Flight level in hundrets of feet. E.g. FL200 = 20000 ft ASL.

    @@ -1993,7 +2605,7 @@ FL in hundrets of feet. E.g. FL200 = 20000 ft ASL.

    -RAT:SetFLmax(height) +RAT:SetFLmax(FL)
    @@ -2007,8 +2619,8 @@ FL in hundrets of feet. E.g. FL200 = 20000 ft ASL.

    • -

      #number height : -Maximum FL in hundrets of feet.

      +

      #number FL : +Maximum Fight Level in hundrets of feet.

    @@ -2018,7 +2630,7 @@ Maximum FL in hundrets of feet.

    -RAT:SetFLmin(height) +RAT:SetFLmin(FL)
    @@ -2032,8 +2644,8 @@ Maximum FL in hundrets of feet.

    • -

      #number height : -Maximum FL in hundrets of feet.

      +

      #number FL : +Maximum Fight Level in hundrets of feet.

    @@ -2159,6 +2771,28 @@ Distance in km.

    + +RAT:SetParkingID(id) + +
    +
    + +

    Set parking id of aircraft.

    + +

    Parameter

    +
      +
    • + +

      #string id : +Parking ID of the aircraft.

      + +
      • +
    +
    +
    +
    +
    + RAT:SetROE(roe) @@ -2215,17 +2849,14 @@ Distance in km.

    -

    Set the delay before first group is spawned.

    - - -

    Minimum delay is 0.5 seconds.

    +

    Set the delay before first group is spawned.

    Parameter

    • #number delay : -Delay in seconds.

      +Delay in seconds. Default is 5 seconds. Minimum delay is 0.5 seconds.

    @@ -2242,15 +2873,12 @@ Delay in seconds.

    Set the interval between spawnings of the template group.

    - -

    Minimum interval is 0.5 seconds.

    -

    Parameter

    • #number interval : -Interval in seconds.

      +Interval in seconds. Default is 5 seconds. Minimum is 0.5 seconds.

    @@ -2354,17 +2982,14 @@ Type can be "takeoff-cold" or "cold", "takeoff-hot" or "hot", "takeoff-runway" o
    -

    Aircraft report status messages.

    - - -

    Default is off.

    +

    Aircraft report status update messages along the route.

    Parameter

    • #boolean switch : -true=on, false=off.

      +Swtich reports on (true) or off (false). No argument is on.

    @@ -2393,17 +3018,14 @@ true=on, false=off.

    -

    Set the time after which inactive groups will be destroyed.

    - - -

    Default is 300 seconds.

    +

    Set the time after which inactive groups will be destroyed.

    Parameter

    • #number time : -Time in seconds.

      +Time in seconds. Default is 600 seconds = 10 minutes. Minimum is 60 seconds.

    @@ -2421,6 +3043,22 @@ Time in seconds.

    Time in seconds after which inactive units will be destroyed. Default is 300 seconds.

    +
    +
    +
    +
    + + +RAT:Uncontrolled() + +
    +
    + +

    Spawn aircraft in uncontolled state.

    + + +

    Aircraft will only sit at their parking spots. Only for populating airfields.

    +
    @@ -2655,6 +3293,28 @@ Time the fight first registered.

    + +RAT:_AddFriendlyAirports(ports) + +
    +
    + +

    Add names of all friendly airports to possible departure or destination airports if they are not already in the list.

    + +

    Parameter

    +
      +
    • + +

      #table ports : +List of departure or destination airports/zones that will be added.

      + +
      • +
    +
    +
    +
    +
    + RAT:_AirportExists(name) @@ -2681,6 +3341,46 @@ True if airport exsits, false otherwise.

    + +RAT:_AnticipatedGroupName(index) + +
    +
    + +

    Anticipated group name from alias and spawn index.

    + +

    Parameter

    +
      +
    • + +

      #number index : +Spawnindex of group if given or self.SpawnIndex+1 by default.

      + +
      • +
    +

    Return value

    + +

    #string: +Name the group will get after it is spawned.

    + +
    +
    +
    +
    + + +RAT:_CheckConsistency() + +
    +
    + +

    Function checks consistency of user input and automatically adjusts parameters if necessary.

    + +
    +
    +
    +
    + RAT:_Course(a, b) @@ -2730,7 +3430,7 @@ Heading/angle in degrees.

  • #boolean switch : -true turn messages on, false=off.

    +Turn debug on=true or off=false. No argument means on.

    • @@ -2933,64 +3633,6 @@ Table with airport names that lie within the zone.

    - -RAT:_GetDestinations(departure, q, minrange, maxrange) - -
    -
    - -

    Get all possible destination airports depending on departure position.

    - - -

    The list is sorted w.r.t. distance to departure position.

    - -

    Parameters

    -
      -
    • - -

      Wrapper.Airbase#AIRBASE departure : -Departure airport or zone.

      - -
      • -
    • - -

      Core.Point#COORDINATE q : -Coordinate of the departure point.

      - -
      • -
    • - -

      #number minrange : -Minimum range to q in meters.

      - -
      • -
    • - -

      #number maxrange : -Maximum range to q in meters.

      - -
      • -
    -

    Return values

    -
      -
    1. - -

      #table: -Table with possible destination airports.

      - -
      2. -
    2. - -

      #nil: -If no airports could be found.

      - -
      3. -
    -
    -
    -
    -
    - RAT:_GetLife(group) @@ -3018,6 +3660,33 @@ Life of unit in percent.

    + +RAT:_Heading(course) + +
    +
    + +

    Determine the heading for an aircraft to be entered in the route template.

    + +

    Parameter

    +
      +
    • + +

      #number course : +The course between two points in degrees.

      + +
      • +
    +

    Return value

    + +

    #number: +heading Heading in rad.

    + +
    +
    +
    +
    + RAT:_InitAircraft(DCSgroup) @@ -3071,12 +3740,12 @@ true if airport is friendly and false otherwise.

    -RAT:_MinDistance(alpha, beta, h) +RAT:_MinDistance(alpha, beta, ha, hb)
    -

    Calculate min distance between departure and destination for given minimum flight level and climb/decent rates

    +

    Calculate minimum distance between departure and destination for given minimum flight level and climb/decent rates.

    Parameters

      @@ -3094,23 +3763,45 @@ Angle of descent [rad].

    • -

      #number h : -min height AGL.

      +

      #number ha : +Height difference between departure and cruise altiude.

      + +
      • +
    • + +

      #number hb : +Height difference between cruise altitude and destination.

    -

    Return value

    +

    Return values

    +
      +

    1. #number: -Minimum distance between departure and destiantion.

      +d1 Minimum distance for climb phase to reach cruise altitude.

      +
      2. +
    2. + +

      #number: +d2 Minimum distance for descent phase to reach destination height.

      + +
      3. +
    3. + +

      #number: +dtot Minimum total distance to climb and descent.

      + +
      4. +
    -RAT:_ModifySpawnTemplate(waypoints) +RAT:_ModifySpawnTemplate(waypoints, livery)
    @@ -3121,13 +3812,47 @@ Minimum distance between departure and destiantion.

    In particular, the waypoints of the group's flight plan are copied into the spawn template. This allows to spawn at airports and also land at other airports, i.e. circumventing the DCS "landing bug".

    -

    Parameter

    +

    Parameters

    • #table waypoints : The waypoints of the AI flight plan.

      +
      • +
    • + +

      #string livery : +(Optional) Livery of the aircraft. All members of a flight will get the same livery.

      + +
      • +
    +
    +
    +
    +
    + + +RAT:_NameInList(liste, name) + +
    +
    + +

    Check if a name/string is in a list or not.

    + +

    Parameters

    +
      +
    • + +

      #table liste : +List of names to be checked.

      + +
      • +
    • + +

      #string name : +Name to be checked for.

      +
    @@ -3303,35 +4028,56 @@ Departure zone if spawning in air.

    -RAT:_PickDestination(destinations, _random) +RAT:_PickDestination(departure, q, minrange, maxrange, random, landing)
    -

    Pick destination airport.

    - - -

    If no airport name is given an airport from the coalition is chosen randomly.

    +

    Pick destination airport or zone depending on departure position.

    Parameters

    • -

      #table destinations : -Table with destination airports.

      +

      Wrapper.Airbase#AIRBASE departure : +Departure airport or zone.

    • -

      #boolean _random : -(Optional) Switch to activate a random selection of airports.

      +

      Core.Point#COORDINATE q : +Coordinate of the departure point.

      + +
      • +
    • + +

      #number minrange : +Minimum range to q in meters.

      + +
      • +
    • + +

      #number maxrange : +Maximum range to q in meters.

      + +
      • +
    • + +

      #boolean random : +Destination is randomly selected from friendly airport (true) or from destinations specified by user input (false).

      + +
      • +
    • + +

      #number landing : +Number indicating whether we land at a destination airport or fly to a zone object.

    Return value

    Wrapper.Airbase#AIRBASE: -Destination airport.

    +destination Destination airport or zone.

    @@ -3339,7 +4085,7 @@ Destination airport.

    -RAT:_PlaceMarkers(waypoints) +RAT:_PlaceMarkers(waypoints, index)
    @@ -3349,13 +4095,19 @@ Destination airport.

    Note we assume a very specific number and type of waypoints here.

    -

    Parameter

    +

    Parameters

    • #table waypoints : Table with waypoints.

      +
      • +
    • + +

      #number index : +Spawn index of group.

      +
    @@ -3533,7 +4285,7 @@ total Total route length in meters.

    -RAT:_SetMarker(text, wp) +RAT:_SetMarker(text, wp, index)
    @@ -3553,6 +4305,12 @@ Info text displayed at maker.

    #table wp : Position of marker coming in as waypoint, i.e. has x, y and alt components.

    + +
  • + +

    #number index : +Spawn index of group.

    +
    • @@ -3617,7 +4375,7 @@ ROT of group.

    -RAT:_SetRoute(Takeoff, _departure, _destination, takeoff) +RAT:_SetRoute(Takeoff, Landing, _departure, _destination, takeoff, landing, _waypoint)
    @@ -3632,7 +4390,13 @@ ROT of group.

  • takeoff#RAT.wp Takeoff : -type.

    +type. Could also be air start.

    + +
    • +
  • + +

    landing#RAT.wp Landing : +type. Could also be a destination in air.

  • @@ -3651,6 +4415,16 @@ type.

    takeoff :

    +
    • +
  • + +

    landing :

    + +
    • +
  • + +

    _waypoint :

    +

    • Return values

    @@ -3712,7 +4486,7 @@ If no valid departure or destination airport could be found.

    -RAT:_SpawnWithRoute(_departure, _destination) +RAT:_SpawnWithRoute(_departure, _destination, _takeoff, _landing, _livery, _waypoint)
    @@ -3738,6 +4512,54 @@ Initializes the ratcraft array and group menu.

    #string _destination : (Optional) Name of destination airbase.

    + +
  • + +

    #number _takeoff : +Takeoff type id.

    + +
    • +
  • + +

    _landing :

    + +
    • +
  • + +

    _livery :

    + +
    • +
  • + +

    _waypoint :

    + +
    • + +
    +
    +
    +
    + + +RAT:_TaskFunction(FunctionString, ...) + +
    +
    + +

    Task function.

    + +

    Parameters

    +
      +
    • + +

      #string FunctionString : +Name of the function to be called.

      + +
      • +
    • + +

      ... :

      +
    @@ -3791,7 +4613,7 @@ DCSTask

    -RAT:_Waypoint(Type, Coord, Speed, Altitude, Airport) +RAT:_Waypoint(Running, Type, Coord, Speed, Altitude, Airport, index)
    @@ -3802,6 +4624,12 @@ DCSTask

    • +

      #number Running : +index of waypoints. Starts with 1 which is normally departure/spawn waypoint.

      + +
      • +
    • +

      #number Type : Type of waypoint.

      @@ -3829,6 +4657,11 @@ Altitude in m.

      Wrapper.Airbase#AIRBASE Airport : Airport of object to spawn.

      +
      • +
    • + +

      index :

      +

    Return value

    @@ -3836,6 +4669,111 @@ Airport of object to spawn.

    #table: Waypoints for DCS task route or spawn template.

    +
    +
    +
    +
    + + +RAT._WaypointFunction(group, rat, wp) + +
    +
    + +

    Function which is called after passing every waypoint.

    + + +

    Info on waypoint is given and special functions are executed.

    + +

    Parameters

    +
      +
    • + +

      Core.Group#GROUP group : +Group of aircraft.

      + +
      • +
    • + +

      #RAT rat : +RAT object.

      + +
      • +
    • + +

      #number wp : +Waypoint index. Running number of the waypoints. Determines the actions to be executed.

      + +
      • +
    +
    +
    +
    +
    + + +RAT:_ZoneExists(name) + +
    +
    + +

    Test if a trigger zone defined in the mission editor exists.

    + +

    Parameter

    +
      +
    • + +

      #string name :

      + +
      • +
    +

    Return value

    + +

    #boolean: +True if zone exsits, false otherwise.

    + +
    +
    +
    +
    + + + +RAT.actype + +
    +
    + + + +
    +
    +
    +
    + + #boolean + +RAT.addfriendlydepartures + +
    +
    + +

    Add all friendly airports to departures.

    + +
    +
    +
    +
    + + #boolean + +RAT.addfriendlydestinations + +
    +
    + +

    Add all friendly airports to destinations.

    +
    @@ -4058,21 +4996,7 @@ Waypoints for DCS task route or spawn template.

    -

    Array containing the names of the destination airports.

    - -
    -
    -
    -
    - - #table - -RAT.departure_zones - -
    -
    - -

    Array containing the names of the departure zones.

    +

    Array containing the names of the destination airports or zones.

    @@ -4100,7 +5024,21 @@ Waypoints for DCS task route or spawn template.

    -

    Array containing the names of the destination airports.

    +

    Array containing the names of the destination airports or zones.

    + +
    +
    +
    +
    + + #boolean + +RAT.destinationzone + +
    +
    + +

    Destination is a zone and not an airport.

    @@ -4130,6 +5068,20 @@ Waypoints for DCS task route or spawn template.

    Add an F10 menu for RAT.

    + +
    +
    +
    + + #number + +RAT.frequency + +
    +
    + +

    Radio frequency used by the RAT groups.

    +
    @@ -4158,6 +5110,20 @@ Waypoints for DCS task route or spawn template.

    Some ID to identify who we are in output of the DCS.log file.

    + +
    +
    +
    + + #number + +RAT.landing + +
    +
    + +

    Landing type. Determines if we actually land at an airport or treat it as zone.

    +
    @@ -4228,6 +5194,20 @@ Waypoints for DCS task route or spawn template.

    Min distance from departure to destination in meters. Default 5 km.

    + +
    +
    +
    + + #string + +RAT.modulation + +
    +
    + +

    Ratio modulation. Either "FM" or "AM".

    +
    @@ -4242,6 +5222,20 @@ Waypoints for DCS task route or spawn template.

    Number of groups to be spawned in total.

    + +
    +
    +
    + + #boolean + +RAT.norespawn + +
    +
    + +

    Aircraft will not be respawned after they have finished their route.

    +
    @@ -4259,6 +5253,20 @@ Waypoints for DCS task route or spawn template.

    Onboard number.

    + +
    +
    +
    + + #string + +RAT.parking_id + +
    +
    + +

    String with a special parking ID for the aircraft.

    +
    @@ -4273,6 +5281,20 @@ Waypoints for DCS task route or spawn template.

    Place markers of waypoints on F10 map.

    + +
    +
    +
    + + #boolean + +RAT.radio + +
    +
    + +

    If true/false disables radio messages from the RAT groups.

    +
    @@ -4329,6 +5351,20 @@ Waypoints for DCS task route or spawn template.

    Aircraft report status.

    + +
    +
    +
    + + #boolean + +RAT.respawn_after_takeoff + +
    +
    + +

    Aircraft will be respawned directly after take-off.

    +
    @@ -4357,6 +5393,34 @@ Waypoints for DCS task route or spawn template.

    Delay in seconds until repawn happens after landing.

    + +
    +
    +
    + + #table + +RAT.return_zones + +
    +
    + +

    Array containing the names of the return zones.

    + +
    +
    +
    +
    + + #boolean + +RAT.returnzone + +
    +
    + +

    Zone where aircraft will fly to before returning to their departure airport.

    +
    @@ -4413,6 +5477,20 @@ Waypoints for DCS task route or spawn template.

    Delay time in seconds before first spawning happens.

    + +
    +
    +
    + + #boolean + +RAT.spawninitialized + +
    +
    + +

    If RAT:Spawn() was already called this RAT object is set to true to prevent users to call it again.

    +
    @@ -4427,6 +5505,20 @@ Waypoints for DCS task route or spawn template.

    Interval between spawning units/groups. Note that we add a randomization of 50%.

    + +
    +
    +
    + + + +RAT.status + +
    +
    + +

    RAT aircraft status.

    +
    @@ -4446,7 +5538,7 @@ Waypoints for DCS task route or spawn template.

    - #string + #number RAT.takeoff @@ -4455,6 +5547,48 @@ Waypoints for DCS task route or spawn template.

    Takeoff type. 0=coldorhot.

    + +
    +
    +
    + + Core.Group#GROUP + +RAT.templategroup + +
    +
    + +

    Group serving as template for the RAT aircraft.

    + +
    +
    +
    +
    + + + +RAT.type + +
    +
    + + + +
    +
    +
    +
    + + #boolean + +RAT.uncontrolled + +
    +
    + +

    If true aircraft are spawned in uncontrolled state and will only sit on their parking spots.

    +
    @@ -4469,6 +5603,48 @@ Waypoints for DCS task route or spawn template.

    RAT unit conversions.

    + +
    +
    +
    + + #string + +RAT.version + +
    +
    + +

    RAT version.

    + +
    +
    +
    +
    + + #table + +RAT.waypointdescriptions + +
    +
    + +

    Table with strings for waypoint descriptions of markers.

    + +
    +
    +
    +
    + + #table + +RAT.waypointstatus + +
    +
    + +

    Table with strings of waypoint status.

    +
    @@ -4483,6 +5659,34 @@ Waypoints for DCS task route or spawn template.

    RAT waypoint type.

    + +
    +
    +
    + + #number + +RAT.wp_final + +
    +
    + +

    Index of the final waypoint.

    + +
    +
    +
    +
    + + #number + +RAT.wp_holding + +
    +
    + +

    Index of the holding waypoint.

    +
    diff --git a/docs/Documentation/Route.html b/docs/Documentation/Route.html index 4a4440321..5588ac2f1 100644 --- a/docs/Documentation/Route.html +++ b/docs/Documentation/Route.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Scenery.html b/docs/Documentation/Scenery.html index 3de1d6356..cedf8ad0d 100644 --- a/docs/Documentation/Scenery.html +++ b/docs/Documentation/Scenery.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/ScheduleDispatcher.html b/docs/Documentation/ScheduleDispatcher.html index 3c62edaa1..5b55ba06a 100644 --- a/docs/Documentation/ScheduleDispatcher.html +++ b/docs/Documentation/ScheduleDispatcher.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Scheduler.html b/docs/Documentation/Scheduler.html index 3dc9d07ac..e7fac3bf8 100644 --- a/docs/Documentation/Scheduler.html +++ b/docs/Documentation/Scheduler.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Scoring.html b/docs/Documentation/Scoring.html index c7811523c..f395d533f 100644 --- a/docs/Documentation/Scoring.html +++ b/docs/Documentation/Scoring.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Sead.html b/docs/Documentation/Sead.html index ef84bbfa3..ef7ee8a05 100644 --- a/docs/Documentation/Sead.html +++ b/docs/Documentation/Sead.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Set.html b/docs/Documentation/Set.html index e50f2d821..020a07e22 100644 --- a/docs/Documentation/Set.html +++ b/docs/Documentation/Set.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Settings.html b/docs/Documentation/Settings.html index 159a358e6..7558ad0f0 100644 --- a/docs/Documentation/Settings.html +++ b/docs/Documentation/Settings.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Smoke.html b/docs/Documentation/Smoke.html index c7a449531..30eea03ad 100644 --- a/docs/Documentation/Smoke.html +++ b/docs/Documentation/Smoke.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index 06a743746..e48bc9aca 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • @@ -848,6 +849,12 @@ and any spaces before and after the resulting name are removed.

    SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) + + + + SPAWN.uncontrolled + + @@ -3981,6 +3988,20 @@ True = Continue Scheduler

    + +
    +
    +
    + + + +SPAWN.uncontrolled + +
    +
    + + +
    diff --git a/docs/Documentation/SpawnStatic.html b/docs/Documentation/SpawnStatic.html index 5c4e83a59..b9cd35a99 100644 --- a/docs/Documentation/SpawnStatic.html +++ b/docs/Documentation/SpawnStatic.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • @@ -490,6 +491,7 @@ ptional) The name of the new static.

    + #number SPAWNSTATIC.SpawnIndex diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html index d6706e2ed..3978fd2d6 100644 --- a/docs/Documentation/Spot.html +++ b/docs/Documentation/Spot.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Static.html b/docs/Documentation/Static.html index 6733819fe..c7a8dc808 100644 --- a/docs/Documentation/Static.html +++ b/docs/Documentation/Static.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/StaticObject.html b/docs/Documentation/StaticObject.html index dd89260c6..0638c4e5a 100644 --- a/docs/Documentation/StaticObject.html +++ b/docs/Documentation/StaticObject.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Task.html b/docs/Documentation/Task.html index be5fb519f..e17fc7c8d 100644 --- a/docs/Documentation/Task.html +++ b/docs/Documentation/Task.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/TaskZoneCapture.html b/docs/Documentation/TaskZoneCapture.html index 5a943653d..684cce1e9 100644 --- a/docs/Documentation/TaskZoneCapture.html +++ b/docs/Documentation/TaskZoneCapture.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Task_A2A.html b/docs/Documentation/Task_A2A.html index b8bcc3021..03568dc9f 100644 --- a/docs/Documentation/Task_A2A.html +++ b/docs/Documentation/Task_A2A.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Task_A2A_Dispatcher.html b/docs/Documentation/Task_A2A_Dispatcher.html index bbad09e91..2dd3bd9ee 100644 --- a/docs/Documentation/Task_A2A_Dispatcher.html +++ b/docs/Documentation/Task_A2A_Dispatcher.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Task_A2G.html b/docs/Documentation/Task_A2G.html index 81b43acb3..ef59a9787 100644 --- a/docs/Documentation/Task_A2G.html +++ b/docs/Documentation/Task_A2G.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Task_A2G_Dispatcher.html b/docs/Documentation/Task_A2G_Dispatcher.html index a2ae397af..f7ec79ac2 100644 --- a/docs/Documentation/Task_A2G_Dispatcher.html +++ b/docs/Documentation/Task_A2G_Dispatcher.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index 968104c7e..e893c14b4 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • @@ -562,7 +563,7 @@ based on the tasking capabilities defined in Task#TA
    - Core.Cargo#CARGO + FSM_PROCESS.Cargo @@ -576,7 +577,6 @@ based on the tasking capabilities defined in Task#TA
    - FSM_PROCESS.DeployZone @@ -641,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 d6ce50a3b..57beddbe9 100644 --- a/docs/Documentation/Task_PICKUP.html +++ b/docs/Documentation/Task_PICKUP.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Unit.html b/docs/Documentation/Unit.html index 6031c833a..867b1f29a 100644 --- a/docs/Documentation/Unit.html +++ b/docs/Documentation/Unit.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/UserFlag.html b/docs/Documentation/UserFlag.html index 33ea8d416..15d1f7e91 100644 --- a/docs/Documentation/UserFlag.html +++ b/docs/Documentation/UserFlag.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/UserSound.html b/docs/Documentation/UserSound.html index 7127d4dfd..853080b6b 100644 --- a/docs/Documentation/UserSound.html +++ b/docs/Documentation/UserSound.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Utils.html b/docs/Documentation/Utils.html index 38658f543..8b4a74daa 100644 --- a/docs/Documentation/Utils.html +++ b/docs/Documentation/Utils.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/Velocity.html b/docs/Documentation/Velocity.html new file mode 100644 index 000000000..2db4efb84 --- /dev/null +++ b/docs/Documentation/Velocity.html @@ -0,0 +1,688 @@ + + + + + + +
    +
    + +
    +
    +
    +
    + +
    +

    Module Velocity

    + +

    Core -- VELOCITY models a speed, which can be expressed in various formats according the Settings.

    + + + +
    + +

    Author: Sven Van de Velde (FlightControl)

    +

    Contributions:

    + +
    + + +

    Global(s)

    + + + + + + + + + +
    VELOCITY +

    VELOCITY class, extends Base#BASE

    + +

    VELOCITY models a speed, which can be expressed in various formats according the Settings.

    +
    VELOCITY_POSITIONABLE +

    VELOCITY_POSITIONABLE class, extends Base#BASE

    + +

    VELOCITY_POSITIONABLE monitors the speed of an Positionable in the simulation, which can be expressed in various formats according the Settings.

    +
    +

    Type VELOCITY

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    VELOCITY:Get() +

    Get the velocity in Mps (meters per second).

    +
    VELOCITY:GetKmph() +

    Get the velocity in Kmph (kilometers per hour).

    +
    VELOCITY:GetMiph() +

    Get the velocity in Miph (miles per hour).

    +
    VELOCITY:GetText(Settings) +

    Get the velocity in text, according the player Settings.

    +
    VELOCITY:New(VelocityMps) +

    VELOCITY Constructor.

    +
    VELOCITY:Set(VelocityMps) +

    Set the velocity in Mps (meters per second).

    +
    VELOCITY:SetKmph(VelocityKmph) +

    Set the velocity in Kmph (kilometers per hour).

    +
    VELOCITY:SetMiph(VelocityMiph) +

    Set the velocity in Miph (miles per hour).

    +
    VELOCITY:ToString(Controllable, Settings, VelocityGroup) +

    Get the velocity in text, according the player or default Settings.

    +
    VELOCITY.Velocity + +
    + +

    Type VELOCITY_POSITIONABLE

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    VELOCITY_POSITIONABLE:Get() +

    Get the velocity in Mps (meters per second).

    +
    VELOCITY_POSITIONABLE:GetKmph() +

    Get the velocity in Kmph (kilometers per hour).

    +
    VELOCITY_POSITIONABLE:GetMiph() +

    Get the velocity in Miph (miles per hour).

    +
    VELOCITY_POSITIONABLE:New(Positionable) +

    VELOCITY_POSITIONABLE Constructor.

    +
    VELOCITY_POSITIONABLE.Positionable + +
    VELOCITY_POSITIONABLE:ToString() +

    Get the velocity in text, according the player or default Settings.

    +
    VELOCITY_POSITIONABLE.Velocity + +
    + +

    Global(s)

    +
    +
    + + #VELOCITY + +VELOCITY + +
    +
    + +

    VELOCITY class, extends Base#BASE

    + +

    VELOCITY models a speed, which can be expressed in various formats according the Settings.

    + + + +

    1. VELOCITY constructor

    + + + + +
    +
    +
    +
    + + #VELOCITY_POSITIONABLE + +VELOCITY_POSITIONABLE + +
    +
    + +

    VELOCITY_POSITIONABLE class, extends Base#BASE

    + +

    VELOCITY_POSITIONABLE monitors the speed of an Positionable in the simulation, which can be expressed in various formats according the Settings.

    + + + +

    1. VELOCITY_POSITIONABLE constructor

    + + + + +
    +
    +

    Type Velocity

    + +

    Type VELOCITY

    +

    Field(s)

    +
    +
    + + +VELOCITY:Get() + +
    +
    + +

    Get the velocity in Mps (meters per second).

    + +

    Return value

    + +

    #number: +The velocity in meters per second.

    + +
    +
    +
    +
    + + +VELOCITY:GetKmph() + +
    +
    + +

    Get the velocity in Kmph (kilometers per hour).

    + +

    Return value

    + +

    #number: +The velocity in kilometers per hour.

    + +
    +
    +
    +
    + + +VELOCITY:GetMiph() + +
    +
    + +

    Get the velocity in Miph (miles per hour).

    + +

    Return value

    + +

    #number: +The velocity in miles per hour.

    + +
    +
    +
    +
    + + +VELOCITY:GetText(Settings) + +
    +
    + +

    Get the velocity in text, according the player Settings.

    + +

    Parameter

    + +

    Return value

    + +

    #string: +The velocity in text.

    + +
    +
    +
    +
    + + +VELOCITY:New(VelocityMps) + +
    +
    + +

    VELOCITY Constructor.

    + +

    Parameter

    +
      +
    • + +

      #number VelocityMps : +The velocity in meters per second.

      + +
      • +
    +

    Return value

    + +

    #VELOCITY:

    + + +
    +
    +
    +
    + + +VELOCITY:Set(VelocityMps) + +
    +
    + +

    Set the velocity in Mps (meters per second).

    + +

    Parameter

    +
      +
    • + +

      #number VelocityMps : +The velocity in meters per second.

      + +
      • +
    +

    Return value

    + +

    #VELOCITY:

    + + +
    +
    +
    +
    + + +VELOCITY:SetKmph(VelocityKmph) + +
    +
    + +

    Set the velocity in Kmph (kilometers per hour).

    + +

    Parameter

    +
      +
    • + +

      #number VelocityKmph : +The velocity in kilometers per hour.

      + +
      • +
    +

    Return value

    + +

    #VELOCITY:

    + + +
    +
    +
    +
    + + +VELOCITY:SetMiph(VelocityMiph) + +
    +
    + +

    Set the velocity in Miph (miles per hour).

    + +

    Parameter

    +
      +
    • + +

      #number VelocityMiph : +The velocity in miles per hour.

      + +
      • +
    +

    Return value

    + +

    #VELOCITY:

    + + +
    +
    +
    +
    + + +VELOCITY:ToString(Controllable, Settings, VelocityGroup) + +
    +
    + +

    Get the velocity in text, according the player or default Settings.

    + +

    Parameters

    + +

    Return value

    + +

    #string: +The velocity in text according the player or default Settings

    + +
    +
    +
    +
    + + + +VELOCITY.Velocity + +
    +
    + + + +
    +
    + +

    Type VELOCITY_POSITIONABLE

    +

    Field(s)

    +
    +
    + + +VELOCITY_POSITIONABLE:Get() + +
    +
    + +

    Get the velocity in Mps (meters per second).

    + +

    Return value

    + +

    #number: +The velocity in meters per second.

    + +
    +
    +
    +
    + + +VELOCITY_POSITIONABLE:GetKmph() + +
    +
    + +

    Get the velocity in Kmph (kilometers per hour).

    + +

    Return value

    + +

    #number: +The velocity in kilometers per hour.

    + +
    +
    +
    +
    + + +VELOCITY_POSITIONABLE:GetMiph() + +
    +
    + +

    Get the velocity in Miph (miles per hour).

    + +

    Return value

    + +

    #number: +The velocity in miles per hour.

    + +
    +
    +
    +
    + + +VELOCITY_POSITIONABLE:New(Positionable) + +
    +
    + +

    VELOCITY_POSITIONABLE Constructor.

    + +

    Parameter

    + +

    Return value

    + +

    #VELOCITY_POSITIONABLE:

    + + +
    +
    +
    +
    + + + +VELOCITY_POSITIONABLE.Positionable + +
    +
    + + + +
    +
    +
    +
    + + +VELOCITY_POSITIONABLE:ToString() + +
    +
    + +

    Get the velocity in text, according the player or default Settings.

    + +

    Return value

    + +

    #string: +The velocity in text according the player or default Settings

    + +
    +
    +
    +
    + + + +VELOCITY_POSITIONABLE.Velocity + +
    +
    + + + +
    +
    + +
    + +
    + + diff --git a/docs/Documentation/Zone.html b/docs/Documentation/Zone.html index 324151cf4..ffd633f60 100644 --- a/docs/Documentation/Zone.html +++ b/docs/Documentation/Zone.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/ZoneCaptureCoalition.html b/docs/Documentation/ZoneCaptureCoalition.html index ff10c49c7..20c24e743 100644 --- a/docs/Documentation/ZoneCaptureCoalition.html +++ b/docs/Documentation/ZoneCaptureCoalition.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/ZoneGoal.html b/docs/Documentation/ZoneGoal.html index 8120d650d..38c84fa53 100644 --- a/docs/Documentation/ZoneGoal.html +++ b/docs/Documentation/ZoneGoal.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • @@ -489,6 +490,7 @@ The name of the player.

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

    + +

    self.SmokeColor = nil

    +
    diff --git a/docs/Documentation/ZoneGoalCargo.html b/docs/Documentation/ZoneGoalCargo.html index c60675d00..a78db9225 100644 --- a/docs/Documentation/ZoneGoalCargo.html +++ b/docs/Documentation/ZoneGoalCargo.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/ZoneGoalCoalition.html b/docs/Documentation/ZoneGoalCoalition.html index 3a47d5c0c..054c9ff22 100644 --- a/docs/Documentation/ZoneGoalCoalition.html +++ b/docs/Documentation/ZoneGoalCoalition.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/env.html b/docs/Documentation/env.html index 5a4a14bd0..7b8b8a626 100644 --- a/docs/Documentation/env.html +++ b/docs/Documentation/env.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/index.html b/docs/Documentation/index.html index e726ff628..288dff7f2 100644 --- a/docs/Documentation/index.html +++ b/docs/Documentation/index.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • @@ -288,7 +289,7 @@ even when there are hardly any players in the mission.

    Base -

    Core -- VELOCITY models a speed, which can be expressed in various formats according the Settings.

    +

    Core -- BASE forms the basis of the MOOSE framework.

    @@ -715,6 +716,12 @@ and creates a CSV file logging the scoring events and results for use at team or

    This module contains derived utilities taken from the MIST framework, which are excellent tools to be reused in an OO environment!.

    + + + + Velocity + +

    Core -- VELOCITY models a speed, which can be expressed in various formats according the Settings.

    diff --git a/docs/Documentation/land.html b/docs/Documentation/land.html index 5e3f0b3e0..1369d87b8 100644 --- a/docs/Documentation/land.html +++ b/docs/Documentation/land.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
    • diff --git a/docs/Documentation/routines.html b/docs/Documentation/routines.html index b84a5803a..ccea4da2e 100644 --- a/docs/Documentation/routines.html +++ b/docs/Documentation/routines.html @@ -102,6 +102,7 @@
  • UserFlag
  • UserSound
  • Utils
    • +
  • Velocity
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal