Difference between revisions of "BIS fnc unitCaptureFiring"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (pf)
Line 1: Line 1:
 +
{{Function|Comments=
 +
____________________________________________________________________________________________
 +
 +
| arma2oa |Game name=
 +
 +
|1.00|Game version=
 +
____________________________________________________________________________________________
  
{{Function|= Comments
+
| Records weapon fire data of input unit over a specified period of time. Pressing the ESC key, the duration ending, or the unit dying ends the recording. |Description=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma2oa |= Game name
+
| [unit, duration, startTime] call [[BIS_fnc_UnitCaptureFiring]] |Syntax=
  
|1.00|= Game version
 
____________________________________________________________________________________________
 
  
| <pre>
+
|p1= unit: [[Object]] - Unit to capture weapon fire data from |Parameter 1=
/*
 
File: fn_UnitCaptureFiring.sqf
 
  
Description:
+
|p2= duration: [[Number]] - Duration to capture for |Parameter 2=
Records weapon fire data of input unit over a specified period of time.
 
Pressing the ESC key, the duration ending, or the unit dying ends the
 
recording.
 
  
Parameters:
+
|p3= startTime: [[Number]] - (Optional, default 0) Starting time offset for the frame time|Parameter 3=
Unit - Unit to capture weapon fire data from
 
Duration - Duration to capture for
 
OPT:StartTime - OPTIONAL: Starting time offset for the frame time
 
  
Copies to clipboard:
 
Array in format [FrameTime, WeaponType, Target(If AI-controlled)] for each frame
 
 
Input Example:
 
a) [BIS_Vehicle, 50, 10] spawn BIS_fnc_UnitCaptureFiring;
 
Which would capture data from a unit named BIS_Vehicle, and would capture for 50 seconds.
 
Frame time offset would be 10 seconds.
 
 
Output Example:
 
a) [[2.135,"GAU8","<NULL-object>"],[2.157,"GAU8","<NULL-object>"]]
 
The above output has 2 frames.
 
  
b) [[2.135,"GAU8","<NULL-object>"]]
+
| [[Script]] - Script handle |Return value=
The above output has 1 frame.
 
*/
 
  
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+
|exec= spawn |= Execution
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| <!-- [] call [[BIS_fnc_UnitCaptureFiring]]; --> |= Syntax
+
|x1= <code>[BIS_Vehicle, 50, 10] [[spawn]] [[BIS_fnc_UnitCaptureFiring]];</code>|Example 1=
  
|p1= |= Parameter 1
+
|x2= <code>[ [2.135,"GAU8","<NULL-object>"], [2.157,"GAU8","<NULL-object>"] ]//Output example</code>|Example 2=
  
| |= Return value
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|x1= <code></code> |=  
+
| [[BIS_fnc_UnitCaptureSimple]], [[BIS_fnc_UnitPlaySimple]], [[BIS_fnc_UnitPlayFiring]], [[BIS_fnc_UnitCapture]], [[BIS_fnc_UnitPlay]] |See also=
____________________________________________________________________________________________
+
}}
  
| |= See also
 
  
}}
 
  
 
<h3 style="display:none">Notes</h3>
 
<h3 style="display:none">Notes</h3>

Revision as of 13:54, 11 June 2018

Hover & click on the images for description

Description

Description:
Records weapon fire data of input unit over a specified period of time. Pressing the ESC key, the duration ending, or the unit dying ends the recording.
Execution:
spawn
Groups:
Uncategorised

Syntax

Syntax:
[unit, duration, startTime] call BIS_fnc_UnitCaptureFiring
Parameters:
unit: Object - Unit to capture weapon fire data from
duration: Number - Duration to capture for
startTime: Number - (Optional, default 0) Starting time offset for the frame time
Return Value:
Script - Script handle

Examples

Example 1:
[BIS_Vehicle, 50, 10] spawn BIS_fnc_UnitCaptureFiring;
Example 2:
[ [2.135,"GAU8","<NULL-object>"], [2.157,"GAU8","<NULL-object>"] ]//Output example

Additional Information

See also:
BIS_fnc_UnitCaptureSimpleBIS_fnc_UnitPlaySimpleBIS_fnc_UnitPlayFiringBIS_fnc_UnitCaptureBIS_fnc_UnitPlay

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


Notes

Bottom Section