BIS fnc unitPlaySimple: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "(Optional, default [])" to "(Optional, default {{hl|[]}})")
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(One intermediate revision by the same user not shown)
Line 20: Line 20:
|p2= data: [[Array]] - movement data to use
|p2= data: [[Array]] - movement data to use


|p3= varDone: [[Array]] - (Optional, default {{hl|[]}}) variable to set on specified Object once playback has finished in format:
|p3= varDone: [[Array]] - (Optional, default <sqf inline>[]</sqf>) variable to set on specified Object once playback has finished in format:
* 0: [[Object]], [[Group]] or [[Namespace]] - target
* 0: [[Object]], [[Group]] or [[Namespace]] - target
* 1: [[String]] - variable name
* 1: [[String]] - variable name
Line 32: Line 32:
|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.


|r1= [[Script Handle]] - Script handle
|r1= [[Script Handle]] - script handle


|exec= spawn
|exec= spawn

Latest revision as of 18:09, 8 November 2023

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, debug, sleep, skipTime] spawn BIS_fnc_unitPlaySimple
Parameters:
unit: Object - unit to play movement data on
data: Array - movement data to use
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
debug: Boolean - (Optional, default false whether to give debug information on played frames per second
sleep: Number - (Optional, default 0) time to sleep between frames. This is if you want to be recording another unit and playing back movement data on another as well. Limit is 0-1 seconds.
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:
Script Handle - script handle

Examples

Example 1:
private _capturedData = [[0, [8208.26, 1953.13, 296.04], 67]]; [BIS_Vehicle, _capturedData, [BIS_Object, "DoneRecording"], true, false, 0.2, 5] spawn BIS_fnc_unitPlaySimple;

Additional Information

See also:
BIS_fnc_unitCaptureFiring BIS_fnc_unitCaptureSimple BIS_fnc_unitPlayFiring BIS_fnc_unitPlay 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