getDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game version" to "|Game version=")
(Add example)
Line 2: Line 2:
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3 |Game name=


|0.50|Game version=
|version1= 0.50|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


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


| [[Array]] - [unit, uniform, vest, backpack] |RETURNVALUE=
|r1= [[Array]] of [[String]]s to format <tt>[unit'''Class''', uniform'''Name''', vest'''Name''', backpack'''Class''']</tt>




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


____________________________________________________________________________________________
|x2= <code>[[getDescription]] [[objNull]]; {{cc|returns ["ERROR", "ERROR", "ERROR", "ERROR"]}}</code>


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


Line 32: Line 29:
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->


<dt class="note">'''[[User:Druid|Druid]]'''
<dt class="note">[[User:Druid|Druid]]
<dd class="note">
<dd class="note">
Return value fixed in revision 0.51.103185.
Return value fixed in revision 0.51.103185.
Line 40: Line 37:


<h3 style='display:none'>Bottom Section</h3>
<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 -->

Revision as of 01:26, 5 January 2020

Hover & click on the images for description

Description

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

Syntax

Syntax:
getDescription unit
Parameters:
unit: Object
Return Value:
Array of Strings to 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:
roleDescriptionvehicleVarName

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

Druid
Return value fixed in revision 0.51.103185.

Bottom Section