BIS_fnc_unitPlaySimple

1.00

Hover & click on the images for description

Description

Description:

/*
	File: fn_UnitPlaySimple.sqf

	Description:
	Plays back input movement data on input unit. Simplified.

	Parameters:
	Unit					- Unit to play movement data on
	Data					- Movement data to use
	OPT:[Object, Variable]	- OPTIONAL: Variable to set on specified Object once playback has finished
	OPT:IgnoreDisabled		- OPTIONAL: Whether to ignore if the Unit is dead and/or cannot move
	OPT:Debug				- OPTIONAL: Whether to give debug information on played frames per second
	OPT:Sleep				- OPTIONAL: 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.
	OPT:SkipTime			- OPTIONAL: 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.

	Examples (used in a script):
	a)	_capturedData = [[0,[8208.26,1953.13,296.04],67]];
		[BIS_Vehicle, _capturedData, [BIS_Object, "DoneRecording"], true, false, 0.2, 5] spawn BIS_fnc_UnitPlay;
			Which would play back the captured data in the _capturedData array (containing only one frame in this example)
			onto a unit named BIS_Vehicle. Playback will play even if the unit is dead or disabled. Debug information would
			not show and playing back would update once every 0.2 seconds. Once the playback finished, an object named
			BIS_Object would have a variable called "DoneRecording" set to TRUE. Playback would skip the first 5 seconds
			of data.
	
	b)	_capturedData = [[0,[8208.26,1953.13,296.04],67]];
		[BIS_Vehicle, _capturedData, [], false, true] spawn BIS_fnc_UnitPlay;
			Which would play back the captured data in the _capturedData array (containing only one frame in this example)
			onto a unit named BIS_Vehicle. Playback will play only while the unit is alive and can move. Debug information
			would show.
	
	c)	_capturedData = [[0,[8208.26,1953.13,296.04],67]];
		[BIS_Vehicle, _capturedData] spawn BIS_fnc_UnitPlay;
			Which would play back the captured data in the _capturedData array (containing only one frame in this example)
			onto a unit named BIS_Vehicle.
	
	Note that in a very large captured sequence, it is a better idea to preprocess the data prior to mission start, or
	a short freeze would occur as it reads the data. For example using the following in the mission's init:
	
		UnitData = compile preprocessFile "PlayBackUnit.sqf";

	..And then later start the sequence like this:
	
		// Start the sequence
		_result = [] call UnitData;
*/

(Placeholder description extracted from the function header by BIS_fnc_exportFunctionsToWiki)

Execution:

call

Groups:

Uncategorised

Syntax

Syntax:

Syntax needed

Return Value:

Return value needed

Examples

Example 1:

Additional Information

See also:

See also needed

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