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: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma2oa
-____________________________________________________________________________________________
+|version1= 1.50
-| arma2oa |= Game name
+|game2= tkoh
+|version2= 1.00
-|1.00|= Game version
+|game3= arma3
-____________________________________________________________________________________________
+|version3= 0.50
-| <pre>/*
+|gr1= Scenes
-	Description:
+|descr= Plays back input movement data on input unit.
-	Plays back input movement data on input unit.
-	Parameter(s):
+|s1= [unit, data, varDone, stateIgnore, obsolete_1, obsolete_2, skipTime] spawn [[BIS_fnc_unitPlay]]
-: OBJECT - unit to play movement data on
-: ARRAY - movement data recorder by BIS_fnc_unitCapture
-: ARRAY (Optional) - variable to set once playback has finished. The array is in the following format:
-: NAMESPACE, GROUP or OBJECT
-: STRING - variable name
-: BOOL - true to allow playaback on destroyed objects (normally the playback will stop once the object is destroyed)
-: NOTHING - obsolete param, preserved because of backward compatibility
-: NOTHING - obsolete param, preserved because of backward compatibility
-: NUMBER - seconds to skip at the start of playback
-	Returns:
+|p1= unit: [[Object]] - unit to play movement data on
-	BOOL - always true. The script is completed once the playback is finished.
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|p2= data: [[Array]] - movement data recorder by [[BIS_fnc_unitCapture]]
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_UnitPlay]]; --> |= Syntax
+|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
-|p1= |= Parameter 1
+|p4= stateIgnore: [[Boolean]] - (Optional, default [[false]]) whether to ignore if the Unit is dead and/or cannot move
-| |= Return value
+|p5= obsolete_1: [[Nothing]] - obsolete param, preserved because of backward compatibility
-____________________________________________________________________________________________
-|x1= <code>[vehicle player, _unitCaptureData] spawn BIS_fnc_UnitPlay</code> |=
+|p6= obsolete_2: [[Nothing]] - obsolete param, preserved because of backward compatibility
-____________________________________________________________________________________________
-|[[BIS_fnc_UnitCapture]] |= See also
+|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]]
-<h3 style="display:none">Notes</h3>
+|exec= spawn
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x1= <sqf>[vehicle player, _unitCaptureData] spawn BIS_fnc_unitPlay</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[BIS_fnc_unitCaptureFiring]] [[BIS_fnc_unitCaptureSimple]] [[BIS_fnc_unitPlaySimple]] [[BIS_fnc_unitPlayFiring]] [[BIS_fnc_unitCapture]]
-[[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}}]]