Difference between revisions of "BIS fnc unitCaptureSimple"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Function " to "{{RV|type=function ")
m (Text replacement - "[[Script (Handle)|" to "[[Script Handle|")
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{RV|type=function
 
{{RV|type=function
  
| arma2oa
+
|game1= arma2oa
 +
|version1= 1.50
  
|1.00
+
|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, UnitDirection] for each frame
 
  
| [unit, duration, FPS, firing, startTime] spawn [[BIS_fnc_UnitCaptureSimple]]
+
|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.
 +
 
 +
|s1= [unit, duration, FPS, firing, startTime] spawn [[BIS_fnc_unitCaptureSimple]]
  
 
|p1= unit: [[Object]] - Unit to capture movement data from
 
|p1= unit: [[Object]] - Unit to capture movement data from
Line 24: Line 28:
 
|p5= startTime: [[Number]] - (Optional, default 0) Starting time offset for the frame time
 
|p5= startTime: [[Number]] - (Optional, default 0) Starting time offset for the frame time
  
| [[Script]] - Script handle
+
|r1= [[Script Handle|Script handle]]
  
 
|exec= spawn
 
|exec= spawn
  
|x1= <code>[BIS_Vehicle, 50, 30, true, 10] [[spawn]] [[BIS_fnc_UnitCaptureSimple]];</code>
+
|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]]
+
|seealso= [[BIS_fnc_unitCaptureFiring]], [[BIS_fnc_unitPlaySimple]], [[BIS_fnc_unitPlayFiring]], [[BIS_fnc_unitCapture]], [[BIS_fnc_unitPlay]]
 
}}
 
}}
 
 
 
 
[[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 18: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