BIS fnc unitPlay: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma2oa | | arma2oa | ||
|1.00 | |1.00 | ||
|gr1 = Scenes | |gr1 = Scenes | ||
| Plays back input movement data on input unit. Simplified. | | Plays back input movement data on input unit. Simplified. | ||
| [unit, data, varDone, stateIngnore, obsolete_1, obsolete_2, skipTime] spawn [[BIS_fnc_UnitPlay]] | | [unit, data, varDone, stateIngnore, 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 | ||
|p2= data: [[Array]] - Movement data recorder by [[BIS_fnc_UnitCapture]] | |p2= data: [[Array]] - Movement data recorder by [[BIS_fnc_UnitCapture]] | ||
|p3= varDone: [[Array]] - (Optional, default []) Variable to set on specified Object once playback has finished in format: | |p3= varDone: [[Array]] - (Optional, default []) 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 | ||
|p5= obsolete_1: [[Nothing]] - Obsolete param, preserved because of backward compatibility | |p5= obsolete_1: [[Nothing]] - Obsolete param, preserved because of backward compatibility | ||
|p6= obsolete_2: [[Nothing]] - Obsolete param, preserved because of backward compatibility | |p6= obsolete_2: [[Nothing]] - Obsolete param, preserved because of backward compatibility | ||
|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. | |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. | ||
| [[Boolean]] - Always [[true]] | | [[Boolean]] - Always [[true]] | ||
|exec= spawn |Execution= | |exec= spawn |Execution= | ||
|x1= <code>[ [[vehicle]] [[player]], _unitCaptureData ] [[spawn]] [[BIS_fnc_UnitPlay]]</code> | |x1= <code>[ [[vehicle]] [[player]], _unitCaptureData ] [[spawn]] [[BIS_fnc_UnitPlay]]</code> | ||
| [[BIS_fnc_UnitCaptureFiring]], [[BIS_fnc_UnitCaptureSimple]], [[BIS_fnc_UnitPlaySimple]], [[BIS_fnc_UnitPlayFiring]],[[BIS_fnc_UnitCapture]] | | [[BIS_fnc_UnitCaptureFiring]], [[BIS_fnc_UnitCaptureSimple]], [[BIS_fnc_UnitPlaySimple]], [[BIS_fnc_UnitPlayFiring]],[[BIS_fnc_UnitCapture]] | ||
}} | }} | ||
Revision as of 23:19, 17 January 2021
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