BIS fnc advHintCall: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[[cC]ategory:\{\{Name\|arma3\}\}: [fF]unctions\|\{\{uc:[a-z A-Z_]*\}\}\]\]" to "")
m (Fix)
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
|version1= 1.20


|1.20
|gr1= GUI


|gr1 = GUI
|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]])


| Advanced hint call, creates hint itself.<br>
|s1= fullText call [[BIS_fnc_advHintCall]]
This function gets parameters from variable '''BIS_fnc_advHint_hint''':<br>
BIS_fnc_advHint_hint select 0: [[String]] - Class of hint<br>
BIS_fnc_advHint_hint select 1: [[String]] - Structured text of full hint<br>
BIS_fnc_advHint_hint select 2: [[String]] - Structured text of short hint<br>
BIS_fnc_advHint_hint select 3: [[Number]] - Duration of short hint in seconds<br>
BIS_fnc_advHint_hint select 4: [[String]] - Condition for hiding of short hint (default: "false")<br>
BIS_fnc_advHint_hint select 5: [[Number]] - Duration of full hint in seconds<br>
BIS_fnc_advHint_hint select 6: [[String]] - Condition for hiding of full hint (default: "false")<br>
BIS_fnc_advHint_hint select 7: [[Boolean]] - True shows directly full hint (default: [[false]])<br>
BIS_fnc_advHint_hint select 8: [[Boolean]] - True for using of sound (default: [[true]])


| fullTextcall call [[BIS_fnc_advHintCall]]
|p1= fullText: [[Boolean]] - [[true]] to show full text, [[false]] to only show small hint notification


|p1=fullText: [[Boolean]] - [[true]] to show full text, [[false]] to only show small hint notification
|r1= [[Nothing]]


| [[Nothing]]
|x1= <sqf>false call BIS_fnc_advHintCall;</sqf>


|x1= <code>false [[call]] [[BIS_fnc_advHintCall]];</code>
|seealso= [[BIS_fnc_advHint]] [[BIS_fnc_advHintFormat]] [[BIS_fnc_advHintArg]]
 
| [[BIS_fnc_advHint]], [[BIS_fnc_advHintFormat]], [[BIS_fnc_advHintArg]]
}}
}}

Latest revision as of 00: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