BIS fnc ambientAnim: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
(Undo revision 97355 by Revo (talk) Revo you forgot to create a new page :))
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| Arma 3 |= Game
| arma3 |= Game name


|1.62|= Game Version
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


|Replaces object with simple object. Object must not contain any crew and must be placed on ground.<br><br>
| Play set of ambient animations on given unit. |= Description
____________________________________________________________________________________________


Remarks:<br>
| [unit, animationset, equipmentlevel, snaptoObject, interpolate] call '''BIS_fnc_ambientAnim'''
* Useful if you do not have access to simple object adjustment data - e.g. in case of unsupported/discontinued asset.<br>
{{note|Animations can be cancelled by calling _unit [[call]] '''BIS_fnc_ambientAnim__terminate'''}}
* All official assets have the adjustment data defined in config.<br><br>


{{note|Use with caution as this technique is not very clean - should '''not''' be used for many objects and definitely '''not in MP''' games.}}
|= Syntax
|= Description
____________________________________________________________________________________________


| [object] [[call]] '''BIS_fnc_replaceWithSimpleObject''' |= Syntax
|p1= Unit [[Object]] - Unit where the animations will be played |= Parameter 1
|p2= Animation-Set [[String]] - The animationset to play <br>
Possible values are: (Some values are missing because some of them do the same animations: "STAND" is 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
|= Parameter 2
|p3= EquipmentLevel [[String]] - The equipment level of the unit <br>
Possible values:
*NONE
*LIGHT
*MEDIUM
*FULL
*ASIS
*RANDOM
|= Parameter 3
|p4= snapToObject [[Object]] - Optional - The object where the unit will be snapped to |= Parameter 4
|p5= interpolate [[Bool]] - Optional - Should try to interpolate into the ambient animation. Works only for some default stances


|p1= [[Object]]: Object that will be replaced by simple object|= Parameter 1
____________________________________________________________________________________________
| [[Boolean]] - [[true]] if throwable |= Return value


| None |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>[tank] [[call]] '''BIS_fnc_replaceWithSimpleObject''';</code>|= EXAMPLE1
|x1= <code>[player, "STAND1", "NONE"] [[call]] [[BIS_fnc_ambientAnim]];</code> |= Example 1
 
|x2= <code>[_unit, "SIT", "NONE"] [[call]] [[BIS_fnc_ambientAnim]];</code>
Will search for a chair within 2 meters around the unit and will "place" the unit on it |=Example 2
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[createSimpleObject]], [[BIS_fnc_adjustSimpleObject]], [[BIS_fnc_createSimpleObject]], [[BIS_fnc_simpleObjectData]] |= See Also
| [[BIS_fnc_ambientAnimCombat]], [[BIS_fnc_ambientAnimGetParams]] |= See also


}}
}}


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- Note Section BEGIN -->
<!-- For example:
<dd class="notedate">Posted on February 19, 2016 - 04:24
<dd class="notedate">Posted on Month Day, Year - Time (UTC)</dd>
<dt class="note">'''[[User:Pierre MGI|Pierre MGI]]'''
<dt class="note">'''[[User:User Name|User Name]]'''</dt>
<dd class="note">In 3den editor, place a blufor unit (B_soldier_A_F) near a camping chair (land_campingChair_V2_F).<br>
<dd class="note">This is an example note. It is true and verifiable, and contains a little code snippet.
In init field of the unit:<br>
<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] "Leave it here for others to read"; };</code></dd>
<code>[this,"SIT2"] [[call]] [[BIS_fnc_ambientAnim]];<br>0 = this [[spawn]] {[[waitUntil]] {[[behaviour]] _this == "combat"};<br>
-->
_this [[call]] BIS_fnc_ambientAnim__terminate;}</code>
<!-- END Note Section -->
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.
<br><br>
<dd class="notedate">Posted on August 08, 2016 - 01:37
<dt class="note">'''[[User:Pierre MGI|Pierre MGI]]'''
<dd class="note">To make this command working in MP (hosted server tested)<br>
<code>[this,"SIT2"] [[call]] [[BIS_fnc_ambientAnim]]; // Wrong! the first JIP will throw the unit to position [0,0,0]<br>
[[if]] ([[isServer]]) [[then]] {[this,"SIT2"] [[call]] [[BIS_fnc_ambientAnim]]} // Wrong! only player located on server will see the animation<br>
[[if]] ([[isServer]]) [[then]] { [[this,"SIT2"],[[BIS_fnc_ambientAnim]] ] [[remoteExec]] ["call"] }; OK </code><br> <br>
 
 
<!-- Note Section END -->
</dl>
</dl>


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
<!-- Appropriate categories go here -->
[[Category:Function Group: Ambient|{{uc:ambientAnim}}]]
[[Category:Arma 3: Functions|{{uc:{{PAGENAME}}}}]]
[[Category:Functions|{{uc:ambientAnim}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:ambientAnim}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on July 28, 2016 - 19:14 (UTC)</dd>
<dt class="note">[[User:TheBlueFire|TheBlueFire]]</dt>
<dd class="note">
If the unit should react to combat use [[BIS_fnc_ambientAnimCombat]] instead
</dd>
</dl>
<!-- DISCONTINUE Notes -->
 
<!-- 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 uses [[createUnit]] (global).<br>
If you use it on 20 units, 20 additional units (logics) will be created.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 16:19, 14 September 2016


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

Description

Description:
Play set of ambient animations on given unit.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[unit, animationset, equipmentlevel, snaptoObject, interpolate] call BIS_fnc_ambientAnim Template:note
Parameters:
Unit Object - Unit where the animations will be played
Animation-Set String - The animationset to play
Possible values are: (Some values are missing because some of them do the same animations: "STAND" is 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
snapToObject Object - Optional - The object where the unit will be snapped to
interpolate Bool - Optional - Should try to interpolate into the ambient animation. Works only for some default stances
Return Value:
None

Examples

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

Additional Information

See also:
BIS_fnc_ambientAnimCombatBIS_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

Notes

Posted on February 19, 2016 - 04:24
Pierre MGI
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.

Posted on August 08, 2016 - 01:37
Pierre MGI
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 (isServer) then { [[this,"SIT2"],BIS_fnc_ambientAnim ] remoteExec ["call"] }; OK

Bottom Section

Posted on July 28, 2016 - 19:14 (UTC)
TheBlueFire
If the unit should react to combat use BIS_fnc_ambientAnimCombat instead
Posted on September 11, 2016 - 16:33 (UTC)
Icaruk
Be careful using this function multiple times on MP, it uses createUnit (global).
If you use it on 20 units, 20 additional units (logics) will be created.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_ambientAnim&oldid=97359"