BIS fnc unitCapture: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Bug: Note template doesnt like equals symbol)
m (Some wiki formatting)
 
(38 intermediate revisions by 5 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_UnitCapture.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.
Pressing the {{Controls|Esc}} key, the duration ending, or the unit dying ends the recording.<br>
Pressing the ESC key, the duration ending, or the unit dying ends
Copies to clipboard an [[Array]] in format [frameTime, unitPosition, unitDirectionVector, unitUpVector, unitVelocity] for each frame.
the recording.


Parameters:
|s1= [unit, duration, FPS, firing, startTime] spawn [[BIS_fnc_unitCapture]]
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 from which to capture movement data
Array in format [FrameTime, UnitPosition, UnitDirectionVector, UnitUpVector, UnitVelocity] 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: [[Number]] - capture's maximum duration
a) [[0,[8208.26,1953.13,296.04],[0,1,0],[0.000174453,0,1],[0,0,0]],[1.021,[8208.26,1953.13,296.04],[0,1,0],[0.000174453,0,1],[0,0,0]]]
The above output has 2 frames.
b) [[0,[8208.26,1953.13,296.04],[0,1,0],[0.000174453,0,1],[0,0,0]]]
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). Range is 1..100
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_UnitCapture]]; --> |= Syntax
|p4= firing: [[Boolean]] - (Optional, default [[false]]) if set to [[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]]
____________________________________________________________________________________________


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


| [[BIS_fnc_UnitPlay]][[BIS_fnc_UnitCaptureFiring]][[BIS_fnc_UnitCaptureSimple]]|= See also
|x1= <sqf>[BIS_Vehicle, 50, 30, true, 10] spawn BIS_fnc_unitCapture;</sqf>


|seealso= [[BIS_fnc_unitCaptureFiring]] [[BIS_fnc_unitCaptureSimple]] [[BIS_fnc_unitPlaySimple]] [[BIS_fnc_unitPlayFiring]] [[BIS_fnc_unitPlay]] [[BIS_fnc_scriptedMove]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Benargee
<!-- Note Section BEGIN -->
|timestamp= 20140929213100
 
|text= Video Tutorial by '''{{Link|https://www.youtube.com/channel/UCY63DNbVREJIaANChQhYDTA|TheJserver}}'''<br>
<!-- Note Section END -->
{{GVI|arma2oa|1.56}} '''Part 1:''' {{Link|https://www.youtube.com/watch?v{{=}}ryB20wQhSr0}}<br>
</dl>
{{GVI|arma2oa|1.56}} '''Part 2:''' {{Link|https://www.youtube.com/watch?v{{=}}ePszdYfMRvc}}<br>
 
''Works exactly the same in {{arma3}} in my experience.''
<h3 style="display:none">Bottom Section</h3>
}}
[[Category:Function Group: Scenes|{{uc:UnitCapture}}]]
[[Category:Functions|{{uc:UnitCapture}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:UnitCapture}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:UnitCapture}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:UnitCapture}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on September 29, 2014 - 21:31 (UTC)</dd>
<dt class="note">[[User:Benargee|Benargee]]</dt>
<dd class="note">
Video Tutorial by '''[https://www.youtube.com/channel/UCY63DNbVREJIaANChQhYDTA TheJserver]'''<br>
{{GVI|arma 2 oa|1.56}}'''Part 1:''' https://www.youtube.com/watch?v=ryB20wQhSr0<br>
{{GVI|arma 2 oa|1.56}}'''Part 2:''' https://www.youtube.com/watch?v=ePszdYfMRvc<br>
''Works exactly the same in Arma 3 to my experience. ''
 
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 10:41, 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.
Copies to clipboard an Array in format [frameTime, unitPosition, unitDirectionVector, unitUpVector, unitVelocity] for each frame.
Execution:
spawn
Groups:
Scenes

Syntax

Syntax:
[unit, duration, FPS, firing, startTime] spawn BIS_fnc_unitCapture
Parameters:
unit: Object - unit from which to capture movement data
duration: Number - capture's maximum duration
FPS: Number - (Optional, default 20) frames recorded per second (default 20). Range is 1..100
firing: Boolean - (Optional, default false) if set to 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

Examples

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

Additional Information

See also:
BIS_fnc_unitCaptureFiring BIS_fnc_unitCaptureSimple BIS_fnc_unitPlaySimple BIS_fnc_unitPlayFiring BIS_fnc_unitPlay BIS_fnc_scriptedMove

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
Benargee - c
Posted on Sep 29, 2014 - 21:31 (UTC)
Video Tutorial by TheJserver
A2 OA Logo.png1.56 Part 1: [1]
A2 OA Logo.png1.56 Part 2: [2]
Works exactly the same in Arma 3 in my experience.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_unitCapture&oldid=347970"