BIS fnc unitCapture: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m ([unit, duration, FPS, firing, startTime] spawn BIS_fnc_UnitCapture --- duration was incorrectly classed as an array, I've changed it to a number)
m (Some wiki formatting)
 
(35 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma2oa |Game name=
|game1= arma2oa
|version1= 1.50


|1.00|Game version=
|game2= tkoh
____________________________________________________________________________________________
|version2= 1.00


| Records movement data of input unit over a specified period of time. Simplified.
|game3= arma3
Pressing the ESC key, the duration ending, or the unit dying ends
|version3= 0.50
the recording.<br>Copies to clipboard:<br>
Array in format [FrameTime, UnitPosition, UnitDirectionVector, UnitUpVector, UnitVelocity] for each frame |Description=
____________________________________________________________________________________________


| [unit, duration, FPS, firing, startTime] spawn [[BIS_fnc_UnitCapture]] |Syntax=
|gr1= Scenes


|descr= 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.<br>
Copies to clipboard an [[Array]] in format [frameTime, unitPosition, unitDirectionVector, unitUpVector, unitVelocity] for each frame.


|p1= unit: [[Object]] - Unit to capture movement data from |Parameter 1=
|s1= [unit, duration, FPS, firing, startTime] spawn [[BIS_fnc_unitCapture]]


|p2= duration: [[Number]] - Duration to capture for|Parameter 2=
|p1= unit: [[Object]] - unit from which to capture movement data


|p3= FPS: [[Number]] - (Optional, default 20) Frames recorded per second (default 20). Limit is 1 - 100|Parameter 3=
|p2= duration: [[Number]] - capture's maximum duration


|p4= Firing: [[Boolean]] - (Optional, default [[false]]) If [[true]], will record the input unit's weapon fire data as well|Parameter 4=
|p3= FPS: [[Number]] - (Optional, default 20) frames recorded per second (default 20). Range is 1..100


|p5= startTime: [[Number]] - (Optional, default 0) Starting time offset for the frame time |Parameter 5=
|p4= firing: [[Boolean]] - (Optional, default [[false]]) if set to [[true]], will record the input unit's weapon fire data as well


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


| [[Script]] - Script handle |Return value=
|r1= [[Script Handle]]


|exec= spawn |= Execution
|exec= spawn
____________________________________________________________________________________________


|x1= <code>[BIS_Vehicle, 50, 30, true, 10] [[spawn]] [[BIS_fnc_UnitCapture]];</code>|Example 1=
|x1= <sqf>[BIS_Vehicle, 50, 30, true, 10] spawn BIS_fnc_unitCapture;</sqf>
____________________________________________________________________________________________


| [[BIS_fnc_UnitCaptureFiring]], [[BIS_fnc_UnitCaptureSimple]], [[BIS_fnc_UnitPlaySimple]], [[BIS_fnc_UnitPlayFiring]], [[BIS_fnc_UnitPlay]] |See also=
|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"