BIS fnc unitPlay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Scenes(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma2oa |Game name=
| arma2oa |Game name=
Line 7: Line 6:


|gr1 = Scenes |GROUP1=
|gr1 = Scenes |GROUP1=
____________________________________________________________________________________________


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


| [unit, data, varDone, stateIngnore, obsolete_1, obsolete_2, skipTime] spawn [[BIS_fnc_UnitPlay]] |Syntax=
| [unit, data, varDone, stateIngnore, obsolete_1, obsolete_2, skipTime] spawn [[BIS_fnc_UnitPlay]] |Syntax=
Line 34: Line 31:


|exec= spawn |Execution=
|exec= spawn |Execution=
____________________________________________________________________________________________


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


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

Revision as of 23:39, 16 January 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

Notes

Bottom Section