BIS fnc unitPlay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *p([0-9]{1,2}) *= *(.+) * + \| *(\[\[Bool.+) * " to " |p$1=$2 |r1=$3 ")
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma2oa
|game1= arma2oa
|1.50
|version1= 1.50


|game2= tkoh
|game2= tkoh
Line 12: Line 12:
|gr1= Scenes
|gr1= Scenes


| Plays back input movement data on input unit. Simplified.
|descr= Plays back input movement data on input unit.


|s1=[unit, data, varDone, stateIngnore, obsolete_1, obsolete_2, skipTime] spawn [[BIS_fnc_unitPlay]]
|s1= [unit, data, varDone, stateIgnore, obsolete_1, obsolete_2, skipTime] spawn [[BIS_fnc_unitPlay]]


|p1= unit: [[Object]] - Unit to play movement data on
|p1= unit: [[Object]] - unit to play movement data on


|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 []) Variable to set on specified Object once playback has finished in format:
|p3= varDone: [[Array]] - (Optional, default <sqf inline>[]</sqf>) 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


|p4= stateIgnore: [[Boolean]] - (Optional, default [[false]]) Whether to ignore if the Unit is dead and/or cannot move
|p4= stateIgnore: [[Boolean]] - (Optional, default [[false]]) whether to ignore if the Unit is dead and/or cannot move


|p5= obsolete_1: [[Nothing]] - Obsolete param, preserved because of backward compatibility
|p5= obsolete_1: [[Nothing]] - obsolete param, preserved because of backward compatibility


|p6= obsolete_2: [[Nothing]] - Obsolete param, preserved because of backward compatibility
|p6= obsolete_2: [[Nothing]] - obsolete param, preserved because of backward compatibility


|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


|x1= <code>[ [[vehicle]] [[player]], _unitCaptureData ] [[spawn]] [[BIS_fnc_unitPlay]]</code>
|x1= <sqf>[vehicle player, _unitCaptureData] spawn BIS_fnc_unitPlay</sqf>


|seealso= [[BIS_fnc_unitCaptureFiring]], [[BIS_fnc_unitCaptureSimple]], [[BIS_fnc_unitPlaySimple]], [[BIS_fnc_unitPlayFiring]],[[BIS_fnc_unitCapture]]
|seealso= [[BIS_fnc_unitCaptureFiring]] [[BIS_fnc_unitCaptureSimple]] [[BIS_fnc_unitPlaySimple]] [[BIS_fnc_unitPlayFiring]] [[BIS_fnc_unitCapture]]
}}
}}
[[Category:{{Name|arma2oa}}: Functions|{{uc:UnitPlay}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:UnitPlay}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:UnitPlay}}]]

Latest revision as of 18:09, 8 November 2023

A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_unitPlay&oldid=349483"