BIS fnc unitPlay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|+$" to "")
m (Text replacement - " |r1=[[" to " |r1= [[")
Line 32: Line 32:
|p7= 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.
|p7= 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.


|r1=[[Boolean]] - Always [[true]]
|r1= [[Boolean]] - Always [[true]]


|exec= spawn
|exec= spawn

Revision as of 22:37, 7 August 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