BIS fnc advHintFormat: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (fixed arguments)
 
(33 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|gr1= GUI


|1.00|= Game version
|descr= Return formatted texts of a CfgHints hint.
____________________________________________________________________________________________


| <pre>/*
|s1= [topic,hint,subHint,colour] call [[BIS_fnc_advHintFormat]]
Author: Karel Moricky


Description:
|p1= topic: [[String]] - topic
Return formatted texts of a CfgHints hint


Parameter(s):
|p2= hint: [[String]] - hint
0: STRING - Topic
1: STRING - Hint
2 (Optional): STRING - Sub-hint
3 (Optional): ARRAY - Custom highlight color
Returned value:
ARRAY in format:
0: CONFIG - hint path
1: STRING - display name
2: STRING - short displayName
3: STRING - description
4: STRING - tip
5: STRING - image
6: NUMBER - DLC ID
7: BOOL - true if hint belongs to non-owned DLC
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p3= subHint: [[String]] - sub-hint
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_advHintFormat]]; --> |= Syntax
|p4= colour: [[Array]] - custom highlight color
|p1= |= Parameter 1


| |= Return value
|r1= [[Array]] - array in format:
____________________________________________________________________________________________
*0: [[Config]] - Hint path
*1: [[String]] - Display name
*2: [[String]] - Display name (short)
*3: [[String]] - Description
*4: [[String]] - Tip
*5: [[String]] - Image
*6: [[Number]] - DLC ID
*7: [[Boolean]] - [[true]] if hint belongs to non-owned DLC


|x1= <code></code> |=
|x1= <sqf>["Arma3","Feedback","",[0.5,0.3,0.6,1]] call BIS_fnc_advHintFormat;</sqf>
____________________________________________________________________________________________
 
| |= See also


|seealso= [[BIS_fnc_advHint]] [[BIS_fnc_advHintArg]] [[BIS_fnc_advHintCall]]
}}
}}
<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: Hints|{{uc:advHintFormat}}]]
[[Category:Functions|{{uc:advHintFormat}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:advHintFormat}}]]

Latest revision as of 16:08, 2 April 2024

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Return formatted texts of a CfgHints hint.
Execution:
call
Groups:
GUI

Syntax

Syntax:
[topic,hint,subHint,colour] call BIS_fnc_advHintFormat
Parameters:
topic: String - topic
hint: String - hint
subHint: String - sub-hint
colour: Array - custom highlight color
Return Value:
Array - array in format:

Examples

Example 1:
["Arma3","Feedback","",[0.5,0.3,0.6,1]] call BIS_fnc_advHintFormat;

Additional Information

See also:
BIS_fnc_advHint BIS_fnc_advHintArg BIS_fnc_advHintCall

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_advHintFormat&oldid=363518"