BIS fnc advHint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(52 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= GUI


|1.00|= Game version
|descr= Shows advanced hint to player.
____________________________________________________________________________________________


| <pre>/*
|s1= [classes, duration1, condition1, duration2, condition2, showing, onlyFullHint, onlyOnce, useSound] call [[BIS_fnc_advHint]]
File: advHint.sqf


Description:
|p1= '''classes''': [[Array]] - array in format ["hint main class", "hint class"]
Primary function of advanced hint system


Parameter(s):
|p2= '''duration1''': [[Number]] - (Optional, default 15) duration of short hint in seconds
_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
|p3= '''condition1''': [[String]] - (Optional, default "") condition for hiding the short hint
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_advHint]]; --> |= Syntax
|p4= '''duration2''': [[Number]] - (Optional, default 35) duration of full hint in seconds


|p1= |= Parameter 1
|p5= '''condition2''': [[String]] - (Optional, default "") condition for hiding the full hint


| |= Return value
|p6= '''showing''': [[Boolean]] - (Optional, default [[false]]) true shows hint even if tutorial hints are disabled in game settings
____________________________________________________________________________________________


|x1= <code></code> |=
|p7= '''onlyFullHint''': [[Boolean]] - (Optional, default [[false]]) true shows full hint without using of short hint
____________________________________________________________________________________________


| |= See also
|p8= '''onlyOnce''': [[Boolean]] - (Optional, default [[false]]) show the hint in mission only once (true) or multiple times (false)


}}
|p9= '''useSound''': [[Boolean]] - (Optional, default [[true]]) true plays a sound when the hint is opened
 
|r1= [[Nothing]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>[["Common", "GPS"]] call BIS_fnc_advHint;</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x2= <sqf>[["Common", "GPS"], 15, "", 35, "", false, false, false, true] call BIS_fnc_advHint; // default</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[Arma 3: Advanced Hints (Field Manual)|Advanced Hints]] [[BIS_fnc_advHintFormat]] [[BIS_fnc_advHintCall]] [[BIS_fnc_advHintArg]]
[[Category:Function Group: Hints|{{uc:advHint}}]]
}}
[[Category:Functions|{{uc:advHint}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:advHint}}]]
{{Note
|user= Sixtyfour
|timestamp= 20160813120900
|text= This command will not do anything for players who have "Tutorial Hints" disabled in their Options > Game difficulty settings or on servers that disable it in their relevant difficulty preset.
}}

Latest revision as of 16:30, 13 July 2022

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

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

Syntax

Syntax:
[classes, duration1, condition1, duration2, condition2, showing, onlyFullHint, onlyOnce, useSound] call BIS_fnc_advHint
Parameters:
classes: Array - array in format ["hint main class", "hint class"]
duration1: Number - (Optional, default 15) duration of short hint in seconds
condition1: String - (Optional, default "") condition for hiding the short hint
duration2: Number - (Optional, default 35) duration of full hint in seconds
condition2: String - (Optional, default "") condition for hiding the full hint
showing: Boolean - (Optional, default false) true shows hint even if tutorial hints are disabled in game settings
onlyFullHint: Boolean - (Optional, default false) true shows full hint without using of short hint
onlyOnce: Boolean - (Optional, default false) show the hint in mission only once (true) or multiple times (false)
useSound: Boolean - (Optional, default true) true plays a sound when the hint is opened
Return Value:
Nothing

Examples

Example 1:
[["Common", "GPS"]] call BIS_fnc_advHint;
Example 2:
[["Common", "GPS"], 15, "", 35, "", false, false, false, true] call BIS_fnc_advHint; // default

Additional Information

See also:
Advanced Hints BIS_fnc_advHintFormat BIS_fnc_advHintCall 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
Sixtyfour - c
Posted on Aug 13, 2016 - 12:09 (UTC)
This command will not do anything for players who have "Tutorial Hints" disabled in their Options > Game difficulty settings or on servers that disable it in their relevant difficulty preset.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_advHint&oldid=327971"