BIS fnc unitPlay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
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...)
m (Text replacement - "<h3 style="display:none">Bottom Section</h3>" to "")
Line 38: Line 38:




<h3 style="display:none">Bottom Section</h3>
 


[[Category:Functions|{{uc:UnitPlay}}]]
[[Category:Functions|{{uc:UnitPlay}}]]

Revision as of 00:44, 18 January 2021

Hover & click on the images for description

Description

Description:
Plays back input movement data on input unit. Simplified.
Execution:
spawn
Groups:
Scenes

Syntax

Syntax:
[unit, data, varDone, stateIngnore, obsolete_1, obsolete_2, skipTime] spawn BIS_fnc_UnitPlay
Parameters:
unit: Object - Unit to play movement data on
data: Array - Movement data recorder by BIS_fnc_UnitCapture
varDone: Array - (Optional, default []) Variable to set on specified Object once playback has finished in format:
stateIgnore: Boolean - (Optional, default false) Whether to ignore if the Unit is dead and/or cannot move
obsolete_1: Nothing - Obsolete param, preserved because of backward compatibility
obsolete_2: Nothing - Obsolete param, preserved because of backward compatibility
skipTime: Number - (Optional, default 0) Amount of time to skip at the start of playback. For example if you wish to play the data from halfway instead of the start.
Return Value:
Boolean - Always true

Examples

Example 1:
[ vehicle player, _unitCaptureData ] spawn BIS_fnc_UnitPlay

Additional Information

See also:
BIS_fnc_UnitCaptureFiringBIS_fnc_UnitCaptureSimpleBIS_fnc_UnitPlaySimpleBIS_fnc_UnitPlayFiringBIS_fnc_UnitCapture

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