BIS fnc unitPlay: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*) *<\/code>" to "<code>$1$2$3</code>") |
Lou Montana (talk | contribs) m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)") |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 12: | Line 12: | ||
|gr1= Scenes | |gr1= Scenes | ||
|descr= Plays back input movement data on input unit | |descr= Plays back input movement data on input unit. | ||
|s1=[unit, data, varDone, stateIgnore, 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]] - | |p1= unit: [[Object]] - unit to play movement data on | ||
|p2= data: [[Array]] - | |p2= data: [[Array]] - movement data recorder by [[BIS_fnc_unitCapture]] | ||
|p3= varDone: [[Array]] - (Optional, default []) | |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 | ||
| Line 36: | Line 36: | ||
|exec= spawn | |exec= spawn | ||
|x1= < | |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]] | ||
}} | }} | ||
Latest revision as of 18:09, 8 November 2023
Description
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:
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