VR-Forces 5.1.1 Lua Function Documentation

Detonation

(For high level concepts about how to use Lua to write scripted tasks, please see VR-Forces User's Guide.)

A collection of detonation parameters Includes the location of the detonation, munitionType of the detonation, the detonation result, Warhead type, fuse type, quanity in the detonation, and if more than one, rate of munitions.

Function List

getDetonationLocation () Returns the geocentric location of the detonation
getDetonationResult () Returns the DIS enumeration representing the detonation result.
getFuze () Returns the DIS enumeration representing the fuze of the munition.
getMuntionType () Returns the munition type of the detonation
getQuantity () Returns the amount of munitions detonated in the event.
getRate () Returns the rate of fire, i.e.
getWarheadType () Returns the DIS enumeration representing the warhead of the munition.
isValid () Returns true if the detonation context is defined


Functions

getDetonationLocation ()
Returns the geocentric location of the detonation

Return value:

    The geocentric location of the detonation as a Location3D
getDetonationResult ()
Returns the DIS enumeration representing the detonation result. See disEnums.h for DtDetonationResult enumerations

Return value:

    The IS enumeration representing the detonation result as an int.
getFuze ()
Returns the DIS enumeration representing the fuze of the munition. See disEnums.h for DtDetonatorFuze enumerations

Return value:

    The DIS enumeration representing the fuze as an int.
getMuntionType ()
Returns the munition type of the detonation

Return value:

    The enitty type of the munition as a colon delimited string.
getQuantity ()
Returns the amount of munitions detonated in the event.

Return value:

    The quanity of munitions detonated as an int.
getRate ()
Returns the rate of fire, i.e. rounds per minute in the event.

Return value:

    The rate of fire, i.e. rounds per minute as an int.
getWarheadType ()
Returns the DIS enumeration representing the warhead of the munition. See disEnums.h for DtWarheadType enumerations

Return value:

    The IS enumeration representing the warhead as an int.
isValid ()
Returns true if the detonation context is defined

Return value:

    True if the detonation context is defined

Copyright© 2024 MAK Technologies, Inc. All rights reserved.