{"name":"BIS_fnc_ambientAnimCombat","operator":null,"title":"BIS fnc ambientAnimCombat","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ambientAnimCombat","revid":349315,"updated":"2023-11-08T14:52:25Z","groups":["Ambient"],"status":"ok","replaced_by":[],"games":[{"game":"arma3","name":"Arma 3","version":"1.00"}],"since":{"game":"arma3","name":"Arma 3","version":"1.00"},"arma3_since":"1.00","branch":null,"locality":{"argument":null,"effect":null,"server_exec":false},"exec":null,"description":"Play set of ambient animations on given unit AND allows the unit to leave the ambient state and engage enemy or move away.\n\n> [!NOTE]\n> Animations can be cancelled using `_unit call BIS_fnc_ambientAnim__terminate`.","syntaxes":[{"syntax":"[unit, animationSet, equipmentLevel, condition, behaviour] call BIS_fnc_ambientAnimCombat","since":null,"effect":null,"exec":null,"params":[{"name":"unit","type":"Object","optional":false,"default":null,"description":"unit where the animations will be played","types":["Object"],"since":null,"text":"unit: Object - unit where the animations will be played"},{"name":"animationSet","type":"String","optional":true,"default":"\"STAND\"","description":"the animation set to play. Possible values are:\n- \"STAND\"\n- \"STAND_IA\"\n- \"SIT_LOW\"\n- \"KNEEL\"\n- \"LEAN\"\n- \"WATCH\"\n- \"WATCH1\"\n- \"WATCH2\"","types":["String"],"since":null,"text":"animationSet: String - (Optional, default \"STAND\") the animation set to play. Possible values are:\n- \"STAND\"\n- \"STAND_IA\"\n- \"SIT_LOW\"\n- \"KNEEL\"\n- \"LEAN\"\n- \"WATCH\"\n- \"WATCH1\"\n- \"WATCH2\""},{"name":"equipmentLevel","type":"String","optional":true,"default":"\"RANDOM\"","description":"the equipment level of the unit. Possible values are:\n- \"NONE\"\n- \"LIGHT\"\n- \"MEDIUM\"\n- \"FULL\"\n- \"ASIS\"\n- \"RANDOM\"","types":["String"],"since":null,"text":"equipmentLevel: String - (Optional, default \"RANDOM\") the equipment level of the unit. Possible values are:\n- \"NONE\"\n- \"LIGHT\"\n- \"MEDIUM\"\n- \"FULL\"\n- \"ASIS\"\n- \"RANDOM\""},{"name":"condition","type":"Code or String","optional":true,"default":"`{ false }`","description":"condition that if true frees the unit from the animation loop","types":["Code","String"],"since":null,"text":"condition: Code or String - (Optional, default `{ false }`) condition that if true frees the unit from the animation loop"},{"name":"behaviour","type":"String","optional":true,"default":"\"COMBAT\"","description":"behaviour the unit should go to, when freed. Default \"COMBAT\"","types":["String"],"since":null,"text":"behaviour: String - (Optional, default \"COMBAT\") behaviour the unit should go to, when freed. Default \"COMBAT\""}],"returns":{"type":"Nothing","types":["Nothing"],"description":null,"text":"Nothing"}}],"examples":[{"text":"```sqf\n[_unit, \"STAND\", \"FULL\", { (player distance _this) < 5 }] call BIS_fnc_ambientAnimCombat;\n```","code":["[_unit, \"STAND\", \"FULL\", { (player distance _this) < 5 }] call BIS_fnc_ambientAnimCombat;"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":["BIS_fnc_ambientAnim"],"notes":[],"categories":["Arma 3: Functions","Arma 3: New Functions","Function Group: Ambient","Functions","Introduced with Arma 3 version 1.00"],"docblock":null,"filled_from_docblock":[]}