BIS fnc advHintCall: Difference between revisions

Latest revision as of 01:23, 30 April 2024

Hover & click on the images for description

Description

Description:

Advanced hint call, creates hint itself.
This function gets parameters from variable BIS_fnc_advHint_hint in format [class, fullText, shortText, shortDur, shortHideCond, fullDur, fullHideCond, showFull, sound]:

class: String - class of hint
fullText: String - structured text of full hint
shortText: String - structured text of short hint
shortDur: Number - duration of short hint in seconds
hideCond: String - condition for hiding of short hint (default: "false")
fullDur: Number - duration of full hint in seconds
fullHideCond: String - condition for hiding of full hint (default: "false")
showFull: Boolean - true shows directly full hint (default: false)
sound: Boolean - true for using of sound (default: true)

Execution:

call

Groups:

GUI

Syntax

Syntax:: fullText call BIS_fnc_advHintCall
Parameters:: fullText: Boolean - true to show full text, false to only show small hint notification
Return Value:: Nothing

Examples

Example 1:: false call BIS_fnc_advHintCall;

Additional Information

See also:: BIS_fnc_advHint BIS_fnc_advHintFormat BIS_fnc_advHintArg

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.20
-|1.20|Game version=
+|gr1= GUI
-____________________________________________________________________________________________
-| Advanced hint call, creates hint itself.<br>
+|descr= Advanced hint call, creates hint itself.<br>
-This function gets parameters from variable '''BIS_fnc_advHint_hint''':<br>
+This function gets parameters from variable '''BIS_fnc_advHint_hint''' in format [class, fullText, shortText, shortDur, shortHideCond, fullDur, fullHideCond, showFull, sound]:
-	BIS_fnc_advHint_hint select 0: [[String]] - Class of hint<br>
+* class: [[String]] - class of hint<br>
-	BIS_fnc_advHint_hint select 1: [[String]] - Structured text of full hint<br>
+* fullText: [[String]] - structured text of full hint<br>
-	BIS_fnc_advHint_hint select 2: [[String]] - Structured text of short hint<br>
+* shortText: [[String]] - structured text of short hint<br>
-	BIS_fnc_advHint_hint select 3: [[Number]] - Duration of short hint in seconds<br>
+* shortDur: [[Number]] - duration of short hint in seconds<br>
-	BIS_fnc_advHint_hint select 4: [[String]] - Condition for hiding of short hint (default: "false")<br>
+* hideCond: [[String]] - condition for hiding of short hint (default: "false")<br>
-	BIS_fnc_advHint_hint select 5: [[Number]] - Duration of full hint in seconds<br>
+* fullDur: [[Number]] - duration of full hint in seconds<br>
-	BIS_fnc_advHint_hint select 6: [[String]] - Condition for hiding of full hint (default: "false")<br>
+* fullHideCond: [[String]] - condition for hiding of full hint (default: "false")<br>
-	BIS_fnc_advHint_hint select 7: [[Bool]] - True shows directly full hint (default: [[false]])<br>
+* showFull: [[Boolean]] - true shows directly full hint (default: [[false]])<br>
-	BIS_fnc_advHint_hint select 8: [[Bool]] - True for using of sound (default: [[true]])|Description=
+* sound: [[Boolean]] - true for using of sound (default: [[true]])
-____________________________________________________________________________________________
-| fullTextcall call [[BIS_fnc_advHintCall]] |Syntax=
+|s1= fullText call [[BIS_fnc_advHintCall]]
-|p1=fullText: [[Boolean]] - [[True]] to show full text, [[false]] to only show small hint notification |Parameter 1=
+|p1= fullText: [[Boolean]] - [[true]] to show full text, [[false]] to only show small hint notification
-| [[Nothing]] |Return value=
+|r1= [[Nothing]]
-____________________________________________________________________________________________
-|x1= <code>false [[call]] [[BIS_fnc_advHintCall]];</code>|Example 1=
+|x1= <sqf>false call BIS_fnc_advHintCall;</sqf>
-____________________________________________________________________________________________
+|seealso= [[BIS_fnc_advHint]] [[BIS_fnc_advHintFormat]] [[BIS_fnc_advHintArg]]
-| [[BIS_fnc_advHint]], [[BIS_fnc_advHintFormat]], [[BIS_fnc_advHintArg]]  |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:Function Group: Hints|{{uc:advHintCall}}]]
-[[Category:Functions|{{uc:advHintCall}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:advHintCall}}]]