BIS fnc unitPlay: Difference between revisions

Latest revision as of 18:09, 8 November 2023

1.50

1.00

0.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:

0: Object - Target object
1: String - Variable name

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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma2oa |Game name=
+|game1= arma2oa
+|version1= 1.50
-|1.00|Game version=
+|game2= tkoh
-____________________________________________________________________________________________
+|version2= 1.00
-| Plays back input movement data on input unit. Simplified. |Description=
+|game3= arma3
-____________________________________________________________________________________________
+|version3= 0.50
-| [unit, data, varDone, stateIngnore, obsolete_1, obsolete_2, skipTime] call [[BIS_fnc_UnitPlay]] |Syntax=
+|gr1= Scenes
+|descr= Plays back input movement data on input unit.
-|p1= unit: [[Object]] - Unit to play movement data on |Parameter 1=
+|s1= [unit, data, varDone, stateIgnore, obsolete_1, obsolete_2, skipTime] spawn [[BIS_fnc_unitPlay]]
-|p2= data: [[Array]] - Movement data recorder by [[BIS_fnc_UnitCapture]] |Parameter 2=
+|p1= unit: [[Object]] - unit to play movement data on
-|p3= varDone: [[Array]] - (Optional, default []) Variable to set on specified Object once playback has finished in format:
+|p2= data: [[Array]] - movement data recorder by [[BIS_fnc_unitCapture]]
-*0: [[Object]] - Target object
-*1: [[String]] - Variable name|Parameter 3=
-|p4= stateIgnore: [[Boolean]] - (Optional, default [[false]]) Whether to ignore if the Unit is dead and/or cannot move |Parameter 4=
+|p3= varDone: [[Array]] - (Optional, default <sqf inline>[]</sqf>) variable to set on specified Object once playback has finished in format:
+* 0: [[Object]] - Target object
+* 1: [[String]] - Variable name
-|p5= obsolete_1: [[Nothing]] - Obsolete param, preserved because of backward compatibility |Parameter 5=
+|p4= stateIgnore: [[Boolean]] - (Optional, default [[false]]) whether to ignore if the Unit is dead and/or cannot move
-|p6= obsolete_2: [[Nothing]] - Obsolete param, preserved because of backward compatibility|Parameter 6=
+|p5= obsolete_1: [[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. |Parameter 7=
+|p6= obsolete_2: [[Nothing]] - obsolete param, preserved because of backward compatibility
-| [[Boolean]] - Always [[true]] |Return value=
+|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.
-|exec= spawn |= Execution
+|r1= [[Boolean]] - always [[true]]
-____________________________________________________________________________________________
-|x1= <code>[ [[vehicle]] [[player]], _unitCaptureData ] [[spawn]] [[BIS_fnc_UnitPlay]]</code> |Example 1=
+|exec= spawn
-____________________________________________________________________________________________
-| [[BIS_fnc_UnitCaptureFiring]], [[BIS_fnc_UnitCaptureSimple]], [[BIS_fnc_UnitPlaySimple]], [[BIS_fnc_UnitPlayFiring]] |See also=
+|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]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Scenes|{{uc:UnitPlay}}]]
-[[Category:Functions|{{uc:UnitPlay}}]]
-[[Category:{{Name|arma2oa}}: Functions|{{uc:UnitPlay}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:UnitPlay}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:UnitPlay}}]]