BIS fnc advHintFormat: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision imported: BIS Functions update 2/7)
m (pf)
Line 1: Line 1:
{{Function|Comments=
____________________________________________________________________________________________


{{Function|= Comments
| arma3 |Game name=
 
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| Return formatted texts of a CfgHints hint. |Description=
 
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


Parameter(s):
|p2= topic: [[String]] - Hint |Parameter 2=
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 |Parameter 3=
____________________________________________________________________________________________


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


| |= Return value
| [[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 |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| |= See also
| [[BIS_fnc_advHint]], [[hint]], [[hintC]], [[hintSilent]] |See also=
 
}}
}}


Revision as of 10:00, 20 June 2018

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:
Uncategorised

Syntax

Syntax:
[topic,hint,subHint,colour] call BIS_fnc_advHintFormat
Parameters:
topic: String - Topic
topic: 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_advHinthinthintChintSilent

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

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_advHintFormat&oldid=108551"