BIS fnc ambientAnimCombat: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1 = Ambient |GROUP1=
|gr1 = Ambient


| Play set of ambient animations on given unit AND allows the unit to leave the ambient state and engage enemy or move away.
| Play set of ambient animations on given unit AND allows the unit to leave the ambient state and engage enemy or move away.
{{Informative | Animations can be cancelled using {{Inline code|_unit [[call]] '''BIS_fnc_ambientAnim__terminate'''}}.}} |Description=
{{Informative | Animations can be cancelled using {{Inline code|_unit [[call]] '''BIS_fnc_ambientAnim__terminate'''}}.}}


| [unit, animationSet, equipmentLevel, condition, behaviour] call [[BIS_fnc_ambientAnimCombat]] |Syntax=
| [unit, animationSet, equipmentLevel, condition, behaviour] call [[BIS_fnc_ambientAnimCombat]]


|p1= unit: [[Object]] - Unit where the animations will be played |Parameter 1=
|p1= unit: [[Object]] - Unit where the animations will be played


|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:
Line 23: Line 23:
* "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:
Line 32: Line 32:
* "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=


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


| [[Nothing]] |Return value=
| [[Nothing]]


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


| [[BIS_fnc_ambientAnim]] |See also=
| [[BIS_fnc_ambientAnim]]
}}
}}


Revision as of 23:37, 17 January 2021

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


Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_ambientAnimCombat&oldid=202592"