BIS fnc openFieldManual: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision imported: BIS Functions update 2/7)
m (Added 2 optional parameters in 1.76)
Line 9: Line 9:


|  
|  
*Opens Field Manual in briefing (SP, MP Server, MP Client) and players's map or journal.<br>
*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
*Selects the topic and hint passed as parameters |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| ["string1", "string2",...] [[call]] [[BIS_fnc_openFieldManual]]|= Syntax
| ["topic", "hint", _display, "filter"] [[call]] [[BIS_fnc_openFieldManual]]|= Syntax


|p1= ARRAY OF STRINGS - Class names of topic and hint that will be selected in the opened Field Manual (e. g. ["Damage", "HitDamage"]) |= Parameter 1
|p1= [[String]] "topic" - Class name of a topic that will be selected in the opened Field Manual (e.g. "Damage") |= Parameter 1
|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
| Nothing |= Return Value

Revision as of 15:49, 11 September 2017

-wrong parameter ("a3") defined!-[[:Category:Introduced with a3 version 1.36|1.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
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
["topic", "hint", _display, "filter"] call BIS_fnc_openFieldManual
Parameters:
String "topic" - Class name of a topic that will be selected in the opened Field Manual (e.g. "Damage")
String "hint" - 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
String "filter" (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

[[Category:Introduced with a3 version 1.36]][[ Category: a3: New Functions | BIS FNC OPENFIELDMANUAL]][[ Category: a3: Functions | BIS FNC OPENFIELDMANUAL]]

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_openFieldManual&oldid=104413"