Module Functional.Fox
Functional - Yet Another Missile Trainer.
Practice to evade missiles without being destroyed.
Main Features:
- Handles air-to-air and surface-to-air missiles.
- Define your own training zones on the map. Players in this zone will be protected.
- Define launch zones. Only missiles launched in these zones are tracked.
- Define protected AI groups.
- F10 radio menu to adjust settings for each player.
- Alert on missile launch (optional).
- Marker of missile launch position (optional).
- Adaptive update of missile-to-player distance.
- Finite State Machine (FSM) implementation.
- Easy to use. See examples below.
Demo Missions
Author: funkyfranky
Global(s)
Global FOX |
Fox 3!
The FOX ConceptAs you probably know Fox is a NATO brevity code for launching air-to-air munition. |
Fox 3!
The FOX Concept
As you probably know Fox is a NATO brevity code for launching air-to-air munition.
Therefore, the class name is not 100% accurate as this script handles air-to-air but also surface-to-air missiles.
Basic Script
-- Create a new missile trainer object.
fox=FOX:New()
-- Start missile trainer.
fox:Start()
Training Zones
Players are only protected if they are inside one of the training zones.
-- Create a new missile trainer object.
fox=FOX:New()
-- Add training zones.
fox:AddSafeZone(ZONE:New("Training Zone Alpha"))
fox:AddSafeZone(ZONE:New("Training Zone Bravo"))
-- Start missile trainer.
fox:Start()
Launch Zones
Missile launches are only monitored if the shooter is inside the defined launch zone.
-- Create a new missile trainer object.
fox=FOX:New()
-- Add training zones.
fox:AddLaunchZone(ZONE:New("Launch Zone SA-10 Krim"))
fox:AddLaunchZone(ZONE:New("Training Zone Bravo"))
-- Start missile trainer.
fox:Start()
Protected AI Groups
Define AI protected groups. These groups cannot be harmed by missiles.
Add Individual Groups
-- Create a new missile trainer object.
fox=FOX:New()
-- Add single protected group(s).
fox:AddProtectedGroup(GROUP:FindByName("A-10 Protected"))
fox:AddProtectedGroup(GROUP:FindByName("Yak-40"))
-- Start missile trainer.
fox:Start()
Notes
The script needs to be running before you enter an airplane slot. If FOX is not available to you, go back to observers and then join a slot again.
Type(s)
| Fields and Methods inherited from FOX | Description |
|---|---|
|
Add a launch zone. |
|
|
Add a group to the protected set. |
|
|
Add a training zone. |
|
|
Name of the class. |
|
|
Debug mode. Messages to all about status. |
|
|
Triggers the FSM event "EnterSafeZone". |
|
|
Triggers the FSM event "ExitSafeZone". |
|
|
Get missile target. |
|
|
Main radio menu on group level. |
|
|
Main radio menu on mission level. |
|
|
Triggers the FSM event "MissileDestroyed". |
|
|
Triggers the FSM event "MissileLaunch". |
|
|
Create a new FOX class object. |
|
|
On after "EnterSafeZone" event user function. |
|
|
On after "ExitSafeZone" event user function. |
|
|
On after "MissileDestroyed" event user function. |
|
|
On after "MissileLaunch" event user function. |
|
|
FOX event handler for event birth. |
|
|
FOX event handler for event hit. |
|
|
FOX event handler for event birth. |
|
|
FOX event handler for event shot (when a unit releases a rocket or bomb (but not a fast firing gun). |
|
|
Set debug mode off. |
|
|
Set debug mode on. |
|
|
Set debug mode on/off. |
|
|
Set default player setting for launch alerts. |
|
|
Set default player setting for marking missile launch coordinates |
|
|
Set default player setting for missile destruction. |
|
|
Disable F10 menu for all players. |
|
|
Enable F10 menu for all players. |
|
|
Set missile-player distance when missile is destroyed. |
|
FOX:SetExplosionDistanceBigMissiles(distance, explosivemass) |
Set missile-player distance when BIG missiles are destroyed. |
|
Set explosion power. |
|
|
Add a protected set of groups. |
|
|
Set verbosity level. |
|
|
Triggers the FSM event "Start". |
|
|
Triggers the FSM event "Status". |
|
|
Add menu commands for player. |
|
|
Check if a coordinate lies within a launch zone. |
|
|
Check if a coordinate lies within a safe training zone. |
|
|
Missile status. |
|
|
Check status of players. |
|
|
Get a random text message in case you die. |
|
|
Callback function on impact or destroy otherwise. |
|
|
Function called from weapon tracking. |
|
|
Returns the unit of a player and the player name. |
|
|
Retruns the player data from a unit. |
|
|
Returns the player data from a unit name. |
|
|
Returns the unit of a player and the player name. |
|
|
Turn player's launch alert on/off. |
|
|
Returns the unit of a player and the player name. |
|
|
Check if missile target is protected. |
|
|
Turn player's launch alert on/off. |
|
|
Remove missile. |
|
|
Tell player notching headings. |
|
|
Turn destruction of missiles on/off for player. |
|
|
Turn player's launch alert on/off. |
|
|
Turn player's launch marks on/off. |
|
|
Triggers the FSM delayed event "EnterSafeZone". |
|
|
Triggers the FSM delayed event "ExitSafeZone". |
|
|
Triggers the FSM delayed event "MissileDestroyed". |
|
|
Triggers the FSM delayed event "MissileLaunch". |
|
|
Triggers the FSM event "Start" after a delay. |
|
|
Triggers the FSM event "Status" after a delay. |
|
|
Triggers the FSM event "Stop" after a delay. |
|
|
Explosion power of big missiles. Default 50 kg TNT. Big missiles will be destroyed earlier. |
|
|
Default player setting for destroying missiles. |
|
|
Time step [sec] for missile position updates if distance to target < 1 km. Default 0.01 sec. |
|
|
Time step [sec] for missile position updates if distance to target > 1 km and < 5 km. Default 0.1 sec. |
|
|
Time step [sec] for missile position updates if distance to target > 5 km and < 10 km. Default 0.5 sec. |
|
|
Time step [sec] for missile position updates if distance to target > 10 km and < 50 km. Default 1 sec. |
|
|
Time step [sec] for missile position updates if distance to target > 50 km. Default 5 sec. |
|
|
Missile player distance in meters for destroying smaller missiles. Default 200 m. |
|
|
Missile player distance in meters for destroying big missiles. Default 500 m. |
|
|
Power of explostion when destroying the missile in kg TNT. Default 5 kg TNT. |
|
|
Default player setting for launch alerts. |
|
|
Table of launch zones. |
|
|
Class id string for output to DCS log file. |
|
|
Default player setting for mark launch coordinates. |
|
|
Table of groups the menu was added for. |
|
|
If true, F10 menu for players is disabled. |
|
|
Table of tracked missiles. |
|
|
Missle launch event. |
|
|
On after Start event. |
|
|
Check spawn queue and spawn aircraft if necessary. |
|
|
On after Stop event. |
|
|
Table of players. |
|
|
Set of protected groups. |
|
|
Table of practice zones. |
|
|
Verbosity level. |
|
|
FOX class version. |
| Fields and Methods inherited from FSM | Description |
|---|---|
|
Adds an End state. |
|
|
Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task. |
|
|
Adds a score for the FSM to be achieved. |
|
|
Adds a score for the FSM_PROCESS to be achieved. |
|
|
Add a new transition rule to the FSM. |
|
|
Get current state. |
|
|
Returns the End states. |
|
|
Returns a table of the SubFSM rules defined within the FSM. |
|
|
Returns a table with the scores defined. |
|
|
Returns the start state of the FSM. |
|
|
Get current state. |
|
|
Returns a table with the Subs defined. |
|
|
Returns a table of the transition rules defined within the FSM. |
|
|
Check if FSM is in state. |
|
|
Load call backs. |
|
|
Creates a new FSM object. |
|
|
Sets the start state of the FSM. |
|
|
Add to map. |
|
|
Call handler. |
|
|
Create transition. |
|
|
Delayed transition. |
|
|
Event map. |
|
|
Go sub. |
|
|
Handler. |
|
|
Is end state. |
|
|
Sub maps. |
|
|
Check if can do an event. |
|
|
Check if cannot do an event. |
|
|
Check if FSM is in state. |
|
| Fields and Methods inherited from FOX.MissileData | Description |
|---|---|
|
Weapon object. |
|
|
If true the missile is active. |
|
|
Explosive mass in kg TNT. |
|
|
Fuse distance in meters. |
|
|
Missile coordinate during tracking. |
|
|
Name of missile. |
|
|
Range of missile in meters. |
|
|
Type of missile. |
|
|
Coalition side of the shooter. |
|
|
Group that shot the missile. |
|
|
Name of the shooter unit. |
|
|
Unit that shot the missile. |
|
|
Coordinate where the missile was fired. |
|
|
Abs. mission time in seconds the missile was fired. |
|
|
Name of the target unit or "unknown". |
|
|
Name of the "original" target, i.e. the one right after launched. |
|
|
Player that was targeted or nil. |
|
|
Unit that was targeted. |
|
|
Missile weapon object. |
| Fields and Methods inherited from FOX.PlayerData | Description |
|---|---|
|
Callsign of player. |
|
|
Client object of player. |
|
|
Coalition number of player. |
|
|
Number of missiles not defeated. |
|
|
Number of missiles defeated. |
|
|
Destroy missile. |
|
|
Aircraft group of player. |
|
|
Name of the the player aircraft group. |
|
|
Player is inside a protected zone. |
|
|
Alert player on detected missile launch. |
|
|
Mark position of launched missile on F10 map. |
|
|
Player name. |
|
|
Aircraft of the player. |
|
|
Name of the unit. |
FOX class.
Field(s)
Name of the class.
Debug mode. Messages to all about status.
Main radio menu on group level.
Main radio menu on mission level.
Explosion power of big missiles. Default 50 kg TNT. Big missiles will be destroyed earlier.
Default player setting for destroying missiles.
Time step [sec] for missile position updates if distance to target < 1 km. Default 0.01 sec.
Time step [sec] for missile position updates if distance to target > 1 km and < 5 km. Default 0.1 sec.
Time step [sec] for missile position updates if distance to target > 5 km and < 10 km. Default 0.5 sec.
Time step [sec] for missile position updates if distance to target > 10 km and < 50 km. Default 1 sec.
Time step [sec] for missile position updates if distance to target > 50 km. Default 5 sec.
Missile player distance in meters for destroying smaller missiles. Default 200 m.
Missile player distance in meters for destroying big missiles. Default 500 m.
Power of explostion when destroying the missile in kg TNT. Default 5 kg TNT.
Default player setting for launch alerts.
Table of launch zones.
Class id string for output to DCS log file.
Default player setting for mark launch coordinates.
Table of groups the menu was added for.
If true, F10 menu for players is disabled.
Table of tracked missiles.
Table of players.
Table of practice zones.
Verbosity level.
FOX class version.
Function(s)
Add a launch zone.
Only missiles launched within these zones will be tracked.
Add a group to the protected set.
Works only with AI!
Add a training zone.
Players in the zone are safe.
Triggers the FSM event "EnterSafeZone".
Triggers the FSM event "ExitSafeZone".
Get missile target.
Triggers the FSM event "MissileDestroyed".
Triggers the FSM event "MissileLaunch".
On after "EnterSafeZone" event user function.
Called when a player enters a safe zone.
Defined in:
FOX
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
#FOX.PlayerData player
Player data.
On after "ExitSafeZone" event user function.
Called when a player exists a safe zone.
Defined in:
FOX
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
#FOX.PlayerData player
Player data.
On after "MissileDestroyed" event user function.
Called when a missile was destroyed.
Defined in:
FOX
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
#FOX.MissileData missile
Data of the destroyed missile.
On after "MissileLaunch" event user function.
Called when a missile was launched.
Defined in:
FOX
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
#FOX.MissileData missile
Data of the fired missile.
FOX event handler for event birth.
FOX event handler for event hit.
FOX event handler for event birth.
FOX event handler for event shot (when a unit releases a rocket or bomb (but not a fast firing gun).
Set debug mode on/off.
Defined in:
FOX
Parameter:
#boolean switch
If true debug mode on. If false/nil debug mode off.
Return value:
#FOX:
self
Set default player setting for launch alerts.
Defined in:
FOX
Parameter:
#boolean switch
If true launch alerts to players are active. If false/nil no launch alerts are given.
Return value:
#FOX:
self
Set default player setting for marking missile launch coordinates
Defined in:
FOX
Parameter:
#boolean switch
If true missile launches are marked. If false/nil marks are disabled.
Return value:
#FOX:
self
Set default player setting for missile destruction.
Defined in:
FOX
Parameter:
#boolean switch
If true missiles are destroyed. If false/nil missiles are not destroyed.
Return value:
#FOX:
self
Set missile-player distance when missile is destroyed.
Defined in:
FOX
Parameter:
#number distance
Distance in meters. Default 200 m.
Return value:
#FOX:
self
Set missile-player distance when BIG missiles are destroyed.
Defined in:
FOX
Parameters:
#number distance
Distance in meters. Default 500 m.
#number explosivemass
Explosive mass of missile threshold in kg TNT. Default 50 kg.
Return value:
#FOX:
self
Set explosion power.
This is an "artificial" explosion generated when the missile is destroyed. Just for the visual effect. Don't set the explosion power too big or it will harm the aircraft in the vicinity.
Defined in:
FOX
Parameter:
#number power
Explosion power in kg TNT. Default 0.1 kg.
Return value:
#FOX:
self
Add a protected set of groups.
Set verbosity level.
Defined in:
FOX
Parameter:
#number VerbosityLevel
Level of output (higher=more). Default 0.
Return value:
#FOX:
self
Triggers the FSM event "Start".
Starts the FOX. Initializes parameters and starts event handlers.
Defined in:
FOX
Add menu commands for player.
Defined in:
FOX
Parameter:
#string _unitName
Name of player unit.
Check if a coordinate lies within a launch zone.
Defined in:
FOX
Parameter:
Core.Point#COORDINATE coord
Coordinate to check. Can also be a DCS#Vec2.
Return value:
#boolean:
True if in launch zone.
Check if a coordinate lies within a safe training zone.
Defined in:
FOX
Parameter:
Core.Point#COORDINATE coord
Coordinate to check. Can also be a DCS#Vec3.
Return value:
#boolean:
True if safe.
Get a random text message in case you die.
Defined in:
FOX
Return value:
#string:
Text in case you die.
Callback function on impact or destroy otherwise.
Defined in:
FOX
Parameters:
Wrapper.Weapon#WEAPON weapon
Weapon object.
#FOX self
FOX object.
#FOX.MissileData missile
Fired missile.
Function called from weapon tracking.
Defined in:
FOX
Parameters:
Wrapper.Weapon#WEAPON weapon
Weapon object.
#FOX self
FOX object.
#FOX.MissileData missile
Fired missile
Returns the unit of a player and the player name.
If the unit does not belong to a player, nil is returned.
Defined in:
FOX
Parameter:
DCS#Weapon weapon
The weapon.
Return values:
#number:
Notching heading right, i.e. missile heading +90°.
#number:
Notching heading left, i.e. missile heading -90°.
Retruns the player data from a unit.
Returns the player data from a unit name.
Defined in:
FOX
Parameter:
#string unitName
Name of the unit.
Return value:
Player data.
Returns the unit of a player and the player name.
If the unit does not belong to a player, nil is returned.
Defined in:
FOX
Parameter:
#string _unitName
Name of the player unit.
Return values:
Turn player's launch alert on/off.
Defined in:
FOX
Parameter:
#string playername
Name of the player.
Return values:
#number:
Number of missiles targeting the player.
#string:
Missile info.
Returns the unit of a player and the player name.
If the unit does not belong to a player, nil is returned.
Defined in:
FOX
Parameter:
DCS#Weapon weapon
The weapon.
Return value:
#number:
Heading of weapon in degrees or -1.
Check if missile target is protected.
Defined in:
FOX
Parameter:
Wrapper.Unit#UNIT targetunit
Target unit.
Return value:
#boolean:
If true, unit is protected.
Turn player's launch alert on/off.
Defined in:
FOX
Parameter:
#string _unitname
Name of the player unit.
Remove missile.
Tell player notching headings.
Turn destruction of missiles on/off for player.
Defined in:
FOX
Parameter:
#string _unitname
Name of the player unit.
Turn player's launch alert on/off.
Defined in:
FOX
Parameter:
#string _unitname
Name of the player unit.
Turn player's launch marks on/off.
Defined in:
FOX
Parameter:
#string _unitname
Name of the player unit.
Triggers the FSM delayed event "EnterSafeZone".
Defined in:
FOX
Parameters:
#number delay
Delay in seconds before the function is called.
#FOX.PlayerData player
Player data.
Triggers the FSM delayed event "ExitSafeZone".
Defined in:
FOX
Parameters:
#number delay
Delay in seconds before the function is called.
#FOX.PlayerData player
Player data.
Triggers the FSM delayed event "MissileDestroyed".
Defined in:
FOX
Parameters:
#number delay
Delay in seconds before the function is called.
#FOX.MissileData missile
Data of the destroyed missile.
Triggers the FSM delayed event "MissileLaunch".
Defined in:
FOX
Parameters:
#number delay
Delay in seconds before the function is called.
#FOX.MissileData missile
Data of the fired missile.
Triggers the FSM event "Start" after a delay.
Starts the FOX. Initializes parameters and starts event handlers.
Defined in:
FOX
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Status" after a delay.
Defined in:
FOX
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Stop" after a delay.
Stops the FOX and all its event handlers.
Defined in:
FOX
Parameter:
#number delay
Delay in seconds.
Missle launch event.
Defined in:
FOX
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
#FOX.MissileData missile
Fired missile
On after Start event.
Starts the missile trainer and adds event handlers.
Defined in:
FOX
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Check spawn queue and spawn aircraft if necessary.
Defined in:
FOX
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after Stop event.
Stops the missile trainer and unhandles events.
Defined in:
FOX
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Field(s)
Name of the class.
Debug mode. Messages to all about status.
Main radio menu on group level.
Main radio menu on mission level.
Explosion power of big missiles. Default 50 kg TNT. Big missiles will be destroyed earlier.
Default player setting for destroying missiles.
Time step [sec] for missile position updates if distance to target < 1 km. Default 0.01 sec.
Time step [sec] for missile position updates if distance to target > 1 km and < 5 km. Default 0.1 sec.
Time step [sec] for missile position updates if distance to target > 5 km and < 10 km. Default 0.5 sec.
Time step [sec] for missile position updates if distance to target > 10 km and < 50 km. Default 1 sec.
Time step [sec] for missile position updates if distance to target > 50 km. Default 5 sec.
Missile player distance in meters for destroying smaller missiles. Default 200 m.
Missile player distance in meters for destroying big missiles. Default 500 m.
Power of explostion when destroying the missile in kg TNT. Default 5 kg TNT.
Default player setting for launch alerts.
Table of launch zones.
Class id string for output to DCS log file.
Default player setting for mark launch coordinates.
Table of groups the menu was added for.
If true, F10 menu for players is disabled.
Table of tracked missiles.
Table of players.
Table of practice zones.
Verbosity level.
FOX class version.
Function(s)
Adds an End state.
Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.
Defined in:
Parameters:
#table From
Can contain a string indicating the From state or a table of strings containing multiple From states.
#string Event
The Event name.
Core.Fsm#FSM_PROCESS Process
An sub-process FSM.
#table ReturnEvents
A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.
Return value:
The SubFSM.
Adds a score for the FSM to be achieved.
Defined in:
Parameters:
#string State
is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).
#string ScoreText
is a text describing the score that is given according the status.
#number Score
is a number providing the score of the status.
Return value:
#FSM:
self
Adds a score for the FSM_PROCESS to be achieved.
Defined in:
Parameters:
#string From
is the From State of the main process.
#string Event
is the Event of the main process.
#string State
is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).
#string ScoreText
is a text describing the score that is given according the status.
#number Score
is a number providing the score of the status.
Return value:
#FSM:
self
Add a new transition rule to the FSM.
A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.
Defined in:
Parameters:
#table From
Can contain a string indicating the From state or a table of strings containing multiple From states.
#string Event
The Event name.
#string To
The To state.
Get current state.
Returns the End states.
Returns a table of the SubFSM rules defined within the FSM.
Returns a table with the scores defined.
Returns the start state of the FSM.
Get current state.
Returns a table with the Subs defined.
Returns a table of the transition rules defined within the FSM.
Check if FSM is in state.
Defined in:
Parameter:
#string State
State name.
Return value:
#boolean:
If true, FSM is in this state.
Load call backs.
Sets the start state of the FSM.
Add to map.
Call handler.
Defined in:
Parameters:
#string step
Step "onafter", "onbefore", "onenter", "onleave".
#string trigger
Trigger.
#table params
Parameters.
#string EventName
Event name.
Return value:
Value.
Create transition.
Defined in:
Parameter:
#string EventName
Event name.
Return value:
#function:
Function.
Delayed transition.
Defined in:
Parameter:
#string EventName
Event name.
Return value:
#function:
Function.
Event map.
Go sub.
Defined in:
Parameters:
#string ParentFrom
Parent from state.
#string ParentEvent
Parent event name.
Return value:
#table:
Subs.
Handler.
Is end state.
Defined in:
Parameter:
#string Current
Current state name.
Return values:
#table:
FSM parent.
#string:
Event name.
Sub maps.
Check if can do an event.
Defined in:
Parameter:
#string e
Event name.
Return values:
#boolean:
If true, FSM can do the event.
#string:
To state.
Check if cannot do an event.
Defined in:
Parameter:
#string e
Event name.
Return value:
#boolean:
If true, FSM cannot do the event.
Check if FSM is in state.
Defined in:
Parameters:
#string State
State name.
state
Return value:
#boolean:
If true, FSM is in this state.
Missile data table.
Field(s)
If true the missile is active.
Explosive mass in kg TNT.
Fuse distance in meters.
Name of missile.
Range of missile in meters.
Type of missile.
Coalition side of the shooter.
Name of the shooter unit.
Abs. mission time in seconds the missile was fired.
Name of the target unit or "unknown".
Name of the "original" target, i.e. the one right after launched.
Function(s)
Player data table holding all important parameters of each player.
Field(s)
Callsign of player.
Coalition number of player.
Number of missiles not defeated.
Number of missiles defeated.
Destroy missile.
Name of the the player aircraft group.
Player is inside a protected zone.
Alert player on detected missile launch.
Mark position of launched missile on F10 map.
Player name.
Name of the unit.