BIS fnc ambientAnim: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Ambient(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\] " to "")
m (Some wiki formatting)
 
(57 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. If the unit should react to combat, use [[BIS_fnc_ambientAnimCombat]] instead.
____________________________________________________________________________________________
{{Feature|informative|Animations can be cancelled using <sqf inline>_unit call BIS_fnc_ambientAnim__terminate</sqf>.}}


| Play set of ambient animations on given unit. If the unit should react to combat, use [[BIS_fnc_ambientAnimCombat]] instead.
|s1= [unit, animationSet, equipmentLevel, snapTo, interpolate, attachToLogic] call [[BIS_fnc_ambientAnim]]
{{Informative | Animations can be cancelled using {{Inline code|_unit [[call]] '''BIS_fnc_ambientAnim__terminate'''}}.}} |DESCRIPTION=
____________________________________________________________________________________________


| [unit, animationSet, equipmentLevel, snapTo, interpolate, attachToLogic] call [[BIS_fnc_ambientAnim]] |SYNTAX=
|p1= unit: [[Object]] - unit that will play the animations
 
|p1= unit: [[Object]] - unit that will play the animations |PARAMETER1=


|p2= animationSet: [[String]] - the animation set to play. Possible values:
|p2= animationSet: [[String]] - the animation set to play. Possible values:
{{{!}}
{{{!}}
{{!}}+ style="caption-side:bottom" {{!}} ''some values are missing due to duplicate results, e.g "STAND" does the same as "STAND1"''
{{!}}+ style="caption-side: bottom" {{!}} ''some values are missing due to duplicate results, e.g "STAND" does the same as "STAND1"''
{{!}}- style="vertical-align: top"
{{!}}- style="vertical-align: top"
{{!}}
{{!}}
Line 61: Line 57:
* BRIEFING_POINT_RIGHT
* BRIEFING_POINT_RIGHT
* BRIEFING_POINT_TABLE
* BRIEFING_POINT_TABLE
{{!}}} |PARAMETER2=
{{!}}}


|p3= equipmentLevel: [[String]] - the equipment level of the unit. Possible values:
|p3= equipmentLevel: [[String]] - the equipment level of the unit. Possible values:
Line 69: Line 65:
* FULL
* FULL
* ASIS
* ASIS
* RANDOM |PARAMETER3=
* RANDOM


|p4= snapTo: [[Object]] - (Optional, default [[objNull]]) the object where the unit will be snapped to |PARAMETER4=
|p4= snapTo: [[Object]] - (Optional, default [[objNull]]) the object where the unit will be snapped to


|p5= interpolate: [[Boolean]] - (Optional, default [[false]]) should try to interpolate into the ambient animation. Works only for some default stances |PARAMETER5=
|p5= interpolate: [[Boolean]] - (Optional, default [[false]]) should try to interpolate into the ambient animation. Works only for some default stances


|p6= attachToLogic: [[Boolean]] - (Optional, default [[true]]) [[true]] to [[attachTo|attach]] the unit to the created logic object, forcing it in one position |PARAMETER6=
|p6= attachToLogic: [[Boolean]] - (Optional, default [[true]]) [[true]] to [[attachTo|attach]] the unit to the created logic object, forcing it in one position


| [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]
____________________________________________________________________________________________


|x1= <code><nowiki>[</nowiki>[[player]], "STAND1", "ASIS"] [[call]] [[BIS_fnc_ambientAnim]];</code> |EXAMPLE1=
|x1= <sqf>[player, "STAND1", "ASIS"] call BIS_fnc_ambientAnim;</sqf>


|x2= <code>{{cc|will search for a chair within 2 meters around the unit and will place the unit on it}}
|x2= <sqf>
[_unit, "SIT", "NONE"] [[call]] [[BIS_fnc_ambientAnim]];</code> |EXAMPLE2=
// will search for a chair within 2 meters around the unit and will place the unit on it
____________________________________________________________________________________________
[_unit, "SIT", "NONE"] call BIS_fnc_ambientAnim;
</sqf>


| [[BIS_fnc_ambientAnimCombat]], [[BIS_fnc_ambientAnimGetParams]] |SEEALSO=
|seealso= [[BIS_fnc_ambientAnimCombat]] [[BIS_fnc_ambientAnimGetParams]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= PierreMGI
<!-- Note Section BEGIN -->
|timestamp= 20160219042400
<dd class="notedate">Posted on February 19, 2016 - 04:24
|text= In 3den editor, place a blufor unit (B_soldier_A_F) near a camping chair (land_campingChair_V2_F).<br>
<dt class="note">[[User:Pierre MGI|Pierre MGI]]
<dd class="note">In 3den editor, place a blufor unit (B_soldier_A_F) near a camping chair (land_campingChair_V2_F).<br>
In init field of the unit:<br>
In init field of the unit:<br>
<code>[this, "SIT2"] [[call]] [[BIS_fnc_ambientAnim]];<br>0 = this [[spawn]] {[[waitUntil]] {[[behaviour]] _this == "combat"};
<sqf>
_this [[call]] BIS_fnc_ambientAnim__terminate;}</code>
[this, "SIT2"] call BIS_fnc_ambientAnim;
0 = this spawn {
waitUntil { behaviour _this == "combat"};
_this call BIS_fnc_ambientAnim__terminate;
};
</sqf>
When this unit is aware of a threat, he will quit the "ambient animation" and will able to return fire.<br>
When this unit is aware of a threat, he will quit the "ambient animation" and will able to return fire.<br>
Note: [[BIS_fnc_ambientAnimCombat]] doesn't need this script but the list of animations is limited.
Note: [[BIS_fnc_ambientAnimCombat]] doesn't need this script but the list of animations is limited.
}}


<dd class="notedate">Posted on August 08, 2016 - 01:37
{{Note
<dt class="note">[[User:Pierre MGI|Pierre MGI]]
|user= PierreMGI
<dd class="note">To make this command working in MP (hosted server tested)
|timestamp= 20160808013700
<code>[this, "SIT2"] [[call]] [[BIS_fnc_ambientAnim]]; {{cc|wrong! the first JIP will throw the unit to position [0,0,0]}}
|text= To make this command working in MP (hosted server tested)
[[if]] ([[isServer]]) [[then]] { [this, "SIT2"] [[call]] [[BIS_fnc_ambientAnim]]; }; {{cc|wrong! only player located on server will see the animation}}
<sqf>
[[if]] ([[local]] this) [[then]] { [this, "SIT2"] [[call]] [[BIS_fnc_ambientAnim]]; }; {{cc|OK, best way}}
[this, "SIT2"] call BIS_fnc_ambientAnim; // wrong! the first JIP will throw the unit to position [0,0,0]
[[if]] ([[isServer]]) [[then]] { [<nowiki/>[this, "SIT2"], [[BIS_fnc_ambientAnim]]] [[remoteExec]] ["call"]; }; {{cc|OK}}</code>
if (isServer) then { [this, "SIT2"] call BIS_fnc_ambientAnim; }; // wrong! only player located on server will see the animation
if (local this) then { [this, "SIT2"] call BIS_fnc_ambientAnim; }; // OK, best way
if (isServer) then { [this, "SIT2"] remoteExecCall ["BIS_fnc_ambientAnim"]; }; // OK
</sqf>
}}


 
{{Note
<!-- Note Section END -->
|user= Icaruk
</dl>
|timestamp= 20160811163300
 
|text= Be careful using this function multiple times on MP, it creates a Logic using [[createUnit]] (which is global).<br>
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:ambientAnim}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:ambientAnim}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on September 11, 2016 - 16:33 (UTC)</dd>
<dt class="note">[[User:Icaruk|Icaruk]]</dt>
<dd class="note">
Be careful using this function multiple times on MP, it creates a Logic using [[createUnit]] (which is global).<br>
If you use it on 20 units, 20 additional logics will be created.
If you use it on 20 units, 20 additional logics will be created.
</dd>
}}
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 13:38, 27 July 2022

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Play set of ambient animations on given unit. If the unit should react to combat, use BIS_fnc_ambientAnimCombat instead.
ⓘ
Animations can be cancelled using _unit call BIS_fnc_ambientAnim__terminate.
Execution:
call
Groups:
Ambient

Syntax

Syntax:
[unit, animationSet, equipmentLevel, snapTo, interpolate, attachToLogic] call BIS_fnc_ambientAnim
Parameters:
unit: Object - unit that will play the animations
animationSet: String - the animation set to play. Possible values:
some values are missing due to duplicate results, e.g "STAND" does the same as "STAND1"
  • STAND1
  • STAND2
  • STAND_U1
  • STAND_U2
  • STAND_U3
  • WATCH
  • WATCH2
  • GUARD
  • LISTEN_BRIEFING
  • LEAN_ON_TABLE
  • LEAN
  • SIT_AT_TABLE
  • SIT1
  • SIT
  • SIT3
  • SIT_U1
  • SIT_U2
  • SIT_U3
  • SIT_HIGH1
  • SIT_HIGH
  • SIT_LOW
  • SIT_LOW_U
  • SIT_SAD1
  • SIT_SAD2
  • KNEEL
  • REPAIR_VEH_PRONE
  • REPAIR_VEH_KNEEL
  • REPAIR_VEH_STAND
  • PRONE_INJURED_U1
  • PRONE_INJURED_U2
  • PRONE_INJURED
  • KNEEL_TREAT
  • KNEEL_TREAT2
  • BRIEFING
  • BRIEFING_POINT_LEFT
  • BRIEFING_POINT_RIGHT
  • BRIEFING_POINT_TABLE
equipmentLevel: String - the equipment level of the unit. Possible values:
  • NONE
  • LIGHT
  • MEDIUM
  • FULL
  • ASIS
  • RANDOM
snapTo: Object - (Optional, default objNull) the object where the unit will be snapped to
interpolate: Boolean - (Optional, default false) should try to interpolate into the ambient animation. Works only for some default stances
attachToLogic: Boolean - (Optional, default true) true to attach the unit to the created logic object, forcing it in one position
Return Value:
Nothing

Examples

Example 1:
[player, "STAND1", "ASIS"] call BIS_fnc_ambientAnim;
Example 2:
// will search for a chair within 2 meters around the unit and will place the unit on it [_unit, "SIT", "NONE"] call BIS_fnc_ambientAnim;

Additional Information

See also:
BIS_fnc_ambientAnimCombat BIS_fnc_ambientAnimGetParams

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
PierreMGI - c
Posted on Feb 19, 2016 - 04:24 (UTC)
In 3den editor, place a blufor unit (B_soldier_A_F) near a camping chair (land_campingChair_V2_F).
In init field of the unit:
[this, "SIT2"] call BIS_fnc_ambientAnim; 0 = this spawn { waitUntil { behaviour _this == "combat"}; _this call BIS_fnc_ambientAnim__terminate; };
When this unit is aware of a threat, he will quit the "ambient animation" and will able to return fire.
Note: BIS_fnc_ambientAnimCombat doesn't need this script but the list of animations is limited.
PierreMGI - c
Posted on Aug 08, 2016 - 01:37 (UTC)
To make this command working in MP (hosted server tested)
[this, "SIT2"] call BIS_fnc_ambientAnim; // wrong! the first JIP will throw the unit to position [0,0,0] if (isServer) then { [this, "SIT2"] call BIS_fnc_ambientAnim; }; // wrong! only player located on server will see the animation if (local this) then { [this, "SIT2"] call BIS_fnc_ambientAnim; }; // OK, best way if (isServer) then { [this, "SIT2"] remoteExecCall ["BIS_fnc_ambientAnim"]; }; // OK
Icaruk - c
Posted on Aug 11, 2016 - 16:33 (UTC)
Be careful using this function multiple times on MP, it creates a Logic using createUnit (which is global).
If you use it on 20 units, 20 additional logics will be created.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_ambientAnim&oldid=329376"