BIS fnc animType: Difference between revisions

Latest revision as of 16:49, 8 November 2023

1.00

0.50

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:: Object Manipulation

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

Posted on 2014-10-01 - 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"]];

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= tkoh
-____________________________________________________________________________________________
+|version1= 1.00
-| tkoh |= Game name
+|game2= arma3
+|version2= 0.50
-|1.00|= Game version
+|gr1= Object Manipulation
-____________________________________________________________________________________________
-| <pre>/*
+|descr= Function that returns a categorized array using a single string with the animation name.
-	Description:
+|s1= param call [[BIS_fnc_animType]]
-	Returns type of animation
-	Parameter(s):
+|p1= [[String]] - animation name.
-	_this: STRING - animation name
-	Returns:
+|r1= [[Array]] - sorted arrays within an array with details about animation.
-	ARRAY
-*/
-#define COMPOSE_NAME(ID,NAME)\
+|x1= <sqf>animType = ["AmovPsitMstpSrasWrflDnon"] call BIS_fnc_animType;
-	if (_includeType && _typeName != "<Unknown>" && !_ignoreIncludeType) then {_typeName = format ["[%1] %2",_type,_typeName];};\
+// Returns [["Action","Move"],["Pose","Sit"],["Movement","Stop"],["Stance","Raised"],["Hand item","Rifle"],["Direction","Not specified"]]</sqf>
-	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
+|seealso=
-____________________________________________________________________________________________
+}}
-| <!-- [] call [[BIS_fnc_animType]]; --> |= Syntax
+<dl class="command_description">
-|p1= |= Parameter 1
+<dt></dt>
+<dd class="notedate">Posted on 2014-10-01 - 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:
+<pre>Action: Move
+Pose: Erect
+Movement: Stop
+Stance: Raised
+Weapon: Rifle
+</pre>
-| |= Return value
+Then the following array will be returned:
-____________________________________________________________________________________________
+<sqf>[["Action", "Move"], ["Pose", "Erect"], ["Movement", "Stop"], ["Stance", "Raised"], ["Hand item", "Rifle"], ["Direction", "Not specified"]];</sqf>
+</dd>
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| |= See also
-}}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
 </dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Misc|{{uc:animType}}]]
-[[Category:Functions|{{uc:animType}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:animType}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:animType}}]]