BIS fnc ambientAnimCombat: Difference between revisions

Latest revision as of 15:52, 8 November 2023

1.00

Hover & click on the images for description

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

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:

"STAND"
"STAND_IA"
"SIT_LOW"
"KNEEL"
"LEAN"
"WATCH"
"WATCH1"
"WATCH2"

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

"NONE"
"LIGHT"
"MEDIUM"
"FULL"
"ASIS"
"RANDOM"

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

Examples

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

Additional Information

See also:: BIS_fnc_ambientAnim

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Ambient
-|1.00|= Game version
+|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 <sqf inline>_unit call BIS_fnc_ambientAnim__terminate</sqf>.}}
-| Play set of ambient animations on given unit AND allows the unit to leave the ambient state and engage enemy or move away.
+|s1= [unit, animationSet, equipmentLevel, condition, behaviour] call [[BIS_fnc_ambientAnimCombat]]
-{{note|Animations can be cancelled by calling _unit [[call]] '''BIS_fnc_ambientAnim__terminate'''}} |= Description
-____________________________________________________________________________________________
+|p1= unit: [[Object]] - unit where the animations will be played
-| [unit, animationset, equipmentlevel, condition, behaviour] call BIS_fnc_ambientAnimCombat;
+|p2= animationSet: [[String]] - (Optional, default "STAND") the animation set to play. Possible values are:
+* "STAND"
+* "STAND_IA"
+* "SIT_LOW"
+* "KNEEL"
+* "LEAN"
+* "WATCH"
+* "WATCH1"
+* "WATCH2"
-|p1= Unit [[Object]] - Unit where the animations will be played |= Parameter 1
+|p3= equipmentLevel: [[String]] - (Optional, default "RANDOM") the equipment level of the unit. Possible values are:
-|p2= Animation-Set [[String]] - The animationset to play <br>
+* "NONE"
-Possible values are:
+* "LIGHT"
-*STAND
+* "MEDIUM"
-*STAND_IA
+* "FULL"
-*SIT_LOW
+* "ASIS"
-*KNEEL
+* "RANDOM"
-*LEAN
-*WATCH
-*WATCH1
-*WATCH2
-|= Parameter 2
-|p3= Equipment-Level [[String]] - The equipment level of the unit <br>
-Possible values are:
-*NONE
-*LIGHT
-*MEDIUM
-*FULL
-*ASIS
-*RANDOM
-|= Paramter 3
-|p4= Condition [[Code]] or [[String]] - optional - condition that if true frees the unit from the animation loop |= Parameter 4
-|p5= Behaviour [[String]] - optional -  behaviour the unit should go to, when freed. Default "COMBAT"
-| None |= Return value
+|p4= condition: [[Code]] or [[String]] - (Optional, default <sqf inline>{ false }</sqf>) condition that if true frees the unit from the animation loop
-____________________________________________________________________________________________
-|x1= <code>[_unit,"STAND","FULL",{(player distance _this) < 5}] call BIS_fnc_ambientAnimCombat;</code> |= Example 1
+|p5= behaviour: [[String]] - (Optional, default "COMBAT") behaviour the unit should go to, when freed. Default "COMBAT"
-____________________________________________________________________________________________
-| [[BIS_fnc_ambientAnim]] |= See also
+|r1= [[Nothing]]
+|x1= <sqf>[_unit, "STAND", "FULL", { (player distance _this) < 5 }] call BIS_fnc_ambientAnimCombat;</sqf>
+|seealso= [[BIS_fnc_ambientAnim]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Ambient|{{uc:ambientAnimCombat}}]]
-[[Category:Functions|{{uc:ambientAnimCombat}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:ambientAnimCombat}}]]