BIS fnc unitPlaySimple: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " |s1=[" to " |s1= [")
m (Fix Script link)
Line 16: Line 16:
|s1= [unit, data, varDone, stateIngnore, debug, sleep, skipTime] spawn [[BIS_fnc_unitPlaySimple]]
|s1= [unit, data, varDone, stateIngnore, debug, sleep, skipTime] spawn [[BIS_fnc_unitPlaySimple]]


|p1= unit: [[Object]] - Unit to play movement data on
|p1= unit: [[Object]] - unit to play movement data on


|p2= data: [[Array]] - Movement data to use
|p2= data: [[Array]] - movement data to use


|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]], [[Group]] or [[Namespace]] - Target
* 0: [[Object]], [[Group]] or [[Namespace]] - Target
*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= debug: [[Boolean]] - (Optional, default [[false]] Whether to give debug information on played frames per second
|p5= debug: [[Boolean]] - (Optional, default [[false]] whether to give debug information on played frames per second


|p6= 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.
|p6= 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.


|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]] - Script handle
|r1= [[Script Handle]] - Script handle


|exec= spawn
|exec= spawn


|x1= <sqf>private _capturedData = [[0,[8208.26,1953.13,296.04],67]];
|x1= <sqf>
[BIS_Vehicle, _capturedData, [BIS_Object, "DoneRecording"], true, false, 0.2, 5] spawn BIS_fnc_unitPlaySimple;</sqf>
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;
</sqf>


|seealso= [[BIS_fnc_unitCaptureFiring]] [[BIS_fnc_unitCaptureSimple]] [[BIS_fnc_unitPlayFiring]] [[BIS_fnc_unitPlay]] [[BIS_fnc_unitCapture]]
|seealso= [[BIS_fnc_unitCaptureFiring]] [[BIS_fnc_unitCaptureSimple]] [[BIS_fnc_unitPlayFiring]] [[BIS_fnc_unitPlay]] [[BIS_fnc_unitCapture]]
}}
}}

Revision as of 09:45, 29 December 2022

A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_unitPlaySimple&oldid=336356"