getDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^ ]*)\{\{cc\|([^ ]*)\}\}([^ ]*)<\/code>" to "<code>$1// $2$3</code>")
m (Text replacement - "\{\{cc\|([^} ]*)\}\}" to "// $1")
Line 14: Line 14:
|r1= [[Array]] of [[String]]s to format {{hl|[unit'''Class''', uniform'''Name''', vest'''Name''', backpack'''Class''']}}
|r1= [[Array]] of [[String]]s to format {{hl|[unit'''Class''', uniform'''Name''', vest'''Name''', backpack'''Class''']}}


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


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

Revision as of 11:26, 12 May 2022

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 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:
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
Return value fixed in revision 0.51.103185.