BIS fnc unitPlay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (pf)
Line 1: Line 1:
{{Function|Comments=
____________________________________________________________________________________________
| arma2oa |Game name=
|1.00|Game version=
____________________________________________________________________________________________


{{Function|= Comments
| Plays back input movement data on input unit. Simplified. |Description=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2oa |= Game name
| [unit, data, varDone, stateIngnore, obsolete_1, obsolete_2, skipTime] call [[BIS_fnc_UnitPlay]] |Syntax=
 


|1.00|= Game version
|p1= unit: [[Object]] - Unit to play movement data on |Parameter 1=
____________________________________________________________________________________________


| <pre>/*
|p2= data: [[Array]] - Movement data recorder by [[BIS_fnc_UnitCapture]] |Parameter 2=


Description:
|p3= varDone: [[Array]] - (Optional, default []) Variable to set on specified Object once playback has finished in format:
Plays back input movement data on input unit.
*0: [[Object]] - Target object
*1: [[String]] - Variable name|Parameter 3=


Parameter(s):
|p4= stateIgnore: [[Boolean]] - (Optional, default [[false]]) Whether to ignore if the Unit is dead and/or cannot move |Parameter 4=
0: OBJECT - unit to play movement data on
1: ARRAY - movement data recorder by BIS_fnc_unitCapture
2: ARRAY (Optional) - variable to set once playback has finished. The array is in the following format:
0: NAMESPACE, GROUP or OBJECT
1: STRING - variable name
3: BOOL - true to allow playaback on destroyed objects (normally the playback will stop once the object is destroyed)
4: NOTHING - obsolete param, preserved because of backward compatibility
5: NOTHING - obsolete param, preserved because of backward compatibility
6: NUMBER - seconds to skip at the start of playback


Returns:
|p5= obsolete_1: [[Nothing]] - Obsolete param, preserved because of backward compatibility |Parameter 5=
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
|p6= obsolete_2: [[Nothing]] - Obsolete param, preserved because of backward compatibility|Parameter 6=
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_UnitPlay]]; --> |= Syntax
|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=


|p1= |= Parameter 1
| [[Boolean]] - Always [[true]] |Return value=


| |= Return value
|exec= spawn |= Execution
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code><nowiki>[</nowiki>[[vehicle]] [[player]], _unitCaptureData] [[spawn]] [[BIS_fnc_UnitPlay]]</code> |=  
|x1= <code>[ [[vehicle]] [[player]], _unitCaptureData ] [[spawn]] [[BIS_fnc_UnitPlay]]</code> |Example 1=
____________________________________________________________________________________________
____________________________________________________________________________________________


|[[BIS_fnc_UnitCapture]] |= See also
| [[BIS_fnc_UnitCaptureFiring]], [[BIS_fnc_UnitCaptureSimple]], [[BIS_fnc_UnitPlaySimple]], [[BIS_fnc_UnitPlayFiring]] |See also=
 
}}
}}


Revision as of 13:27, 11 June 2018

A2 OA Logo.png1.00
Hover & click on the images for description

Description

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

Syntax

Syntax:
[unit, data, varDone, stateIngnore, obsolete_1, obsolete_2, skipTime] call 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_UnitPlayFiring

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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_unitPlay&oldid=108303"