BIS fnc unitPlaySimple: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
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|Comments=
{{Function


| arma2oa |Game name=
| arma2oa


|1.00|Game version=
|1.00


|gr1 = Scenes |GROUP1=
|gr1 = Scenes


| Plays back input movement data on input unit. Simplified. |Description=
| Plays back input movement data on input unit. Simplified.


| [unit, data, varDone, stateIngnore, debug, sleep, skipTime] spawn [[BIS_fnc_UnitPlaySimple]] |Syntax=
| [unit, data, varDone, stateIngnore, debug, sleep, skipTime] spawn [[BIS_fnc_UnitPlaySimple]]




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


|p2= data: [[Array]] - Movement data to use |Parameter 2=
|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|Parameter 3=
*1: [[String]] - Variable name


|p4= stateIgnore: [[Boolean]] - (Optional, default [[false]]) Whether to ignore if the Unit is dead and/or cannot move |Parameter 4=
|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 |Parameter 5=
|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. |Parameter 6=
|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. |Parameter 7=
|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.


| [[Script]] - Script handle |Return value=
| [[Script]] - Script handle


|exec= spawn |Execution=
|exec= spawn |Execution=


|x1= <code>_capturedData = [[0,[8208.26,1953.13,296.04],67]];
|x1= <code>_capturedData = [[0,[8208.26,1953.13,296.04],67]];
[BIS_Vehicle, _capturedData, [BIS_Object, "DoneRecording"], [[true]], [[false]], 0.2, 5] [[spawn]] [[BIS_fnc_UnitPlaySimple]];</code> |Example 1=
[BIS_Vehicle, _capturedData, [BIS_Object, "DoneRecording"], [[true]], [[false]], 0.2, 5] [[spawn]] [[BIS_fnc_UnitPlaySimple]];</code>


| [[BIS_fnc_UnitCaptureFiring]], [[BIS_fnc_UnitCaptureSimple]], [[BIS_fnc_UnitPlayFiring]], [[BIS_fnc_UnitPlay]], [[BIS_fnc_UnitCapture]] |See also=
| [[BIS_fnc_UnitCaptureFiring]], [[BIS_fnc_UnitCaptureSimple]], [[BIS_fnc_UnitPlayFiring]], [[BIS_fnc_UnitPlay]], [[BIS_fnc_UnitCapture]]
}}
}}


Revision as of 22:23, 17 January 2021

A2 OA Logo.png1.00
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 - Script handle

Examples

Example 1:
_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_UnitCaptureFiringBIS_fnc_UnitCaptureSimpleBIS_fnc_UnitPlayFiringBIS_fnc_UnitPlayBIS_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


Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_unitPlaySimple&oldid=202466"