typeName: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Fix)
 
(137 intermediate revisions by 13 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.00


|1.00|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Returns the [[:Category:Data Types|data type]] of an expression.  
|game3= arma2oa
|version3= 1.50


The type is returned as an all-uppercase string having one of the following values: "ARRAY","BOOL","CODE","CONFIG","CONTROL","DISPLAY","GROUP","OBJECT","SCALAR","SCRIPT","SIDE","STRING","TEXT". They represent the available [[Data_Types|data types]] in ArmA. If the argument is [[isNil | nil (undefined)]], it returns an empty string.|= Description
|game4= tkoh
____________________________________________________________________________________________
|version4= 1.00


| '''typeName''' any |= Syntax
|game5= arma3
|version5= 0.50


|p1= any: [[Anything]] |= Parameter 1
|gr1= Variables


| [[String]] |= Return value
|descr= Returns the [[:Category:Data Types|Data Type]] of an expression.
____________________________________________________________________________________________
 
|x1= <pre>_msg="hello"; _result = typeName _msg;  // _result will be "STRING"</pre> |= Example 1
|x2= <pre>_unit=player; _result = typeName _unit; // _result becomes "OBJECT"</pre> |= Example 2
____________________________________________________________________________________________


| |= See also
The type is returned as on of the following all-uppercase strings:
{{Columns|5|
* "[[Array|ARRAY]]"
* "[[Boolean|BOOL]]"
* "[[Code|CODE]]"
* "[[Config|CONFIG]]"
* "[[Control|CONTROL]]"
* "[[Display|DISPLAY]]"
* "[[Group|GROUP]]"
* "[[Object|OBJECT]]"
* "[[Number|SCALAR]]" (and "[[Number|NaN]]")
* "[[Script Handle|SCRIPT]]"
* "[[Side|SIDE]]"
* "[[String|STRING]]"
* "[[Structured Text|TEXT]]"
* {{GVI|arma1|1.08|size= 0.75}} "[[Location|LOCATION]]"
* {{GVI|arma2|1.00|size= 0.75}} "[[Team Member|TEAM_MEMBER]]"
* {{GVI|arma2|1.00|size= 0.75}} "[[Namespace|NAMESPACE]]"
* {{GVI|arma2|1.00|size= 0.75}} "[[Diary Record|DIARY_RECORD]]"
* {{GVI|arma2|1.00|size= 0.75}} "[[Task|TASK]]"
* {{GVI|arma3|2.02|size= 0.75}} "[[HashMap|HASHMAP]]"
}}
They represent the available [[:Category:Data Types|Data Types]] in {{arma}}.
{{Feature|arma3|For type comparison, use [[isEqualType]] command instead.}}


}}
|s1= [[typeName]] anything
 
|p1= anything: [[Anything]]
 
|r1= [[String]]
 
|x1= <sqf>_msg = "hello"; _result = typeName _msg;  //_result will be "STRING"</sqf>
 
|x2= <sqf>_unit = player; _result = typeName _unit; //_result becomes "OBJECT"</sqf>
 
|x3= Values representing direct [[:Category:Data Types|Data Types]]:
<sqf>
hint typeName 0; // SCALAR
hint typeName 1e39; // NaN
hint typeName ""; // STRING
hint typeName true; // BOOL
hint typeName []; // ARRAY
hint typeName {}; // CODE
hint typeName scriptNull; // SCRIPT (since {{arma3}} v1.32)
hint typeName objNull; // OBJECT
hint typeName grpNull; // GROUP
hint typeName controlNull; // CONTROL
hint typeName teamMemberNull; // TEAM_MEMBER (since {{arma2}} v1.00)
hint typeName displayNull; // DISPLAY
hint typeName taskNull; // TASK (since {{arma2}} v1.00)
hint typeName locationNull; // LOCATION
hint typeName sideUnknown; // SIDE
hint typeName text ""; // TEXT
hint typeName configFile; // CONFIG
hint typeName configNull; // CONFIG (since {{arma3}} v1.54)
hint typeName missionNamespace; // NAMESPACE
hint typeName diaryRecordNull; // DIARY_RECORD (since {{arma3}} v2.00)
hint typeName createHashMap; // HASHMAP (since {{arma3}} v2.02)
</sqf>


<h3 style="display:none">Notes</h3>
|x4= <sqf>
<dl class="command_description">
if (typeName _this != "ARRAY") exitWith { hint "_this is not an array!" };
<!-- Note Section BEGIN -->
// is the same as
if (typeName _this != typeName []) exitWith { hint "_this is not an array!" };
// same result but faster in {{arma3}}
if !(_this isEqualType []) exitWith { hint "_this is not an array!" };
</sqf>


<!-- Note Section END -->
|seealso= [[isEqualTypeAll]] [[isEqualType]] [[isEqualTypeParams]] [[isEqualTypeArray]] [[isEqualTypeAny]] [[typeOf]] [[isKindOf]] [[isClass]] [[isArray]] [[isNumber]] [[isText]] [[isNil]] [[isNull]]
</dl>
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands|TYPENAME]]
|user= Killzone_Kid
[[Category:Scripting Commands ArmA|TYPENAME]]
|timestamp= 20160925111400
|text= [[typeName]] of [[nil]] is {{hl|ANY}}, however this is not possible to test as script command is just ignored when any argument is [[nil]].
}}

Latest revision as of 17:16, 28 September 2024

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Returns the Data Type of an expression. The type is returned as on of the following all-uppercase strings:

They represent the available Data Types in Arma.

Arma 3
For type comparison, use isEqualType command instead.
Groups:
Variables

Syntax

Syntax:
typeName anything
Parameters:
anything: Anything
Return Value:
String

Examples

Example 1:
_msg = "hello"; _result = typeName _msg; //_result will be "STRING"
Example 2:
_unit = player; _result = typeName _unit; //_result becomes "OBJECT"
Example 3:
Values representing direct Data Types:
hint typeName 0; // SCALAR hint typeName 1e39; // NaN hint typeName ""; // STRING hint typeName true; // BOOL hint typeName []; // ARRAY hint typeName {}; // CODE hint typeName scriptNull; // SCRIPT (since Arma 3 v1.32) hint typeName objNull; // OBJECT hint typeName grpNull; // GROUP hint typeName controlNull; // CONTROL hint typeName teamMemberNull; // TEAM_MEMBER (since Arma 2 v1.00) hint typeName displayNull; // DISPLAY hint typeName taskNull; // TASK (since Arma 2 v1.00) hint typeName locationNull; // LOCATION hint typeName sideUnknown; // SIDE hint typeName text ""; // TEXT hint typeName configFile; // CONFIG hint typeName configNull; // CONFIG (since Arma 3 v1.54) hint typeName missionNamespace; // NAMESPACE hint typeName diaryRecordNull; // DIARY_RECORD (since Arma 3 v2.00) hint typeName createHashMap; // HASHMAP (since Arma 3 v2.02)
Example 4:
if (typeName _this != "ARRAY") exitWith { hint "_this is not an array!" }; // is the same as if (typeName _this != typeName []) exitWith { hint "_this is not an array!" }; // same result but faster in Arma 3 if !(_this isEqualType []) exitWith { hint "_this is not an array!" };

Additional Information

See also:
isEqualTypeAll isEqualType isEqualTypeParams isEqualTypeArray isEqualTypeAny typeOf isKindOf isClass isArray isNumber isText isNil isNull

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
Killzone_Kid - c
Posted on Sep 25, 2016 - 11:14 (UTC)
typeName of nil is ANY, however this is not possible to test as script command is just ignored when any argument is nil.
Retrieved from "https://community.bistudio.com/wiki?title=typeName&oldid=369624"