BIS fnc ambientAnimCombat: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1 = Ambient |GROUP1=")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *U([a-z ])" to "$1 - u$2")
 
(26 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Ambient


|gr1 = Ambient |GROUP1=
|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]]
{{Informative | Animations can be cancelled using {{Inline code|_unit [[call]] '''BIS_fnc_ambientAnim__terminate'''}}.}} |Description=
____________________________________________________________________________________________


| [unit, animationSet, equipmentLevel, condition, behaviour] call [[BIS_fnc_ambientAnimCombat]] |Syntax=
|p1= unit: [[Object]] - unit where the animations will be played


|p1= unit: [[Object]] - Unit where the animations will be played |Parameter 1=
|p2= animationSet: [[String]] - (Optional, default "STAND") the animation set to play. Possible values are:
 
|p2= animationSet: [[String]] - (Optional, default "STAND") The animation set to play. Possible values are:
* "STAND"
* "STAND"
* "STAND_IA"
* "STAND_IA"
Line 26: Line 22:
* "WATCH1"
* "WATCH1"
* "WATCH2"
* "WATCH2"
|Parameter 2=


|p3= equipmentLevel: [[String]] - (Optional, default "RANDOM") The equipment level of the unit. Possible values are:
|p3= equipmentLevel: [[String]] - (Optional, default "RANDOM") the equipment level of the unit. Possible values are:
* "NONE"
* "NONE"
* "LIGHT"
* "LIGHT"
Line 35: Line 30:
* "ASIS"
* "ASIS"
* "RANDOM"
* "RANDOM"
|Parameter 3=


|p4= condition: [[Code]] or [[String]] - (Optional, default {{Inline code|{ [[false]] <nowiki>}</nowiki>}}) condition that if true frees the unit from the animation loop |Parameter 4=
|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" |Parameter 5=
|p5= behaviour: [[String]] - (Optional, default "COMBAT") behaviour the unit should go to, when freed. Default "COMBAT"


| [[Nothing]] |Return value=
|r1= [[Nothing]]
____________________________________________________________________________________________


|x1= <code>[_unit, "STAND", "FULL", { ([[player]] [[distance]] [[_this]]) < 5 }] [[call]] [[BIS_fnc_ambientAnimCombat]];</code> |Example 1=
|x1= <sqf>[_unit, "STAND", "FULL", { (player distance _this) < 5 }] call BIS_fnc_ambientAnimCombat;</sqf>
____________________________________________________________________________________________


| [[BIS_fnc_ambientAnim]] |See also=
|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}}]]

Latest revision as of 15:52, 8 November 2023

Arma 3 logo black.png1.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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_ambientAnimCombat&oldid=349315"