BIS fnc ambientAnimGetParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (typo)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(32 intermediate revisions by 2 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
____________________________________________________________________________________________


| Feeds params of given animset to [[BIS_fnc_ambientAnim]]. |Description=
|descr= Feeds params of given animset to [[BIS_fnc_ambientAnim]].
____________________________________________________________________________________________


| input call [[BIS_fnc_ambientAnimGetParams]] |Syntax=
|s1= animType call [[BIS_fnc_ambientAnimGetParams]]


|p1= animType: [[String]] - can be:
{{Columns|4|
* "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"
}}


|p1= input: [[String]] - Can be:<br>
|r1= [[Array]] - animation parameters
    "STAND1"<br>
    "STAND2"<br>
    "STAND_U1"<br>
    "STAND_U2"<br>
    "STAND_U3"<br>
    "WATCH"<br>
    "WATCH2"<br>
    "GUARD"<br>
    "LISTEN_BRIEFING"<br>
    "LEAN_ON_TABLE"<br>
    "LEAN"<br>
    "SIT_AT_TABLE"<br>
    "SIT1"<br>
    "SIT"<br>
    "SIT3"<br>
    "SIT_U1"<br>
    "SIT_U2"<br>
    "SIT_U3"<br>
    "SIT_HIGH1"<br>
    "SIT_HIGH"<br>
    "SIT_LOW"<br>
    "SIT_LOW_U"<br>
    "SIT_SAD1"<br>
    "SIT_SAD2"<br>
    "KNEEL"<br>
    "REPAIR_VEH_PRONE"<br>
    "REPAIR_VEH_KNEEL"<br>
    "REPAIR_VEH_STAND"<br>
    "PRONE_INJURED_U1"<br>
    "PRONE_INJURED_U2"<br>
    "PRONE_INJURED"<br>
    "KNEEL_TREAT"<br>
    "KNEEL_TREAT2"<br>
    "BRIEFING"<br>
    "BRIEFING_POINT_LEFT"<br>
    "BRIEFING_POINT_RIGHT"<br>
    "BRIEFING_POINT_TABLE"|Parameter 1=
 
 
<!---
|exec= spawn |= Execution
--->
 
| [[Array]] - Animation parameters |Return value=
____________________________________________________________________________________________


|x1= <code>_animParams = "KEEL" [[call]] [[BIS_fnc_ambientAnimGetParams]];</code>|Example 1=
|x1= <sqf>private _animParams = "KNEEL" call BIS_fnc_ambientAnimGetParams;</sqf>
____________________________________________________________________________________________


| [[BIS_fnc_ambientAnimCombat]], [[BIS_fnc_ambientAnim]] |See also=
|seealso= [[BIS_fnc_ambientAnimCombat]] [[BIS_fnc_ambientAnim]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on August 22, 2014 - 2330</dd>
<dt class="note">[[User:ffur2007slx2_5| ffur2007slx2_5]]</dt>
<dd class="note">(A3 1.26) Sorting animation state by keyword:
<code> ("KNEEL" [[call]] [[BIS_fnc_ambientAnimGetParams]]) [[select]] 0;
//return: ["amovpknlmstpslowwrfldnon"…]</code>
Useful keywords are: "STAND", "WATCH", "GUARD", "LISTEN_BRIEFING", "LEAN_ON_TABLE", "LEAN", "SIT_AT_TABLE", "KNEEL", "PRONE_INJURED", "BRIEFING" ect.
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Ambient|{{uc:ambientAnimGetParams}}]]
[[Category:Functions|{{uc:ambientAnimGetParams}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:ambientAnimGetParams}}]]

Latest revision as of 14:59, 8 November 2023

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

Description

Description:
Feeds params of given animset to BIS_fnc_ambientAnim.
Execution:
call
Groups:
Ambient

Syntax

Syntax:
animType call BIS_fnc_ambientAnimGetParams
Parameters:
animType: String - can be:
  • "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"
Return Value:
Array - animation parameters

Examples

Example 1:
private _animParams = "KNEEL" call BIS_fnc_ambientAnimGetParams;

Additional Information

See also:
BIS_fnc_ambientAnimCombat 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_ambientAnimGetParams&oldid=348306"