BIS fnc unitPlay: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " |r1=[[" to " |r1= [[") |
Lou Montana (talk | contribs) m (Fix typo) |
||
| Line 14: | Line 14: | ||
|descr= Plays back input movement data on input unit. Simplified. | |descr= Plays back input movement data on input unit. Simplified. | ||
|s1=[unit, data, varDone, | |s1=[unit, data, varDone, stateIgnore, obsolete_1, obsolete_2, skipTime] spawn [[BIS_fnc_unitPlay]] | ||
|p1= unit: [[Object]] - Unit to play movement data on | |p1= unit: [[Object]] - Unit to play movement data on | ||
| Line 24: | Line 24: | ||
*1: [[String]] - Variable name | *1: [[String]] - Variable name | ||
|p4= stateIgnore: [[Boolean]] - (Optional, default [[false]]) | |p4= stateIgnore: [[Boolean]] - (Optional, default [[false]]) whether to ignore if the Unit is dead and/or cannot move | ||
|p5= obsolete_1: [[Nothing]] - | |p5= obsolete_1: [[Nothing]] - obsolete param, preserved because of backward compatibility | ||
|p6= obsolete_2: [[Nothing]] - | |p6= obsolete_2: [[Nothing]] - obsolete param, preserved because of backward compatibility | ||
|p7= skipTime: [[Number]] - (Optional, default 0) | |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]] - | |r1= [[Boolean]] - always [[true]] | ||
|exec= spawn | |exec= spawn | ||
Revision as of 01:15, 22 August 2021
Description
- Description:
- Plays back input movement data on input unit. Simplified.
- 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:
- 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