BIS fnc advHintFormat: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1 = GUI |GROUP1=
|gr1 = GUI


| Return formatted texts of a CfgHints hint. |Description=
| Return formatted texts of a CfgHints hint.


| [topic,hint,subHint,colour] call [[BIS_fnc_advHintFormat]] |Syntax=
| [topic,hint,subHint,colour] call [[BIS_fnc_advHintFormat]]


|p1= topic: [[String]] - Topic |Parameter 1=
|p1= topic: [[String]] - Topic


|p2= topic: [[String]] - Hint |Parameter 2=
|p2= topic: [[String]] - Hint


|p3= subHint: [[String]] - Sub-hint |Parameter 3=
|p3= subHint: [[String]] - Sub-hint


|p4= colour: [[Array]] - Custom highlight color |Parameter 4=
|p4= colour: [[Array]] - Custom highlight color


| [[Array]] - Array in format:
| [[Array]] - Array in format:
Line 27: Line 27:
*5: [[String]] - Image
*5: [[String]] - Image
*6: [[Number]] - DLC ID
*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= <code>["Arma3","Feedback","",[0.5,0.3,0.6,1]] [[call]] [[BIS_fnc_advHintFormat]];</code>




| [[BIS_fnc_advHint]], [[BIS_fnc_advHintArg]], [[BIS_fnc_advHintCall]] |See also=
| [[BIS_fnc_advHint]], [[BIS_fnc_advHintArg]], [[BIS_fnc_advHintCall]]
}}
}}



Revision as of 22:39, 17 January 2021

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
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_advHintBIS_fnc_advHintArgBIS_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


Bottom Section