BIS fnc scriptedMove: Difference between revisions

Revision as of 10:37, 18 May 2022

Hover & click on the images for description

Description:: Forces a unit to turn towards and walk to provided destination(s). Will not work on player.
⚠
Fixed version compatible with Arma 3 will be available in Arma 3 v2.10 or in the dev branch

ⓘ
When using endAnim, make sure it is able to break walkAnim (not all animations are compatible). When code is executed, it receives the following params [unit, waypoints, currentIndex, userArgs]
Execution:: call
Groups:: Object Manipulation

Syntax:: [unitOrGroup, waypoints, code, walkAnim, completionRadius, endAnim] call BIS_fnc_scriptedMove
Parameters:: unitOrGroup: Object or Group - unit or group of units of the class "Man"
: waypoints: Array of Positions in format [pos1, pos2,...] or [[pos1, completionRadius1, turnSpeedCoef1], [pos2, completionRadius2, turnSpeedCoef2],...]
: code: Code or Array - (Optional, default {}) code to run after each waypoint completion. Format {code} or [[params], {code}]
: walkAnim: String - (Optional, default "AmovPercMwlkSnonWnonDf") walking animation to be played in a loop
: completionRadius: Number - (Optional, default 0.5) how far from waypoint center to consider waypoint completion. Global value. The completionRadius given with individual waypoint position overrides global value.
: turnSpeedCoef: Number - (Optional, default 1.0) how quickly the unit turns towards next waypoint (fast 0.1 ... 10 slow). The turnSpeedCoef given with individual waypoint position overrides global value.
: endAnim: Number - (Optional, default animationState of the unit prior to function execution) when unit reaches last point, this is the animation to be played immediately. Use "" to let last walkAnim run in full.
Return Value:: Script Handle or String or Nothing - depends on execution (local/remote/error);

Example 1:: [myUnit, [getMarkerPos "wp1", getMarkerPos "wp2", getMarkerPos "wp3"]] call BIS_fnc_scriptedMove;

: 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

@@ Line 20: / Line 20: @@
 {{Feature | Informative | When using endAnim, make sure it is able to break walkAnim (not all animations are compatible). When code is executed, it receives the following params [unit, waypoints, currentIndex, userArgs] }}
-|s1= [unit, waypoints, code, walkAnim, completionRadius, endAnim] call [[BIS_fnc_scriptedMove]]
+|s1= [unitOrGroup, waypoints, code, walkAnim, completionRadius, endAnim] call [[BIS_fnc_scriptedMove]]
-|p1= unit: [[Object]] or [[Group]] - unit or group of units of the class "Man"
+|p1= unitOrGroup: [[Object]] or [[Group]] - unit or group of units of the class "Man"
 |p2= waypoints: [[Array]] of [[Position]]s in format [pos1, pos2,...] or <nowiki>[</nowiki>[pos1, completionRadius1, turnSpeedCoef1], [pos2, completionRadius2, turnSpeedCoef2],...]