BIS fnc animType: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - "|= Game version" to "|Game version=")
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:


{{Function|= Comments
{{Function|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| tkoh |= Game name
| tkoh |Game name=


|1.00|= Game version
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Function that returns a categorized array using a single string with the animation name. |DESCRIPTION=
 
Description:
Returns type of animation
 
Parameter(s):
_this: STRING - animation name
 
Returns:
ARRAY
*/
 
#define COMPOSE_NAME(ID,NAME)\
if (_includeType && _typeName != "<Unknown>" && !_ignoreIncludeType) then {_typeName = format ["[%1] %2",_type,_typeName];};\
if (_includeCategory) then {\
_animType set [##ID##,[##NAME##,_typeName]];\
} else {\
_animType set [##ID##,_typeName];\
};
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_animType]]; --> |= Syntax
| param call [[BIS_fnc_animType]]; |SYNTAX=


|p1= |= Parameter 1
|p1= [[String]] - Animation name.|PARAMETER1=


| |= Return value
| [[Array]] - Sorted arrays within an array with details about animation. |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>animType = ["AmovPsitMstpSrasWrflDnon"] call BIS_fnc_animType; <br>// Returns [["Action","Move"],["Pose","Sit"],["Movement","Stop"],["Stance","Raised"],["Hand item","Rifle"],["Direction","Not specified"]]</code> |=  
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| |SEEALSO=


}}
}}
Line 57: Line 37:
[[Category:{{Name|tkoh}}: Functions|{{uc:animType}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:animType}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:animType}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:animType}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on October 1, 2014 - 20:26 (UTC)</dd>
<dt class="note">[[User:Tryteyker-|Tryteyker-]]</dt>
<dd class="note">
The categorization is identical to that of the animation viewer, minus the direction array.
<br>So if the animation you are running through this function is found in the following categories:
<code>
<nowiki>
Action: Move
Pose: Erect
Movement: Stop
Stance: Raised
Weapon: Rifle
</nowiki>
</code>
Then the following array will be returned:
<code>
<nowiki>
[["Action","Move"],["Pose","Erect"],["Movement","Stop"],["Stance","Raised"],["Hand item","Rifle"],["Direction","Not specified"]];
</nowiki>
</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 02:29, 30 August 2019


tkoh logo small.png1.00
Hover & click on the images for description

Description

Description:
Function that returns a categorized array using a single string with the animation name.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
param call BIS_fnc_animType;
Parameters:
String - Animation name.
Return Value:
Array - Sorted arrays within an array with details about animation.

Examples

Example 1:
animType = ["AmovPsitMstpSrasWrflDnon"] call BIS_fnc_animType;
// Returns [["Action","Move"],["Pose","Sit"],["Movement","Stop"],["Stance","Raised"],["Hand item","Rifle"],["Direction","Not specified"]]

Additional Information

See also:
See also needed

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

Bottom Section

Posted on October 1, 2014 - 20:26 (UTC)
Tryteyker-
The categorization is identical to that of the animation viewer, minus the direction array.
So if the animation you are running through this function is found in the following categories: Action: Move Pose: Erect Movement: Stop Stance: Raised Weapon: Rifle Then the following array will be returned: [["Action","Move"],["Pose","Erect"],["Movement","Stop"],["Stance","Raised"],["Hand item","Rifle"],["Direction","Not specified"]];
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_animType&oldid=127000"