BIS fnc advHintCall: Difference between revisions

Revision as of 20:56, 31 March 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:: fullTextcall 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: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.20
-| arma3 |= Game name
+|gr1= GUI
-|1.00|= Game version
+|descr= Advanced hint call, creates hint itself.<br>
-____________________________________________________________________________________________
+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<br>
+* fullText: [[String]] - structured text of full hint<br>
+* shortText: [[String]] - structured text of short hint<br>
+* shortDur: [[Number]] - duration of short hint in seconds<br>
+* hideCond: [[String]] - condition for hiding of short hint (default: "false")<br>
+* fullDur: [[Number]] - duration of full hint in seconds<br>
+* fullHideCond: [[String]] - condition for hiding of full hint (default: "false")<br>
+* showFull: [[Boolean]] - true shows directly full hint (default: [[false]])<br>
+* sound: [[Boolean]] - true for using of sound (default: [[true]])
-| <pre>/*
+|s1= fullTextcall call [[BIS_fnc_advHintCall]]
-	File: advHintCall.sqf
-	Description:
+|p1= fullText: [[Boolean]] - [[true]] to show full text, [[false]] to only show small hint notification
-	Advanced hint call, creates hint itself
-	Parameter(s):
+|r1= [[Nothing]]
-	_this select 0: Bool - True for full text, false for small hint notification
-	This function gets parameters from variable BIS_fnc_advHint_hint:
-	BIS_fnc_advHint_hint select 0: String - Class of hint
-	BIS_fnc_advHint_hint select 1: String - Structured text of full hint
-	BIS_fnc_advHint_hint select 2: String - Structured text of short hint
-	BIS_fnc_advHint_hint select 3: Number - Duration of short hint in seconds
-	BIS_fnc_advHint_hint select 4: String - Condition for hiding of short hint (default: "false")
-	BIS_fnc_advHint_hint select 5: Number - Duration of full hint in seconds
-	BIS_fnc_advHint_hint select 6: String - Condition for hiding of full hint (default: "false")
-	BIS_fnc_advHint_hint select 7: Bool - True shows directly full hint (default: false)
-	BIS_fnc_advHint_hint select 8: Bool - True for using of sound (default: true)
-	Returned value:
+|x1= <sqf>false call BIS_fnc_advHintCall;</sqf>
-	None
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_advHintCall]]; --> |= Syntax
-|p1= |= Parameter 1
-| |= Return value
-____________________________________________________________________________________________
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| |= See also
+|seealso= [[BIS_fnc_advHint]] [[BIS_fnc_advHintFormat]] [[BIS_fnc_advHintArg]]
 }}
-<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}}]]