BIS fnc advHint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1 = GUI |GROUP1=
|gr1 = GUI


| Shows advanced hint to player.|DESCRIPTION=
| Shows advanced hint to player.


| [classes, duration1, condition1, duration2, condition2, showing, onlyFullHint, onlyOnce, useSound] call '''BIS_fnc_advHint'''; |SYNTAX=
| [classes, duration1, condition1, duration2, condition2, showing, onlyFullHint, onlyOnce, useSound] call '''BIS_fnc_advHint''';


|p1= '''classes''': [[Array]] - Array in format ["hint main class","hint class"] |Parameter1=
|p1= '''classes''': [[Array]] - Array in format ["hint main class","hint class"]
|p2= '''duration1''': [[Number]] (Optional) - Duration of short hint in seconds. ''(Default 15s)'' |Parameter2=
|p2= '''duration1''': [[Number]] (Optional) - Duration of short hint in seconds. ''(Default 15s)''


|p3= '''condition1''': [[String]] (Optional) - Condition for hiding of short hint ''(Default "")'' |PARAMETER3=
|p3= '''condition1''': [[String]] (Optional) - Condition for hiding of short hint ''(Default "")''


|p4= '''duration2''': [[Number]] (Optional) - Duration of full hint in seconds ''(Default 35s)'' |PARAMETER4=
|p4= '''duration2''': [[Number]] (Optional) - Duration of full hint in seconds ''(Default 35s)''


|p5= '''condition2''': [[String]] (Optional) - Condition for hiding of full hint ''(Default "")'' |PARAMETER5=
|p5= '''condition2''': [[String]] (Optional) - Condition for hiding of full hint ''(Default "")''


|p6= '''showing''': [[Boolean]] (Optional) - True shows hint even if tutorial hints are disabled in game settings ''(Default false)'' |PARAMETER6=
|p6= '''showing''': [[Boolean]] (Optional) - True shows hint even if tutorial hints are disabled in game settings ''(Default false)''


|p7= '''onlyFullHint''': [[Boolean]] (Optional) - True shows full hint without using of short hint ''(Default false)'' |PARAMETER7=
|p7= '''onlyFullHint''': [[Boolean]] (Optional) - True shows full hint without using of short hint ''(Default false)''


|p8= '''onlyOnce''': [[Boolean]] (Optional) - Show the hint in mission only once (true) or multiple times (false) ''(Default false)'' |PARAMETER8=
|p8= '''onlyOnce''': [[Boolean]] (Optional) - Show the hint in mission only once (true) or multiple times (false) ''(Default false)''


|p9= '''useSound''': [[Boolean]] (Optional) - True plays a sound when the hint is opened ''(Default true)'' |PARAMETER9=
|p9= '''useSound''': [[Boolean]] (Optional) - True plays a sound when the hint is opened ''(Default true)''


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]
   
   
|x1= <code><nowiki>[["Common", "GPS"]]</nowiki> [[call]] [[BIS_fnc_advHint]];</code> |Example1=
|x1= <code><nowiki>[["Common", "GPS"]]</nowiki> [[call]] [[BIS_fnc_advHint]];</code>


|x2= <code><nowiki>[["Common", "GPS"], 15,"",35,"",false,false,false,true]</nowiki> [[call]] [[BIS_fnc_advHint]];//Default</code> |EXAMPLE2=
|x2= <code><nowiki>[["Common", "GPS"], 15,"",35,"",false,false,false,true]</nowiki> [[call]] [[BIS_fnc_advHint]];//Default</code>


| [[Arma_3_Advanced_Hints_(Field_Manual)|Advanced Hints]], [[BIS_fnc_advHintFormat]], [[BIS_fnc_advHintCall]], [[BIS_fnc_advHintArg]] |SEEALSO=
| [[Arma_3_Advanced_Hints_(Field_Manual)|Advanced Hints]], [[BIS_fnc_advHintFormat]], [[BIS_fnc_advHintCall]], [[BIS_fnc_advHintArg]]


}}
}}

Revision as of 22:38, 17 January 2021

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) - Duration of short hint in seconds. (Default 15s)
condition1: String (Optional) - Condition for hiding of short hint (Default "")
duration2: Number (Optional) - Duration of full hint in seconds (Default 35s)
condition2: String (Optional) - Condition for hiding of full hint (Default "")
showing: Boolean (Optional) - True shows hint even if tutorial hints are disabled in game settings (Default false)
onlyFullHint: Boolean (Optional) - True shows full hint without using of short hint (Default false)
onlyOnce: Boolean (Optional) - Show the hint in mission only once (true) or multiple times (false) (Default false)
useSound: Boolean (Optional) - True plays a sound when the hint is opened (Default true)
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 HintsBIS_fnc_advHintFormatBIS_fnc_advHintCallBIS_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


Bottom Section

Posted on August 13, 2016 - 12:09 (UTC)
Sixtyfour
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=202653"