getDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Comments" to "|Comments=")
m (Some wiki formatting)
 
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 0.50


|0.50|= Game version
|gr1= Object Manipulation
____________________________________________________________________________________________


| Returns the string representation of unit as an four slots array. |DESCRIPTION=
|descr= Returns the string representation of unit as an four slots array.
____________________________________________________________________________________________


| '''getDescription''' unit |SYNTAX=
|s1= [[getDescription]] unit


|p1= unit: [[Object]] |PARAMETER1=
|p1= unit: [[Object]]


| [[Array]] - [unit, uniform, vest, backpack] |RETURNVALUE=
|r1= [[Array]] of [[String]]s format {{hl|[unit'''Class''', uniform'''Name''', vest'''Name''', backpack'''Class''']}}


|x1= <sqf>
getDescription player; // UAV Operator
// returns ["B_soldier_UAV_F", "Combat Fatigues (MTP)", "Carrier Special Rig (Green)", "B_UAV_01_backpack_F"]
</sqf>


|x1= <code>
|x2= <sqf>getDescription objNull; // returns ["ERROR", "ERROR", "ERROR", "ERROR"]</sqf>
</code>|EXAMPLE1=


____________________________________________________________________________________________
|seealso= [[roleDescription]] [[vehicleVarName]]
 
}}
| [[roleDescription]], [[vehicleVarName]] |SEEALSO=


| |MPBEHAVIOUR=  
{{Note
____________________________________________________________________________________________
|user= Druid
|timestamp= 20130319155400
|text= Return value fixed in revision 0.51.103185.
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<dt class="note">'''[[User:Druid|Druid]]'''
<dd class="note">
Return value fixed in revision 0.51.103185.
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Arma 3: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on September 21, 2014 - 18:47 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
Pretty useless command tbh, return is something like this:
<tt>["B_Soldier_F","Combat Fatigues (MTP)","Carrier Lite (Green)",""]</tt> or <tt>["ERROR","ERROR","ERROR","ERROR"]</tt>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 19:13, 12 May 2023

Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Returns the string representation of unit as an four slots array.
Groups:
Object Manipulation

Syntax

Syntax:
getDescription unit
Parameters:
unit: Object
Return Value:
Array of Strings format [unitClass, uniformName, vestName, backpackClass]

Examples

Example 1:
getDescription player; // UAV Operator // returns ["B_soldier_UAV_F", "Combat Fatigues (MTP)", "Carrier Special Rig (Green)", "B_UAV_01_backpack_F"]
Example 2:
getDescription objNull; // returns ["ERROR", "ERROR", "ERROR", "ERROR"]

Additional Information

See also:
roleDescription vehicleVarName

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
Druid - c
Posted on Mar 19, 2013 - 15:54 (UTC)
Return value fixed in revision 0.51.103185.
Retrieved from "https://community.bistudio.com/wiki?title=getDescription&oldid=340864"