BIS fnc unitPlay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "(Optional, default [])" to "(Optional, default {{hl|[]}})")
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )V([a-z])" to "$1v$3")
Line 20: Line 20:
|p2= data: [[Array]] - Movement data recorder by [[BIS_fnc_unitCapture]]
|p2= data: [[Array]] - Movement data recorder by [[BIS_fnc_unitCapture]]


|p3= varDone: [[Array]] - (Optional, default {{hl|[]}}) Variable to set on specified Object once playback has finished in format:
|p3= varDone: [[Array]] - (Optional, default {{hl|[]}}) variable to set on specified Object once playback has finished in format:
* 0: [[Object]] - Target object
* 0: [[Object]] - Target object
* 1: [[String]] - Variable name
* 1: [[String]] - Variable name

Revision as of 12:32, 8 November 2023

Hover & click on the images for description

Description

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

Syntax

Syntax:
[unit, data, varDone, stateIgnore, 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_unitCaptureFiring BIS_fnc_unitCaptureSimple BIS_fnc_unitPlaySimple BIS_fnc_unitPlayFiring BIS_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