BIS fnc unitCaptureFiring: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Fix Script link)
 
(36 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2oa
____________________________________________________________________________________________
|version1= 1.50


| arma2oa |= Game name
|game2= tkoh
|version2= 1.00


|1.00|= Game version
|game3= arma3
____________________________________________________________________________________________
|version3= 0.50


| <pre>
|gr1= Scenes
/*
File: fn_UnitCaptureFiring.sqf


Description:
|descr= Records weapon fire data of input unit over a specified period of time. Pressing the {{Controls|ESC}} key, the duration ending, or the unit dying ends the recording.
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:
|s1= [unit, duration, startTime] spawn [[BIS_fnc_unitCaptureFiring]]
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:
|p1= unit: [[Object]] - unit to capture weapon fire data from
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>"]]
|p2= duration: [[Number]] - maximum duration to capture
The above output has 1 frame.
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p3= startTime: [[Number]] - (Optional, default 0) starting time offset for the frame time
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_UnitCaptureFiring]]; --> |= Syntax
|r1= [[Script Handle]]


|p1= |= Parameter 1
|exec= spawn


| |= Return value
|x1= <sqf>[BIS_Vehicle, 50, 10] spawn BIS_fnc_unitCaptureFiring;</sqf>
____________________________________________________________________________________________


|x1= <code></code> |=
|x2= <sqf>[[2.135, "GAU8", "<NULL-object>"], [2.157, "GAU8", "<NULL-object>"]] // output example</sqf>
____________________________________________________________________________________________
 
| |= See also


|seealso= [[BIS_fnc_unitCaptureSimple]] [[BIS_fnc_unitPlaySimple]] [[BIS_fnc_unitPlayFiring]] [[BIS_fnc_unitCapture]] [[BIS_fnc_unitPlay]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Scenes|{{uc:UnitCaptureFiring}}]]
[[Category:Functions|{{uc:UnitCaptureFiring}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:UnitCaptureFiring}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:UnitCaptureFiring}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:UnitCaptureFiring}}]]

Latest revision as of 09:47, 29 December 2022

A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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:
Scenes

Syntax

Syntax:
[unit, duration, startTime] spawn BIS_fnc_unitCaptureFiring
Parameters:
unit: Object - unit to capture weapon fire data from
duration: Number - maximum duration to capture
startTime: Number - (Optional, default 0) starting time offset for the frame time
Return Value:
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_unitCaptureSimple BIS_fnc_unitPlaySimple BIS_fnc_unitPlayFiring BIS_fnc_unitCapture BIS_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_unitCaptureFiring&oldid=336358"