BIS fnc ambientAnimCombat: Difference between revisions

Revision as of 17:27, 13 July 2022

Hover & click on the images for description

Description:: Play set of ambient animations on given unit AND allows the unit to leave the ambient state and engage enemy or move away.
ⓘ
Animations can be cancelled using _unit call BIS_fnc_ambientAnim__terminate.
Execution:: call
Groups:: Ambient

Syntax:

[unit, animationSet, equipmentLevel, condition, behaviour] call BIS_fnc_ambientAnimCombat

Parameters:

unit: Object - Unit where the animations will be played

animationSet: String - (Optional, default "STAND") The animation set to play. Possible values are:

equipmentLevel: String - (Optional, default "RANDOM") The equipment level of the unit. Possible values are:

condition: Code or String - (Optional, default { false }) condition that if true frees the unit from the animation loop

behaviour: String - (Optional, default "COMBAT") behaviour the unit should go to, when freed. Default "COMBAT"

Return Value:

Nothing

Example 1:: [_unit, "STAND", "FULL", { (player distance _this) < 5 }] call BIS_fnc_ambientAnimCombat;

: 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 7: / Line 7: @@
 |descr= Play set of ambient animations on given unit AND allows the unit to leave the ambient state and engage enemy or move away.
-{{Feature | Informative | Animations can be cancelled using {{ic|_unit [[call]] '''BIS_fnc_ambientAnim__terminate'''}}.}}
+{{Feature|informative|Animations can be cancelled using <sqf inline>_unit call BIS_fnc_ambientAnim__terminate</sqf>.}}
 |s1= [unit, animationSet, equipmentLevel, condition, behaviour] call [[BIS_fnc_ambientAnimCombat]]
@@ Line 31: / Line 31: @@
 * "RANDOM"
-|p4= condition: [[Code]] or [[String]] - (Optional, default {{ic|{ [[false]] <nowiki>}</nowiki>}}) condition that if true frees the unit from the animation loop
+|p4= condition: [[Code]] or [[String]] - (Optional, default <sqf inline>{ false }</sqf>) condition that if true frees the unit from the animation loop
 |p5= behaviour: [[String]] - (Optional, default "COMBAT") behaviour the unit should go to, when freed. Default "COMBAT"
@@ Line 37: / Line 37: @@
 |r1= [[Nothing]]
-|x1= <sqf>[_unit, "STAND", "FULL", { ([[player]] [[distance]] _this) < 5 }] [[call]] [[BIS_fnc_ambientAnimCombat]];</sqf>
+|x1= <sqf>[_unit, "STAND", "FULL", { (player distance _this) < 5 }] call BIS_fnc_ambientAnimCombat;</sqf>
 |seealso= [[BIS_fnc_ambientAnim]]
 }}