BIS fnc openFieldManual: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Added 2 optional parameters in 1.76)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(29 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function|=
{{RV|type=function
____________________________________________________________________________________________


| a3 |= Game
|game1= arma3
|version1= 1.36


|1.36|= Game Version (number surrounded by NO SPACES)
|gr1= Systems


____________________________________________________________________________________________
|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.


|  
|s1= [topic, hint, display, filter] call [[BIS_fnc_openFieldManual]]
*Opens Field Manual in briefing (SP, MP Server, MP Client) and players's map or journal<br>
*Selects the topic and hint passed as parameters |= Description
____________________________________________________________________________________________


| ["topic", "hint", _display, "filter"] [[call]] [[BIS_fnc_openFieldManual]]|= Syntax
|p1= topic: [[String]] - class name of a topic that will be selected in the opened Field Manual (e.g. "Damage")


|p1= [[String]] "topic" - Class name of a topic that will be selected in the opened Field Manual (e.g. "Damage") |= Parameter 1
|p2= hint: [[String]] - class name of a hint that will be selected in the opened Field Manual (e.g. "HitDamage")
|p2= [[String]] "hint" - Class name of a hint that will be selected in the opened Field Manual (e.g. "HitDamage") |= Parameter 2
|p3= [[Display]] _display (Optional) - Desired parent [[Display]] to open the Field Manual display under |= Parameter 3
|p4= [[String]] "filter" (Optional) - Pre-filled search field filter in the opened Field Manual (recommended to use localized string) |= Parameter 4


| Nothing |= Return Value
|p3= display: [[Display]] - (Optional) desired parent [[Display]] to open the Field Manual display under


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


|mp= |= Multiplayer Behaviour
|r1= [[Nothing]]
____________________________________________________________________________________________


|x1= <code>["Damage", "HitDamage"] [[call]] [[BIS_fnc_openFieldManual]];</code> |= Example 1
|x1= <sqf>["Damage", "HitDamage"] call BIS_fnc_openFieldManual;</sqf>
 
|  |= See Also


|seealso=
}}
}}
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- For example:
<dd class="notedate">Posted on Month Day, Year - Time (UTC)</dd>
<dt class="note">'''[[User:User Name|User Name]]'''</dt>
<dd class="note">This is an example note. It is true and verifiable, and contains a little code snippet.
<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] "Leave it here for others to read"; };</code></dd>
-->
<!-- END Note Section -->
</dl>
<h3 style="display:none">Bottom Section</h3>
<!-- Appropriate categories go here -->
[[Category:Arma 3: Functions|{{uc:{{PAGENAME}}}}]]
[[Category:Functions|{{uc:openFieldManual}}]]

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