Difference between revisions of "BIS fnc unitCaptureSimple"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (pf)
m (Text replacement - "[[Script (Handle)|" to "[[Script Handle|")
(22 intermediate revisions by 2 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, UnitDirection] for each frame |Description=
 
____________________________________________________________________________________________
 
  
| [unit, duration, FPS, firing, startTime] spawn [[BIS_fnc_UnitCaptureSimple]] |Syntax=
+
|gr1= Scenes
  
 +
|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, unitDirection] for each frame.
  
|p1= unit: [[Object]] - Unit to capture movement data from |Parameter 1=
+
|s1= [unit, duration, FPS, firing, startTime] spawn [[BIS_fnc_unitCaptureSimple]]
  
|p2= duration: [[Array]] - Duration to capture for|Parameter 2=
+
|p1= unit: [[Object]] - Unit to capture movement data from
  
|p3= FPS: [[Number]] - (Optional, default 20) Frames recorded per second (default 20). Limit is 1 - 100|Parameter 3=
+
|p2= duration: [[Array]] - Duration to capture for
  
|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). Limit 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 [[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|Script handle]]
  
|exec= spawn |= Execution
+
|exec= spawn
____________________________________________________________________________________________
 
  
|x1= <code>[BIS_Vehicle, 50, 30, true, 10] [[spawn]] [[BIS_fnc_UnitCaptureSimple]];</code>|Example 1=
+
|x1= <code>[BIS_Vehicle, 50, 30, true, 10] [[spawn]] [[BIS_fnc_unitCaptureSimple]];</code>
____________________________________________________________________________________________
 
  
| [[BIS_fnc_UnitCaptureFiring]], [[BIS_fnc_UnitPlaySimple]], [[BIS_fnc_UnitPlayFiring]], [[BIS_fnc_UnitCapture]], [[BIS_fnc_UnitPlay]] |See also=
+
|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}}]]
 

Revision as of 19:10, 28 August 2021

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, unitDirection] for each frame.
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

Examples

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

Additional Information

See also:
BIS_fnc_unitCaptureFiringBIS_fnc_unitPlaySimpleBIS_fnc_unitPlayFiringBIS_fnc_unitCaptureBIS_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