getDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style='display:none'>Notes</h3>" to "")
m (Some wiki formatting)
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command


|game1= arma3
|game1= arma3
|version1= 0.50
|version1= 0.50


Line 13: Line 12:
|p1= unit: [[Object]]
|p1= unit: [[Object]]


|r1= [[Array]] of [[String]]s to format <tt>[unit'''Class''', uniform'''Name''', vest'''Name''', backpack'''Class''']</tt>
|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>[[getDescription]] [[player]]; {{cc|(UAV Operator)}}
|x2= <sqf>getDescription objNull; // returns ["ERROR", "ERROR", "ERROR", "ERROR"]</sqf>
{{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>
|seealso= [[roleDescription]] [[vehicleVarName]]
}}


|seealso= [[roleDescription]], [[vehicleVarName]]
{{Note
|user= Druid
|timestamp= 20130319155400
|text= Return value fixed in revision 0.51.103185.
}}
}}
<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>

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"