getShotInfo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 21: Line 21:
* 3 - triggerIsForced: [[Boolean]] - [[true]] if shot ammo was triggered with [[triggerAmmo]].
* 3 - triggerIsForced: [[Boolean]] - [[true]] if shot ammo was triggered with [[triggerAmmo]].
* 4 - shownTracer: [[Boolean]] - [[true]] if the shot shown as tracer.
* 4 - shownTracer: [[Boolean]] - [[true]] if the shot shown as tracer.
* 5 - isReal: [[Boolean]] - [[true]] is the shot is considered in damage events.
* 5 - isReal: [[Boolean]] - [[true]] if the shot is considered in damage events.
* 6 - isSubmunitionTriggered: [[Boolean]] - [[true]] if the shot contains submunition and it is triggered.
* 6 - isSubmunitionTriggered: [[Boolean]] - [[true]] if the shot contains submunition and it is triggered.



Revision as of 18:35, 16 February 2024

Hover & click on the images for description
Only available in Development branch(es) until its release with Arma 3 patch v2.18.

Description

Description:
Returns various properties for the given shot.
Groups:
Object Manipulation

Syntax

Syntax:
getShotInfo shot
Parameters:
shot: Object
Return Value:
Array in format [effectiveTimeToLive, fuseDistanceLeft, timeToExplosion, triggerIsForced, shownTracer, isReal, isSubmunitionTriggered], where:
  • 0 - effectiveTimeToLive: Number - how much more shot has to live.
  • 1 - fuseDistanceLeft: Number - how long shot has to travel more to get fused (undebarrel grenade for example).
  • 2 - timeToExplosion: Number - how long before shot fuse explodes (hand grenade for example).
  • 3 - triggerIsForced: Boolean - true if shot ammo was triggered with triggerAmmo.
  • 4 - shownTracer: Boolean - true if the shot shown as tracer.
  • 5 - isReal: Boolean - true if the shot is considered in damage events.
  • 6 - isSubmunitionTriggered: Boolean - true if the shot contains submunition and it is triggered.

Alternative Syntax

Syntax:
shot getShotInfo index
Parameters:
shot: Object
index: Number - property index (see main syntax, for example 1 for fuseDistanceLeft)
Return Value:
Anything - depends on the requested property, or Nothing

Examples

Example 1:
private _shotInfo = getShotInfo shot1;
Example 2:
private _fuseDistanceLeft = shot1 getShotInfo 1;

Additional Information

See also:
cursorObject cursorTarget createSimpleObject getObjectType getObjectTextures objectParent setVelocityTransformation getUnitFreefallInfo getEntityInfo getModelInfo

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note