BIS fnc displayName: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
(Added configOf example)
 
(42 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= tkoh
____________________________________________________________________________________________
|version1= 1.00


| tkoh |= Game name
|game2= arma3
|version2= 0.50


|1.00|= Game version
|gr1= Configs
____________________________________________________________________________________________


| <pre>/*
|descr= Return given class displayName value. Return base class name if displayName not defined.


Description:
|s1= [config] call [[BIS_fnc_displayName]]
Return displayName of given class. Return class if displayName not defined.


Parameter(s):
|p1= config: [[Config]] - config path
_this: CONFIG


Returns:
|r1= [[String]] - displayName, else [[configName]]
STRING
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|x1= <sqf>private _myDisplayName = [configFile >> "CfgVehicles" >> typeOf vehicle player] call BIS_fnc_displayName;</sqf>
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_displayName]]; --> |= Syntax
|x2= <sqf>private _myDisplayName = [configOf player] call BIS_fnc_displayName; // Since Arma 3 2.00</sqf>
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[configName]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:displayName}}]]
[[Category:Functions|{{uc:displayName}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:displayName}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:displayName}}]]

Latest revision as of 19:47, 12 March 2024

Hover & click on the images for description

Description

Description:
Return given class displayName value. Return base class name if displayName not defined.
Execution:
call
Groups:
Configs

Syntax

Syntax:
[config] call BIS_fnc_displayName
Parameters:
config: Config - config path
Return Value:
String - displayName, else configName

Examples

Example 1:
private _myDisplayName = [configFile >> "CfgVehicles" >> typeOf vehicle player] call BIS_fnc_displayName;
Example 2:
private _myDisplayName = [configOf player] call BIS_fnc_displayName; // Since Arma 3 2.00

Additional Information

See also:
configName

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