The AIBalancer#AIBALANCER class monitors and manages as many replacement AI groups as there are -CLIENTS in a SET_CLIENT collection, which are not occupied by human players.
+In other words, use AI_BALANCER to simulate human behaviour by spawning in replacement AI in multi player missions.
+The parent class Fsm#FSM_SET manages the functionality to control the Finite State Machine (FSM). -The mission designer can tailor the behaviour of the AI_BALANCER, by defining event and state transition methods. -An explanation about state and event transition methods can be found in the FSM module documentation.
+The mission designer can tailor the AI_BALANCER behaviour, by implementing a state or event handling method for the following:
+Create a new AI_BALANCER object with the AI_BALANCER.New() method:
- -
Use the method AI_BALANCER.InitSpawnInterval() to set the earliest and latest interval in seconds that is waited until a new replacement AI is spawned.
- -By default, When a human player joins a slot that is AI_BALANCED, the AI group will be destroyed by default. -However, there are 2 additional options that you can use to customize the destroy behaviour. -When a human player joins a slot, you can configure to let the AI return to:
- -Note that when AI returns to an airbase, the AIBALANCER will trigger the Return event and the AI will return, -otherwise the AIBALANCER will trigger a Destroy event, and the AI will be destroyed.
+The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+The underlying change log documents the API changes.
+ + +Please read this carefully. The following notation is used:
The AIBALANCER class monitors and manages as many replacement AI groups as there are +CLIENTS in a SETCLIENT collection, which are not occupied by human players.
AI_BALANCER| AI_BALANCER.AIGroups | -- - | -||||
| AI_BALANCER.ClassName | -- - | -||||
| AI_BALANCER.Earliest | @@ -245,12 +189,6 @@ otherwise the AIBALANCER will trigger a Destroy event, and | AI_BALANCER:New(SetClient, SpawnAI) |
Creates a new AI_BALANCER object - |
- ||
| AI_BALANCER.PatrolZones | -- | ||||
| AI_CAP_ZONE |
-1) #AICAPZONE class, extends AICAP#AIPATROL_ZONE+AICAPZONE class, extends AICAP#AIPATROL_ZONE-The #AICAPZONE class implements the core functions to patrol a Zone by an AI Controllable or Group + The AICAPZONE class implements the core functions to patrol a Zone by an AI Controllable or Group and automatically engage any airborne enemies that are within a certain range or within a certain zone. |
||||
| AI_CAS_ZONE |
-1) #AICASZONE class, extends AIPatrol#AIPATROL_ZONE+AICASZONE class, extends AIPatrol#AIPATROL_ZONE-#AICASZONE derives from the AIPatrol#AIPATROL_ZONE, inheriting its methods and behaviour. +AICASZONE derives from the AIPatrol#AIPATROL_ZONE, inheriting its methods and behaviour. |
||||
| AI_PATROL_ZONE |
-1) #AIPATROLZONE class, extends Fsm#FSM_CONTROLLABLE+AIPATROLZONE class, extends Fsm#FSM_CONTROLLABLE-The #AIPATROLZONE class implements the core functions to patrol a Zone by an AI Controllable or Group. +The AIPATROLZONE class implements the core functions to patrol a Zone by an AI Controllable or Group. |
The #AIPATROLZONE class implements the core functions to patrol a Zone by an AI Controllable or Group.
+The AIPATROLZONE class implements the core functions to patrol a Zone by an AI Controllable or Group.
@@ -692,17 +708,17 @@ When the fuel treshold has been reached, the airplane will fly towards the neare
The detection process of the AI controllable can be manipulated. Detection requires an amount of CPU power, which has an impact on your mission performance. @@ -757,7 +773,7 @@ Use the method AIPATROLZO Note that when the zone is too far away, or the AI is not heading towards the zone, or the AI is too high, no targets may be detected according the weather conditions.
-When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base. Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated. @@ -766,7 +782,7 @@ while a new AI is targetted to the AIPATROLZONE. Once the time is finished, the old AI will return to the base. Use the method AIPATROLZONE.ManageFuel() to have this proces in place.
-When the AI is damaged, it is required that a new AIControllable is started. However, damage cannon be foreseen early on.
Therefore, when the damage treshold is reached, the AI will return immediately to the home base (RTB).
@@ -933,9 +949,6 @@ Use the method AIPATROLZONE.M
-
- This table contains the targets detected during patrol.
The alive DCS object representing the cargo. This value can be nil, meaning, that the cargo is not represented anywhere...
+
CARGO_REPRESENTABLE| CARGO_REPRESENTABLE.ClassName | -- - | -|||
| CARGO_REPRESENTABLE:New(CargoObject, Type, Name, Weight, ReportRadius, NearRadius) | +CARGO_REPRESENTABLE:New(Type, Name, Weight, ReportRadius, NearRadius, CargoObject) |
CARGO_REPRESENTABLE Constructor. |
@@ -598,6 +598,12 @@
CARGO_REPRESENTABLE:RouteTo(ToPointVec2, Speed) |
Route a cargo unit to a PointVec2. + |
+
| CARGO_REPRESENTABLE.test | ++ |
The alive DCS object representing the cargo. This value can be nil, meaning, that the cargo is not represented anywhere...
+ + +Wrapper.Controllable#Controllable CargoObject :
#string Type :
#number NearRadius :
(optional)
CargoObject :
CARGO_UNITHello
+ +A Finite State Machine (FSM) models a process flow that transitions between various States through triggered Events.
+A FSM can only be in one of a finite number of states. The machine is in only one state at a time; the state it is in at any given time is called the current state. It can change from one state to another when initiated by an internal or external triggering event, which is called a transition. @@ -199,11 +201,9 @@ YYYY-MM-DD: CLASS:NewFunction( Params ) added
The FSM class is the base class of all FSM_ derived classes.
+A Finite State Machine (FSM) models a process flow that transitions between various States through triggered Events.
A Finite State Machine (FSM) models a process flow that transitions between various States through triggered Events.
+ + + +A FSM can only be in one of a finite number of states. +The machine is in only one state at a time; the state it is in at any given time is called the current state. +It can change from one state to another when initiated by an internal or external triggering event, which is called a transition. +An FSM implementation is defined by a list of its states, its initial state, and the triggering events for each possible transition. +An FSM implementation is composed out of two parts, a set of state transition rules, and an implementation set of state transition handlers, implementing those transitions.
+ +The FSM class supports a hierarchical implementation of a Finite State Machine, +that is, it allows to embed existing FSM implementations in a master FSM. +FSM hierarchies allow for efficient FSM re-use, not having to re-invent the wheel every time again when designing complex processes.
+ +
The above diagram shows a graphical representation of a FSM implementation for a Task, which guides a Human towards a Zone, +orders him to destroy x targets and account the results. +Other examples of ready made FSM could be:
+ +The MOOSE framework uses extensively the FSM class and derived FSM_ classes, +because the goal of MOOSE is to simplify mission design complexity for mission building. +By efficiently utilizing the FSM class and derived classes, MOOSE allows mission designers to quickly build processes. +Ready made FSM-based implementations classes exist within the MOOSE framework that can easily be re-used, +and tailored by mission designers through the implementation of Transition Handlers. +Each of these FSM implementation classes start either with:
+ +
The FSM class is the base class of all FSM_ derived classes.
- - -It implements the main functionality to define and execute Finite State Machines. +
The FSM class is the base class of all FSM_ derived classes. It implements the main functionality to define and execute Finite State Machines. The derived FSM_ classes extend the Finite State Machine functionality to run a workflow process for a specific purpose or component.
Finite State Machines have Transition Rules, Transition Handlers and Event Triggers.
@@ -753,13 +791,13 @@ Most of the time, these Event Triggers are used within the Transition Handler meAs explained above, a FSM supports Linear State Transitions and Hierarchical State Transitions, and both can be mixed to make a comprehensive FSM implementation. The below documentation has a seperate chapter explaining both transition modes, taking into account the Transition Rules, Transition Handlers and Event Triggers.
-Linear Transitions are Transition Rules allowing an FSM to transition from one or multiple possible From state(s) towards a To state upon a Triggered Event. The Lineair transition rule evaluation will always be done from the current state of the FSM. If no valid Transition Rule can be found in the FSM, the FSM will log an error and stop.
-The FSM has transition rules that it follows and validates, as it walks the process. These rules define when an FSM can transition from a specific state towards an other specific state upon a triggered event.
@@ -787,7 +825,7 @@ These rules define when an FSM can transition from a specific state towards an oNote that Linear Transition Rules can be declared in a few variations:
@@ -801,7 +839,7 @@ These rules define when an FSM can transition from a specific state towards an o FsmSwitch:AddTransition( { "On", "Middle" }, "SwitchOff", "Off" )
On top, each of these methods can have a variable amount of parameters passed. See the example in section 1.1.3.
-
Because ... When Event was asynchronously processed after 5 seconds, Amount was set to 2. So be careful when processing and passing values and objects in asynchronous processing!
-This example is fully implemented in the MOOSE test mission on GITHUB: FSM-100 - Transition Explanation
@@ -960,7 +998,7 @@ The transition for event Stop can be executed if the current state of the FSM isSo... When FsmDemo:Stop() is being triggered, the state of FsmDemo will transition from Red or Green to Stopped. And there is no transition handling method defined for that transition, thus, no new event is being triggered causing the FsmDemo process flow to halt.
-Hierarchical Transitions allow to re-use readily available and implemented FSMs. This becomes in very useful for mission building, where mission designers build complex processes and workflows, @@ -1582,7 +1620,7 @@ A string defining the start state.
The above menus classes are derived from 2 main abstract classes defined within the MOOSE framework (so don't use these):
+The underlying base menu classes are NOT to be used within your missions. -These are simply abstract base classes defining a couple of fields that are used by the -derived MENU_ classes to manage menus.
+The #MENU_BASE class defines the main MENU class where other MENU classes are derived from.
- -The #MENUCOMMANDBASE class defines the main MENU class where other MENU COMMAND_ classes are derived from, in order to set commands.
- -The next menus define the MENU classes that you can use within your missions.
- -The underlying classes manage the menus for a complete mission file.
- -The Menu#MENU_MISSION class manages the main menus for a complete mission.
-You can add menus with the MENU_MISSION.New method, which constructs a MENU_MISSION object and returns you the object reference.
-Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENU_MISSION.Remove.
The Menu#MENUMISSIONCOMMAND class manages the command menus for a complete mission, which allow players to execute functions during mission execution.
-You can add menus with the MENUMISSIONCOMMAND.New method, which constructs a MENUMISSIONCOMMAND object and returns you the object reference.
-Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENUMISSIONCOMMAND.Remove.
The underlying classes manage the menus for whole coalitions.
- -The Menu#MENU_COALITION class manages the main menus for coalitions.
-You can add menus with the MENU_COALITION.New method, which constructs a MENU_COALITION object and returns you the object reference.
-Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENU_COALITION.Remove.
The Menu#MENUCOALITIONCOMMAND class manages the command menus for coalitions, which allow players to execute functions during mission execution.
-You can add menus with the MENUCOALITIONCOMMAND.New method, which constructs a MENUCOALITIONCOMMAND object and returns you the object reference.
-Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENUCOALITIONCOMMAND.Remove.
The underlying classes manage the menus for groups. Note that groups can be inactive, alive or can be destroyed.
- -The Menu#MENU_GROUP class manages the main menus for coalitions.
-You can add menus with the MENU_GROUP.New method, which constructs a MENU_GROUP object and returns you the object reference.
-Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENU_GROUP.Remove.
The Menu#MENUGROUPCOMMAND class manages the command menus for coalitions, which allow players to execute functions during mission execution.
-You can add menus with the MENUGROUPCOMMAND.New method, which constructs a MENUGROUPCOMMAND object and returns you the object reference.
-Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENUGROUPCOMMAND.Remove.
The underlying classes manage the menus for units with skill level client or player.
- -The Menu#MENU_CLIENT class manages the main menus for coalitions.
-You can add menus with the MENU_CLIENT.New method, which constructs a MENU_CLIENT object and returns you the object reference.
-Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENU_CLIENT.Remove.
The Menu#MENUCLIENTCOMMAND class manages the command menus for coalitions, which allow players to execute functions during mission execution.
-You can add menus with the MENUCLIENTCOMMAND.New method, which constructs a MENUCLIENTCOMMAND object and returns you the object reference.
-Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENUCLIENTCOMMAND.Remove.
| MENU_BASE |
-
+MENU_BASE class, extends Base#BASE+The MENU_BASE class defines the main MENU class where other MENU classes are derived from. |
| MENU_CLIENT |
+MENU_CLIENT class, extends Menu#MENU_BASE+The MENU_CLIENT class manages the main menus for coalitions. |
| MENU_CLIENT_COMMAND |
+MENUCLIENTCOMMAND class, extends Menu#MENUCOMMANDBASE+The MENUCLIENTCOMMAND class manages the command menus for coalitions, which allow players to execute functions during mission execution. |
| MENU_COALITION |
+MENU_COALITION class, extends Menu#MENU_BASE+The Menu#MENU_COALITION class manages the main menus for coalitions. |
| MENU_COALITION_COMMAND |
+MENUCOALITIONCOMMAND class, extends Menu#MENUCOMMANDBASE+The MENUCOALITIONCOMMAND class manages the command menus for coalitions, which allow players to execute functions during mission execution. |
| MENU_COMMAND_BASE |
-
+MENUCOMMANDBASE class, extends Base#BASE++ The MENUCOMMANDBASE class defines the main MENU class where other MENU COMMAND_ +classes are derived from, in order to set commands. |
| MENU_GROUP |
+MENU_GROUP class, extends Menu#MENU_BASE+The MENU_GROUP class manages the main menus for coalitions. |
| MENU_GROUP_COMMAND |
+MENUGROUPCOMMAND class, extends Menu#MENUCOMMANDBASE+The Menu#MENUGROUPCOMMAND class manages the command menus for coalitions, which allow players to execute functions during mission execution. |
| MENU_MISSION |
+MENU_MISSION class, extends Menu#MENU_BASE+The MENU_MISSION class manages the main menus for a complete mission. |
| MENU_MISSION_COMMAND |
+MENUMISSIONCOMMAND class, extends Menu#MENUCOMMANDBASE+The MENUMISSIONCOMMAND class manages the command menus for a complete mission, which allow players to execute functions during mission execution. |
MENU_BASE| MENU_BASE.ClassName | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_BASE:GetMenu(MenuText) | - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_BASE.MenuParentPath | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_BASE.MenuPath | -- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_BASE.MenuRemoveParent | - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_BASE.MenuText | -- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_CLIENT.ClassName | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_CLIENT:New(Client, MenuText, ParentMenu) |
MENU_CLIENT constructor. @@ -367,12 +287,6 @@ Using this object reference, you can then remove ALL the menus and submenus undeType
|
| MENU_CLIENT_COMMAND.ClassName | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_CLIENT_COMMAND:New(Client, MenuText, ParentMenu, CommandMenuFunction, ...) |
MENUCLIENTCOMMAND constructor. @@ -389,12 +303,6 @@ Using this object reference, you can then remove ALL the menus and submenus undeType
|
| MENU_COALITION.ClassName | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_COALITION:New(Coalition, MenuText, ParentMenu) |
MENU_COALITION constructor. @@ -417,12 +325,6 @@ Using this object reference, you can then remove ALL the menus and submenus undeType
|
| MENU_COALITION_COMMAND.ClassName | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_COALITION_COMMAND:New(Coalition, MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument, ...) |
MENU_COALITION constructor. @@ -439,24 +341,6 @@ Using this object reference, you can then remove ALL the menus and submenus undeType
|
| MENU_COMMAND_BASE.ClassName | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_COMMAND_BASE.CommandMenuArgument | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_COMMAND_BASE.CommandMenuFunction | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_COMMAND_BASE.MenuCallHandler |
@@ -473,12 +357,6 @@ Using this object reference, you can then remove ALL the menus and submenus unde
Type
|
| MENU_GROUP.ClassName | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_GROUP.MenuGroup |
@@ -537,12 +415,6 @@ Using this object reference, you can then remove ALL the menus and submenus unde
Type
|
| MENU_GROUP_COMMAND.ClassName | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_GROUP_COMMAND.MenuGroup |
@@ -595,12 +467,6 @@ Using this object reference, you can then remove ALL the menus and submenus unde
Type
|
| MENU_MISSION.ClassName | -- - | -||||||||||||||||||||||||||||||||||||||||||||||||||
| MENU_MISSION:New(MenuText, ParentMenu) |
MENU_MISSION constructor. @@ -623,12 +489,6 @@ Using this object reference, you can then remove ALL the menus and submenus undeType
|
| MENU_MISSION_COMMAND.ClassName | -- - | -||||||||||||||||
| MENU_MISSION_COMMAND:New(MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument, ...) |
MENU_MISSION constructor. @@ -653,7 +513,11 @@ Using this object reference, you can then remove ALL the menus and submenus undeMENU_BASE class, extends Base#BASE+The MENU_BASE class defines the main MENU class where other MENU classes are derived from. + +This is an abstract class, so don't use it. MENU_CLIENT class, extends Menu#MENU_BASE+The MENU_CLIENT class manages the main menus for coalitions. + + +You can add menus with the MENU_CLIENT.New method, which constructs a MENU_CLIENT object and returns you the object reference. +Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENU_CLIENT.Remove. + + +Usage:+MENUCLIENTCOMMAND class, extends Menu#MENUCOMMANDBASE+ +The MENUCLIENTCOMMAND class manages the command menus for coalitions, which allow players to execute functions during mission execution. + + +You can add menus with the MENUCLIENTCOMMAND.New method, which constructs a MENUCLIENTCOMMAND object and returns you the object reference. +Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENUCLIENTCOMMAND.Remove. MENU_COALITION class, extends Menu#MENU_BASE+The Menu#MENU_COALITION class manages the main menus for coalitions. + + +You can add menus with the MENU_COALITION.New method, which constructs a MENU_COALITION object and returns you the object reference. +Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENU_COALITION.Remove. + + + +Usage:+MENUCOALITIONCOMMAND class, extends Menu#MENUCOMMANDBASE+ +The MENUCOALITIONCOMMAND class manages the command menus for coalitions, which allow players to execute functions during mission execution. + + +You can add menus with the MENUCOALITIONCOMMAND.New method, which constructs a MENUCOALITIONCOMMAND object and returns you the object reference. +Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENUCOALITIONCOMMAND.Remove. MENUCOMMANDBASE class, extends Base#BASE++ The MENUCOMMANDBASE class defines the main MENU class where other MENU COMMAND_ +classes are derived from, in order to set commands. MENU_GROUP class, extends Menu#MENU_BASE+The MENU_GROUP class manages the main menus for coalitions. + + +You can add menus with the MENU_GROUP.New method, which constructs a MENU_GROUP object and returns you the object reference. +Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENU_GROUP.Remove. + + +Usage:+MENUGROUPCOMMAND class, extends Menu#MENUCOMMANDBASE+ +The Menu#MENUGROUPCOMMAND class manages the command menus for coalitions, which allow players to execute functions during mission execution. + + +You can add menus with the MENUGROUPCOMMAND.New method, which constructs a MENUGROUPCOMMAND object and returns you the object reference. +Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENUGROUPCOMMAND.Remove. MENU_MISSION class, extends Menu#MENU_BASE+The MENU_MISSION class manages the main menus for a complete mission. + + +You can add menus with the MENU_MISSION.New method, which constructs a MENU_MISSION object and returns you the object reference. +Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENU_MISSION.Remove. MENUMISSIONCOMMAND class, extends Menu#MENUCOMMANDBASE+ +The MENUMISSIONCOMMAND class manages the command menus for a complete mission, which allow players to execute functions during mission execution. + + +You can add menus with the MENUMISSIONCOMMAND.New method, which constructs a MENUMISSIONCOMMAND object and returns you the object reference. +Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENUMISSIONCOMMAND.Remove. Type
|
| MESSAGE |
+MESSAGE class, extends Base#BASE+Message System to display Messages to Clients, Coalitions or All. |
MESSAGE| MESSAGE.ClassName | -- - | -||||
| MESSAGE.MessageCategory | -- - | -||||
| MESSAGE.MessageID | -- - | -||||
| MESSAGE:New(MessageText, MessageDuration, MessageCategory) |
Creates a new MESSAGE object. @@ -232,6 +182,40 @@ To send messages, you need to use the To functions.MESSAGE class, extends Base#BASE+ +Message System to display Messages to Clients, Coalitions or All. + + +Messages are shown on the display panel for an amount of seconds, and will then disappear. +Messages can contain a category which is indicating the category of the message. + +MESSAGE construction+ +Messages are created with Message#MESSAGE.New. Note that when the MESSAGE object is created, no message is sent yet. +To send messages, you need to use the To functions. + +Send messages to an audience+ +Messages are sent: + +
Send conditionally to an audience+ +Messages can be sent conditionally to an audience (when a condition is true): + +
1) Point#POINT_VEC3 class, extends Base#BASE-The Point#POINT_VEC3 class defines a 3D point in the simulator. +
Important Note: Most of the functions in this section were taken from MIST, and reworked to OO concepts. -In order to keep the credibility of the the author, I want to emphasize that the of the MIST framework was created by Grimes, who you can find on the Eagle Dynamics Forums. +- 1.1) POINT_VEC3 constructor+Demo Missions-A new POINT_VEC3 instance can be created with: +POINT_VEC Demo Missions source code-
POINT_VEC Demo Missions, only for beta testers-1.2) Manupulate the X, Y, Z coordinates of the point+ALL Demo Missions pack of the last release-A POINT_VEC3 class works in 3D space. It contains internally an X, Y, Z coordinate. -Methods exist to manupulate these coordinates. +- The current X, Y, Z axis can be retrieved with the methods POINT_VEC3.GetX(), POINT_VEC3.GetY(), POINT_VEC3.GetZ() respectively. -The methods POINT_VEC3.SetX(), POINT_VEC3.SetY(), POINT_VEC3.SetZ() change the respective axis with a new value. -The current axis values can be changed by using the methods POINT_VEC3.AddX(), POINT_VEC3.AddY(), POINT_VEC3.AddZ() -to add or substract a value from the current respective axis value. -Note that the Set and Add methods return the current POINT_VEC3 object, so these manipulation methods can be chained... For example: +YouTube Channel-1.3) Create waypoints for routes- -A POINT_VEC3 can prepare waypoints for Ground, Air and Naval groups to be embedded into a Route. - - -1.5) Smoke, flare, explode, illuminate- -At the point a smoke, flare, explosion and illumination bomb can be triggered. Use the following methods: - -1.5.1) Smoke- -
1.5.2) Flare- -
1.5.3) Explode- -
1.5.4) Illuminate- -
2) Point#POINT_VEC2 class, extends Point#POINT_VEC3-The Point#POINT_VEC2 class defines a 2D point in the simulator. The height coordinate (if needed) will be the land height + an optional added height specified. - -2.1) POINT_VEC2 constructor-A new POINT_VEC2 instance can be created with: - -
1.2) Manupulate the X, Altitude, Y coordinates of the 2D point- -A POINT_VEC2 class works in 2D space, with an altitude setting. It contains internally an X, Altitude, Y coordinate. -Methods exist to manupulate these coordinates. - -The current X, Altitude, Y axis can be retrieved with the methods POINT_VEC2.GetX(), POINT_VEC2.GetAlt(), POINT_VEC2.GetY() respectively. -The methods POINT_VEC2.SetX(), POINT_VEC2.SetAlt(), POINT_VEC2.SetY() change the respective axis with a new value. -The current Lat(itude), Alt(itude), Lon(gitude) values can also be retrieved with the methods POINT_VEC2.GetLat(), POINT_VEC2.GetAlt(), POINT_VEC2.GetLon() respectively. -The current axis values can be changed by using the methods POINT_VEC2.AddX(), POINT_VEC2.AddAlt(), POINT_VEC2.AddY() -to add or substract a value from the current respective axis value. -Note that the Set and Add methods return the current POINT_VEC2 object, so these manipulation methods can be chained... For example: - -POINT_VEC YouTube Channel@@ -238,13 +158,17 @@ Note that the Set and Add methods return the current POINT_VEC2 object, so these POINT_VEC2 |
+ |
POINT_VEC2 class, extends Point#POINT_VEC3+The Point#POINT_VEC2 class defines a 2D point in the simulator. POINT_VEC3 |
+ |
POINT_VEC3 class, extends Base#BASE+POINT_VEC3 defines a 3D point in the simulator and with its methods, you can use or manipulate the point in 3D space. |
Add to the y coordinate of the POINT_VEC2.
-Add to the z coordinate of the POINT_VEC3.
-Return a BR string from a POINTVEC3 to the POINTVEC3.
+Return an angle in degrees from the POINT_VEC3 using a direction vector in Vec3 format.
Return a direction in radians from the POINT_VEC3 using a direction vector in Vec3 format.
+Return an angle in radians from the POINT_VEC3 using a direction vector in Vec3 format.
+Return a BR string from a POINTVEC3 to the POINTVEC3.
The Point#POINT_VEC2 class defines a 2D point in the simulator.
+ + +The height coordinate (if needed) will be the land height + an optional added height specified.
+ +A new POINT_VEC2 instance can be created with:
+ +A POINT_VEC2 class works in 2D space, with an altitude setting. It contains internally an X, Altitude, Y coordinate. +Methods exist to manupulate these coordinates.
+ +The current X, Altitude, Y axis can be retrieved with the methods POINT_VEC2.GetX(), POINT_VEC2.GetAlt(), POINT_VEC2.GetY() respectively. +The methods POINT_VEC2.SetX(), POINT_VEC2.SetAlt(), POINT_VEC2.SetY() change the respective axis with a new value. +The current Lat(itude), Alt(itude), Lon(gitude) values can also be retrieved with the methods POINT_VEC2.GetLat(), POINT_VEC2.GetAlt(), POINT_VEC2.GetLon() respectively. +The current axis values can be changed by using the methods POINT_VEC2.AddX(), POINT_VEC2.AddAlt(), POINT_VEC2.AddY() +to add or substract a value from the current respective axis value. +Note that the Set and Add methods return the current POINT_VEC2 object, so these manipulation methods can be chained... For example:
+ +
local Vec2 = PointVec2:AddX( 100 ):AddY( 2000 ):GetVec2()
+
+POINT_VEC3 defines a 3D point in the simulator and with its methods, you can use or manipulate the point in 3D space.
+ + + +Important Note: Most of the functions in this section were taken from MIST, and reworked to OO concepts. +In order to keep the credibility of the the author, +I want to emphasize that the formulas embedded in the MIST framework were created by Grimes or previous authors, +who you can find on the Eagle Dynamics Forums.
+ + +A new POINT_VEC3 object can be created with:
+ +A POINT_VEC3 class works in 3D space. It contains internally an X, Y, Z coordinate. +Methods exist to manupulate these coordinates.
+ +The current X, Y, Z axis can be retrieved with the methods POINT_VEC3.GetX(), POINT_VEC3.GetY(), POINT_VEC3.GetZ() respectively. +The methods POINT_VEC3.SetX(), POINT_VEC3.SetY(), POINT_VEC3.SetZ() change the respective axis with a new value. +The current axis values can be changed by using the methods POINT_VEC3.AddX(), POINT_VEC3.AddY(), POINT_VEC3.AddZ() +to add or substract a value from the current respective axis value. +Note that the Set and Add methods return the current POINT_VEC3 object, so these manipulation methods can be chained... For example:
+ + local Vec3 = PointVec3:AddX( 100 ):AddZ( 150 ):GetVec3()
+A POINT_VEC3 can prepare waypoints for Ground and Air groups to be embedded into a Route.
+ +Route points can be used in the Route methods of the Group#GROUP class.
+ + +At the point a smoke, flare, explosion and illumination bomb can be triggered. Use the following methods:
+ +Various calculation methods exist to use or manipulate 3D space. Find below a short description of each method:
+ +Various methods exist to calculate random locations around a given 3D point.
+ +PointPOINT_VEC2The POINT_VEC2 class
- -Return an angle in degrees from the POINT_VEC3 using a direction vector in Vec3 format.
+ +Dcs.DCSTypes#Vec3 DirectionVec3 :
+The direction vector in Vec3 format.
#number: +DirectionRadians The angle in degrees.
+ +Return an angle in radians from the POINT_VEC3 using a direction vector in Vec3 format.
+ +Dcs.DCSTypes#Vec3 DirectionVec3 :
+The direction vector in Vec3 format.
#number: +DirectionRadians The angle in radians.
+ +Return a direction in radians from the POINT_VEC3 using a direction vector in Vec3 format.
- -Dcs.DCSTypes#Vec3 DirectionVec3 :
-The direction vector in Vec3 format.
#number: -DirectionRadians The direction in radians.
- -The Scheduler#SCHEDULER class creates schedule.
- -The SCHEDULER class is quite easy to use, but note that the New constructor has variable parameters:
+SCHEDULER manages the scheduling of functions:
The SCHEDULER can be stopped and restarted with the following methods:
+With Scheduler#SCHEDULER.Schedule() a new time event can be scheduled. This function is used by the :New() constructor when a new schedule is planned.
+The SCHEDULER class creates schedule.
SCHEDULER| SCHEDULER.ClassName | -- - | -||
| SCHEDULER:Clear() |
Clears all pending schedules. @@ -203,12 +190,6 @@ | SCHEDULER.SchedulerObject | - | -
| SCHEDULER.Schedules | -- | ||
| SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) | + | +||
| SPAWN.uncontrolled | ++ |
Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.
-Overwrite unit names by default with group name.
-Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.
+When the first Spawn executes, all the Groups need to be made visible before start.
Add a PlayerUnit to join the Task.
-For each Group within the Task, the Unit is check if it can join the Task. +
For each Group within the Task, the Unit is checked if it can join the Task. If the Unit was not part of the Task, false is returned. If the Unit is part of the Task, true is returned.
diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index d6a95cfc8..b2cbf3569 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -190,6 +190,18 @@ and various dedicated deployment zones.Core.Set#SET_CARGO: +The Cargo Set.
+ +#list: +Core.Zone#ZONE_BASE> The Deployment Zones.
+ +#boolean:
+ +listConstructor to create a ZONE_GROUP instance, taking the zone name, a zone Group#GROUP and a radius.
-Constructor to create a ZONEPOLYGONBASE instance, taking the zone name and an array of DCSTypes#Vec2, forming a polygon.
-The polygon defined by an array of DCSTypes#Vec2.
ZONE_BASEThe ZONE_BASE class
- -#ZONE_GROUP: self
- -#ZONEPOLYGONBASE: self
- - -The polygon defined by an array of DCSTypes#Vec2.
-The AIBalancer#AIBALANCER class monitors and manages as many replacement AI groups as there are -CLIENTS in a SET_CLIENT collection, which are not occupied by human players.
+The underlying change log documents the API changes.