BIS fnc unitCaptureSimple: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(33 intermediate revisions by 3 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_UnitCaptureSimple.sqf


Description:
|descr= Records movement data of input unit over a specified period of time. Simplified.
Records movement data of input unit over a specified period of time. Simplified.
Pressing the {{Controls|Esc}} key, the duration ending, or the unit dying ends the recording.
Pressing the ESC key, the duration ending, or the unit dying ends
the recording.


Parameters:
|s1= [unit, duration, FPS, firing, startTime] spawn [[BIS_fnc_unitCaptureSimple]]
Unit - Unit to capture movement data from
Duration - Duration to capture for
OPT:FPS - OPTIONAL: Frames recorded Per Second (default 20). Limit is 1 - 100
OPT:Firing - OPTIONAL: If true, will record the input unit's weapon fire data as well
OPT:StartTime - OPTIONAL: Starting time offset for the frame time


Copies to clipboard:
|p1= unit: [[Object]] - unit to capture movement data from
Array in format [FrameTime, UnitPosition, UnitDirection] for each frame
Input Examples:
a) [BIS_Vehicle, 50, 30, true, 10] spawn BIS_fnc_UnitCapture;
Which would capture data from a unit named BIS_Vehicle, would capture for 50 seconds, would capture at 30 FPS,
and would also record the unit's weapon fire data as well. Frame time offset would be 10 seconds.
b) [BIS_Vehicle, 50] spawn BIS_fnc_UnitCapture;
Which would capture data from a unit named BIS_Vehicle, and would capture for 50 seconds.


Output Example:
|p2= duration: [[Array]] - duration to capture for
a) [[0,[8208.26,1953.13,296.04],67],[1.021,[8208.26,1953.13,296.04],68]]
The above output has 2 frames.
b) [[0,[8208.26,1953.13,296.04],67]]
The above output has 1 frame.
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p3= FPS: [[Number]] - (Optional, default 20) frames recorded per second (default 20). Limit is 1 - 100
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_UnitCaptureSimple]]; --> |= Syntax
|p4= firing: [[Boolean]] - (Optional, default [[false]])  if [[true]], will record the input unit's weapon fire data as well


|p1= |= Parameter 1
|p5= startTime: [[Number]] - (Optional, default 0) starting time offset for the frame time


| |= Return value
|r1= [[Script Handle]]
____________________________________________________________________________________________
{{Feature|informative|
{{Link|copyToClipboard|Copies to clipboard}} an [[Array]] of [[Array]]s in format [frameTime, unitPosition, unitDirection] for each frame.
}}


|x1= <code></code> |=
|exec= spawn
____________________________________________________________________________________________


| |= See also
|x1= <sqf>[BIS_Vehicle, 50, 30, true, 10] spawn BIS_fnc_unitCaptureSimple;</sqf>


|seealso= [[BIS_fnc_unitCaptureFiring]] [[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:UnitCaptureSimple}}]]
[[Category:Functions|{{uc:UnitCaptureSimple}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:UnitCaptureSimple}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:UnitCaptureSimple}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:UnitCaptureSimple}}]]

Latest revision as of 11:42, 8 November 2023

A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Records movement data of input unit over a specified period of time. Simplified. Pressing the Esc key, the duration ending, or the unit dying ends the recording.
Execution:
spawn
Groups:
Scenes

Syntax

Syntax:
[unit, duration, FPS, firing, startTime] spawn BIS_fnc_unitCaptureSimple
Parameters:
unit: Object - unit to capture movement data from
duration: Array - duration to capture for
FPS: Number - (Optional, default 20) frames recorded per second (default 20). Limit is 1 - 100
firing: Boolean - (Optional, default false) if true, will record the input unit's weapon fire data as well
startTime: Number - (Optional, default 0) starting time offset for the frame time
Return Value:
Script Handle
ⓘ
Copies to clipboard an Array of Arrays in format [frameTime, unitPosition, unitDirection] for each frame.

Examples

Example 1:
[BIS_Vehicle, 50, 30, true, 10] spawn BIS_fnc_unitCaptureSimple;

Additional Information

See also:
BIS_fnc_unitCaptureFiring 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_unitCaptureSimple&oldid=347971"