BIS fnc openFieldManual: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(34 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|gr1= Systems


|1.00|= Game version
|descr= Opens Field Manual in briefing (SP, MP Server, MP Client) and players's map or journal.
____________________________________________________________________________________________
Selects the topic and hint passed as parameters.
Can apply a (search) filter if desired.


| <pre>/*
|s1= [topic, hint, display, filter] call [[BIS_fnc_openFieldManual]]
Author: Muf (modified by Karel Moricky)


Description:
|p1= topic: [[String]] - class name of a topic that will be selected in the opened Field Manual (e.g. "Damage")
* Opens Field Manual in briefing (SP, MP Server, MP Client) and player's map.
* Selects the topic and hint passed as parameters.


Parameter(s):
|p2= hint: [[String]] - class name of a hint that will be selected in the opened Field Manual (e.g. "HitDamage")
0: ARRAY OF STRINGS - Class names of topic and hint that will be selected in the opened Field Manual (e. g. ["Damage", "HitDamage"]).


Returns:
|p3= display: [[Display]] - (Optional) desired parent [[Display]] to open the Field Manual display under
NOTHING
*/


|p4= filter: [[String]] - (Optional) pre-filled search field filter in the opened Field Manual (recommended to use localized string)


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|r1= [[Nothing]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_openFieldManual]]; --> |= Syntax
|x1= <sqf>["Damage", "HitDamage"] call BIS_fnc_openFieldManual;</sqf>
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso=
}}
}}
<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: GUI|{{uc:openFieldManual}}]]
[[Category:Functions|{{uc:openFieldManual}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:openFieldManual}}]]

Latest revision as of 15:00, 8 November 2023

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

Description

Description:
Opens Field Manual in briefing (SP, MP Server, MP Client) and players's map or journal. Selects the topic and hint passed as parameters. Can apply a (search) filter if desired.
Execution:
call
Groups:
Systems

Syntax

Syntax:
[topic, hint, display, filter] call BIS_fnc_openFieldManual
Parameters:
topic: String - class name of a topic that will be selected in the opened Field Manual (e.g. "Damage")
hint: String - class name of a hint that will be selected in the opened Field Manual (e.g. "HitDamage")
display: Display - (Optional) desired parent Display to open the Field Manual display under
filter: String - (Optional) pre-filled search field filter in the opened Field Manual (recommended to use localized string)
Return Value:
Nothing

Examples

Example 1:
["Damage", "HitDamage"] call BIS_fnc_openFieldManual;

Additional Information

See also:
See also needed

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_openFieldManual&oldid=348478"