Difference between revisions of "BIS fnc unitCaptureSimple"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
+
{{Function
  
| arma2oa |Game name=
+
| arma2oa
  
|1.00|Game version=
+
|1.00
  
|gr1 = Scenes |GROUP1=
+
|gr1 = Scenes
  
 
| 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. Simplified.
 
Pressing the ESC key, the duration ending, or the unit dying ends
 
Pressing the ESC key, the duration ending, or the unit dying ends
 
the recording.<br>Copies to clipboard:<br>
 
the recording.<br>Copies to clipboard:<br>
Array in format [FrameTime, UnitPosition, UnitDirection] for each frame |Description=
+
Array in format [FrameTime, UnitPosition, UnitDirection] for each frame
  
| [unit, duration, FPS, firing, startTime] spawn [[BIS_fnc_UnitCaptureSimple]] |Syntax=
+
| [unit, duration, FPS, firing, startTime] spawn [[BIS_fnc_UnitCaptureSimple]]
  
  
|p1= unit: [[Object]] - Unit to capture movement data from |Parameter 1=
+
|p1= unit: [[Object]] - Unit to capture movement data from
  
|p2= duration: [[Array]] - Duration to capture for|Parameter 2=
+
|p2= duration: [[Array]] - Duration to capture for
  
|p3= FPS: [[Number]] - (Optional, default 20) Frames recorded per second (default 20). Limit is 1 - 100|Parameter 3=
+
|p3= FPS: [[Number]] - (Optional, default 20) Frames recorded per second (default 20). Limit is 1 - 100
  
|p4= Firing: [[Boolean]] - (Optional, default [[false]])  If [[true]], will record the input unit's weapon fire data as well|Parameter 4=
+
|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 |Parameter 5=
+
|p5= startTime: [[Number]] - (Optional, default 0) Starting time offset for the frame time
  
  
| [[Script]] - Script handle |Return value=
+
| [[Script]] - Script handle
  
 
|exec= spawn |Execution=
 
|exec= spawn |Execution=
  
|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=
+
| [[BIS_fnc_UnitCaptureFiring]], [[BIS_fnc_UnitPlaySimple]], [[BIS_fnc_UnitPlayFiring]], [[BIS_fnc_UnitCapture]], [[BIS_fnc_UnitPlay]]
 
}}
 
}}
  

Revision as of 22:18, 17 January 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:
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 - 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


Bottom Section