BIS fnc advHint: Difference between revisions

Revision as of 16:08, 8 January 2014

1.00

Hover & click on the images for description

Description

Description:: Shows advanced hint to player.
Execution:: call
Groups:: Uncategorised

Syntax

Syntax:: [classes, duration1, condition1, duration2, condition2, showing, onlyFullHint, onlyOnce] call BIS_fnc_advHint;
Parameters:: classes: Array - Array in format ["hint main class","hint class"]
: duration1: Number (Optional) - Duration of short hint in seconds
: condition1: String (Optional) - Condition for hiding of short hint
: duration2: Number (Optional) - Duration of full hint in seconds
: condition2: String (Optional) - Condition for hiding of full hint
: showing: Boolean (Optional) - True shows hint even if tutorial hints are disabled in game settings (!!!not implemented yet!!!)
: onlyFullHint: Boolean (Optional) - True shows full hint without using of short hint
: onlyOnce: Boolean (Optional) - Show the hint in mission only once (true) or multiple times (false)
Return Value:: Nothing

Examples

Example 1:: [["Common", "GPS"]] call BIS_fnc_advHint;

Additional Information

See also:: Advanced Hints (Field Manual)

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
 ____________________________________________________________________________________________
@@ Line 8: / Line 7: @@
 ____________________________________________________________________________________________
-| <pre>/*
+| Shows advanced hint to player.|= Description
-	File: advHint.sqf
-	Description:
-	Primary function of advanced hint system
-	Parameter(s):
-	_this select 0: Array - Array in format ["hint mainclass","hint class"] or ["hint mainclass","hint class","sub-hint class"]
-	_this select 1: Number (optional) - Duration of short version of hint in seconds
-	_this select 2: String (optional) - Condition for hiding of short version of hint
-	_this select 3: Number (optional) - Duration of full version of hint in seconds
-	_this select 4: String (optional) - Condition for hiding of full version of hint
-	_this select 5: Bool (optional) - True shows hint even if tutorial hints are disabled via game settings
-	_this select 6: Bool (optional) - True shows directly the full hint without using of the short hint
-	_this select 7: Bool (optional) - Show the hint in a mission only once (true) or multiple times (false)
-	_this select 8: Bool (optional) - Sound is not used when false
-	Returned value:
-	None. Create 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)
-	Note: Hint must be defined in CfgHints.
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
 ____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_advHint]]; --> |= Syntax
+| [classes, duration1, condition1, duration2, condition2, showing, onlyFullHint, onlyOnce] call '''BIS_fnc_advHint'''; |= Syntax
-|p1= |= Parameter 1
+|p1= '''classes''': [[Array]] - Array in format ["hint main class","hint class"] |=
+|p2= '''duration1''': [[Number]] (Optional) - Duration of short hint in seconds |=
+|p3= '''condition1''': [[String]] (Optional) - Condition for hiding of short hint |=
+|p4= '''duration2''': [[Number]] (Optional) - Duration of full hint in seconds |=
+|p5= '''condition2''': [[String]] (Optional) - Condition for hiding of full hint |=
+|p6= '''showing''': [[Boolean]] (Optional) - True shows hint even if tutorial hints are disabled in game settings (!!!not implemented yet!!!) |=
+|p7= '''onlyFullHint''': [[Boolean]] (Optional) - True shows full hint without using of short hint |=
+|p8= '''onlyOnce''': [[Boolean]] (Optional) - Show the hint in mission only once (true) or multiple times (false) |=
-| |= Return value
+| [[Nothing]]  |= Return value
 ____________________________________________________________________________________________
-|x1= <code></code> |=
+|x1= <code><nowiki>[[</nowiki>"Common", "GPS"<nowiki>]]</nowiki> [[call]] '''BIS_fnc_advHint''';</code> |=
 ____________________________________________________________________________________________
-| |= See also
+| [[Arma_3_Advanced_Hints_(Field_Manual)|Advanced Hints (Field Manual)]] |= See also
 }}
@@ Line 65: / Line 39: @@
 <h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Hints|{{uc:advHint}}]]
-[[Category:Functions|{{uc:advHint}}]]
+[[Category:Arma 3:_Functions|addCommMenuItem]]
-[[Category:{{Name|arma3}}: Functions|{{uc:advHint}}]]