BIS fnc advHintFormat: Difference between revisions

Latest revision as of 16:08, 2 April 2024

1.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:

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

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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.00
-|1.00|Game version=
+|gr1= GUI
-|gr1 = GUI |GROUP1=
+|descr= Return formatted texts of a CfgHints hint.
-| Return formatted texts of a CfgHints hint. |Description=
+|s1= [topic,hint,subHint,colour] call [[BIS_fnc_advHintFormat]]
-| [topic,hint,subHint,colour] call [[BIS_fnc_advHintFormat]] |Syntax=
+|p1= topic: [[String]] - topic
-|p1= topic: [[String]] - Topic |Parameter 1=
+|p2= hint: [[String]] - hint
-|p2= topic: [[String]] - Hint |Parameter 2=
+|p3= subHint: [[String]] - sub-hint
-|p3= subHint: [[String]] - Sub-hint |Parameter 3=
+|p4= colour: [[Array]] - custom highlight color
-|p4= colour: [[Array]] - Custom highlight color |Parameter 4=
+|r1= [[Array]] - array in format:
-| [[Array]] - Array in format:
 *0: [[Config]] - Hint path
 *1: [[String]] - Display name
@@ Line 27: / Line 26: @@
 *5: [[String]] - Image
 *6: [[Number]] - DLC ID
-*7: [[Boolean]] - [[true]] if hint belongs to non-owned DLC |Return value=
+*7: [[Boolean]] - [[true]] if hint belongs to non-owned DLC
-|x1= <code>["Arma3","Feedback","",[0.5,0.3,0.6,1]] [[call]] [[BIS_fnc_advHintFormat]];</code>|Example 1=
+|x1= <sqf>["Arma3","Feedback","",[0.5,0.3,0.6,1]] call BIS_fnc_advHintFormat;</sqf>
+|seealso= [[BIS_fnc_advHint]] [[BIS_fnc_advHintArg]] [[BIS_fnc_advHintCall]]
-| [[BIS_fnc_advHint]], [[BIS_fnc_advHintArg]], [[BIS_fnc_advHintCall]] |See also=
 }}
-<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:Functions|{{uc:advHintFormat}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:advHintFormat}}]]