| !HowToPrint |
This section of the Lua API documentation does not describe a module of code; its purpose is to collect the information on print-related functions in other modules into one place. |
| !Set Catalog |
This section lists all the built in set-data command names, and the arguments each one accepts. |
| !Task Catalog |
This section lists all the built in task names, and the arguments each one accepts. |
| AirRefuelSupplier |
The AirRefuelSupplier is a class of Lua object that controls the refuel points. |
| AsyncJob |
An AsyncJob represents a the status of a job that is running asynchronously to the Lua task. |
| ComponentSystem |
A component system is a capability that is assigned to the entity in the Entity Editor. |
| ExtendableArtPart |
The ExtendableArtPart is a class of Lua object that represents a rotating articulated part. |
| FeatureGeometry |
This module contains contains functions for operating on FeatureGeometry objects. |
| FeatureSet |
A FeatureSet is an object that contains a set of features. |
| Location3D |
This module contains functions for creating and operating on a 3D point object. |
| ScriptAnimationModel |
The DtScriptAnimationModel class refers to an animation model that can be used by a scripted task to animate an entity's movement. |
| SensorGimbal |
The SensorGimbal is a class of Lua object that represents a sensor that rotates on a gimbal. |
| SimObject |
The SimObject class refers to a single object in the simulation. |
| SwingingArtPart |
The SwingingArtPart is a class of Lua object that represents a rotating articulated part. |
| SystemAttribute |
This section of the Lua documentation lists the attributes that entity systems can provide in the componentSystem:getAttribute function.
See the ComponentSystem module documentation. |
| TranslatableArtPart |
The TranslatableArtPart is a class of Lua object that represents a translating articulated part. |
| TranslatableStream |
A TranslatableStream is a text stream class that can be translated by VR-Force for display in the GUI as text that is translated to the current language the user is displaying (as long as those translations exist.) See the VR-Forces Users Guide, section 2.5, for information about localizing the GUI. |
| Vector3D |
A Vector3D is a vector in earth-relative coordinates, e.g. |
| VectorGeoc3D |
A VectorGeoc3D is a straight line in space, unlike a Vector3D. |
| VectorOffset3D |
A VectorOffset3D is a direction vector that is relative to some direction specified by a Vector3D. |
| aggregateUtils |
AggregateUtils is a collection of tables and functions that provide useful capabilities and definitions related to aggregates. |
| airportDataUtils |
Functions that compute information of interest about airports and runways. |
| behaviorEngine |
This package implements a behavior engine aimed at supporting unit behaviors, or "commands." These commands are invoked and executed the same way all Lua task scripts are. |
| componentSystemUtil |
Utilities to provide information on component systems in a convenient form. |
| contactsUtils |
Contact Utilities Summary Utilities to provide information about reported hostile (or other) contacts. Dependencies Please make sure that this is preceded by these inclusions: require "vrfutil" Usage require "contactsUtils" Constants | Constant | Values | Description |
|---|
| landPlatformCategoryThreatLookup | landPlatformCategoryThreatLookup[1].score = 100 -- Tank
landPlatformCategoryThreatLookup[2].score = 90 -- Armored Fighting Vehicle6
landPlatformCategoryThreatLookup[3].score = 50 -- Armored Utility Vehicle7
landPlatformCategoryThreatLookup[4].score = 50 -- Self-propelled Artillery8
landPlatformCategoryThreatLookup[5].score = 45 -- Towed Artillery9
landPlatformCategoryThreatLookup[6].score = 65 -- Small Wheeled Utility Vehicle10
landPlatformCategoryThreatLookup[7].score = 35 -- Large Wheeled Utility Vehicle11
landPlatformCategoryThreatLookup[8].score = 65 -- Small Tracked Utility Vehicle12
landPlatformCategoryThreatLookup[9].score = 35 -- Large Tracked Utility Vehicle13
landPlatformCategoryThreatLookup[10].score = 70 -- Mortar |
This table is a lookup by SISO category enumeration for platform kind.
Value is an arbitrary, relative threat level, 0-100 | | lifeformSubcategoryThreatLookup | lifeformSubcategoryThreatLookup[85].score = 100 --Man-Portable Air Defense System
lifeformSubcategoryThreatLookup[50].score = 95 --Anti-Tank Missiles
lifeformSubcategoryThreatLookup[45].score = 90 --Anti-Tank Rockets
lifeformSubcategoryThreatLookup[70].score = 90 --Rocket Launchers
lifeformSubcategoryThreatLookup[55].score = 90 --Anti-Tank Guns
lifeformSubcategoryThreatLookup[90].score = 90 --Recoilless Rifles
lifeformSubcategoryThreatLookup[60].score = 85 --Flame Rockets
lifeformSubcategoryThreatLookup[75].score = 85 --Mortars
lifeformSubcategoryThreatLookup[40].score = 85 --Grenade Launching Machine Gun
lifeformSubcategoryThreatLookup[95].score = 80 --Drone Guns
lifeformSubcategoryThreatLookup[30].score = 75 --Grenade Launchers
lifeformSubcategoryThreatLookup[65].score = 70 --Flame Throwers
lifeformSubcategoryThreatLookup[17].score = 65 --Anti-Materiel Rifle
lifeformSubcategoryThreatLookup[35].score = 55 --Machine Guns
lifeformSubcategoryThreatLookup[20].score = 50 --Sub Machine Guns
lifeformSubcategoryThreatLookup[15].score = 45 -- Sniper Rifles
lifeformSubcategoryThreatLookup[10].score = 40 --High Power Rifles
lifeformSubcategoryThreatLookup[5].score = 35 --Assault Rifles
lifeformSubcategoryThreatLookup[1].score = 30 --Weapon
lifeformSubcategoryThreatLookup[25].score = 25 --Shot Guns
lifeformSubcategoryThreatLookup[80].score = 10 --Hand Guns
| This table is a lookup by SISO subcategory enumeration (i.e. |
| dataFileUtils |
Contains utility functions for reading data from text files. |
| displayGraphUtil |
Introduction The functions in this library assist with generating graph commands in the dot language (see https://graphviz.org/doc/info/lang.html) and displaying the graph. |
| embarkationUtil |
Embarkation Utilities Summary Embarkation utilities help computation about embarkation slots. Dependencies Please make sure that this is preceded by these inclusions: require "vrfutil" Usage require "embarkationUtil" Constants | Constant | Description |
|---|
| SLOT_NUMBER = "slot_number" | Index into an embarkation slot returned by vrf:getEmbarkationSlots(...) | | SLOT_NAME = "slot_name" | Index into an embarkation slot returned by vrf:getEmbarkationSlots(...) | | SLOT_TYPE = "slot_type" | Index into an embarkation slot returned by vrf:getEmbarkationSlots(...) | | SLOT_POSITION = "slot_position" | Index into an embarkation slot returned by vrf:getEmbarkationSlots(...) | | OCCUPIED = "occupied" | Index into an embarkation slot returned by vrf:getEmbarkationSlots(...) | | AVAILABLE = "available" | Index into an embarkation slot returned by vrf:getEmbarkationSlots(...) | |
| engagementUtil |
Functions that assist in calculating targets, line of sight.
Usage:
require "engagementUtil"
Embarkation Utilities Summary Embarkation utilities help computation about embarkation slots. Dependencies Please make sure that this is preceded by these inclusions: require "vrfutil"
require "formationUtils" Usage require "engagementUtil" Constants | Constant | Description |
|---|
| GRENADE_LAUNCHER_RANGE_MAX = 400 | A maximum limit in meters on the practical use of a M203 Launcher, for purposes of engagement behaviors. | | GRENADE_LAUNCHER_RANGE_MIN | A minimum limit in meters on the practical use of a M203 Launcher, for purposes of engagement behaviors. | | grenadeLauncherWeaponSystemNames | An array of weapon system names that helps behaviors find a grenade launcher on a "this" simulated object. | |
| formationUtils |
Functions that help with access to and manipulation of formation definition data, including formation names and position offsets.
Usage:
require "formationUtils"
formName = formationUtils.getValidFormationNameFor(this, "Line")
|
| fsm |
A design pattern for doing finite state machines (FSMs) in Lua. |
| fsm2 |
A design pattern for implementing finite state machines (FSMs) in Lua. |
| msgUtil |
Message Util is a collection of functions that maintain queues of object or text messages that the entity receives. |
| munitionLauncherUtils |
This package contains some functions that support munition-launching scripts such as Delayed_homing and Launch_ASW_Missile. |
| parseUtil |
Lua functions that assist with parsing of strings, especially from received messages. |
| pathUtil |
pathUtil is a collection of utility functions that help with path planning and ground-clamping points on a route. |
| spatialUtil |
Functions that compute things in space using points, vectors, etc. |
| terrainReasoningUtil |
Terrain Reasoning Utilities Summary Terrain Reasoning Utilities provide helper functions for processing the results of terrain reasoning queries. Dependencies Please make sure that this is preceded by these inclusions: require "vrfutil"
require "formationUtils" Usage require "terrainReasoningUtil" Constants | Constant | Description |
|---|
| _NumElementsInGroup = 5 | The number of elements in a position group returned by vrf:findPositionGroupsInArea(...) | | _NumElementsInPair = 2 | A textual mnemonic for a non-intuitive numerical value that indicates a limit on how many Location3Ds constitute a fighting position returned by terrain reasoning queries. | | _IndexOfPairsTableInPositionGroup = 5 | In a position group returned from vrf:findPositionGroupsInArea(...), in what element can one find the position pairs? E.g. |
| this |
The 'this' object instance refers to the SimObject on which the script is running. |
| unitUtil |
Unit Utilities Summary These utilities help computation about units. Dependencies Please make sure that this is preceded by these inclusions: require "vrfutil"
require "formationUtils" |
| vrf |
This module defines API functions that pass information to and from the simulation without reference to a particular simulation object or other class instance. |
| vrfutil |
Vrfutil is a collection of tables and functions that provide useful capabilities and definitions to Lua scripts in VR-Forces. |
Copyright© 2023 MAK Technologies, Inc. All rights reserved.
| |
