BIS fnc unitCapture: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <!-- (DIS)?CONTINUE Notes -->" to "")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma2oa
|game1= arma2oa
|version1= 1.51


|1.50
|game2= tkoh
|version2= 1.00


|gr1 = Scenes
|game3= arma3
|version3= 0.50


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


| [unit, duration, FPS, firing, startTime] spawn [[BIS_fnc_unitCapture]]
|descr= Records movement data of input unit over a specified period of time. Simplified.
Pressing the {{KeyboardShortcut|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
|s1= [unit, duration, FPS, firing, startTime] spawn [[BIS_fnc_unitCapture]]


|p2= duration: [[Number]] - Duration to capture for
|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
|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
|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
|p4= Firing: [[Boolean]] - (Optional, default [[false]]) if set to [[true]], will record the input unit's weapon fire data as well


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


|exec= spawn
|exec= spawn
Line 32: Line 36:
|seealso= [[BIS_fnc_unitCaptureFiring]], [[BIS_fnc_unitCaptureSimple]], [[BIS_fnc_unitPlaySimple]], [[BIS_fnc_unitPlayFiring]], [[BIS_fnc_unitPlay]]
|seealso= [[BIS_fnc_unitCaptureFiring]], [[BIS_fnc_unitCaptureSimple]], [[BIS_fnc_unitPlaySimple]], [[BIS_fnc_unitPlayFiring]], [[BIS_fnc_unitPlay]]
}}
}}
[[Category:{{Name|arma2oa}}: Functions|{{uc:UnitCapture}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:UnitCapture}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:UnitCapture}}]]


<dl class="command_description">
<dl class="command_description">
Line 45: Line 43:
<dd class="note">
<dd class="note">
Video Tutorial by '''[https://www.youtube.com/channel/UCY63DNbVREJIaANChQhYDTA TheJserver]'''<br>
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 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>
{{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. ''
''Works exactly the same in Arma 3 in my experience.''
 
</dd>
</dd>
</dl>
</dl>

Revision as of 20:51, 7 April 2021

A2 OA Logo.png1.51tkoh 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_unitCaptureFiringBIS_fnc_unitCaptureSimpleBIS_fnc_unitPlaySimpleBIS_fnc_unitPlayFiringBIS_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
Posted on September 29, 2014 - 21:31 (UTC)
Benargee
Video Tutorial by TheJserver
A2 OA Logo.png1.56 Part 1: https://www.youtube.com/watch?v=ryB20wQhSr0
A2 OA Logo.png1.56 Part 2: https://www.youtube.com/watch?v=ePszdYfMRvc
Works exactly the same in Arma 3 in my experience.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_unitCapture&oldid=254203"