BIS fnc initLeaflet: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (pf)
(Page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma 3 |= Game name
| arma3 |Game name=


|1.76|= Game version
|1.76|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Initialize interactive leaflet. |= Description
| Initialize interactive leaflet. |Description=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [mode, params] spawn [[BIS_fnc_initLeaflet]] |= Syntax
| [mode, parameters] call [[BIS_fnc_initLeaflet]] |Syntax=
 
|p1= mode: [[String]] - "init" for scripted initialization, other modes are used when leaflets are fired as a weapon |Parameter 1=
 
|p2= parameters: [[Array]] to format:
* [leaflet, texture, text]
** leaflet: [[Object]] - the leaflet object itself
** texture: [[String]] - texture path
** text: [[String]] - localized text, shown when previewing the leaflet in full screen
* [leaflet, cfgLeafletsClass]
** leaflet: [[Object]] - the leaflet object itself
** cfgLeafletsClass: [[String]] - class name as string |Parameter 2=
 
| [[Nothing]] |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


|p1= mode: [[String]] - Use "init" for scripted initialization, other modes are used when leaflets are fired as a weapon. |= Parameter 1
|x1= <code>["init", [myLeaflet, "#(argb,8,8,3)color(1,1,0,1)", "Yellow pages"]] [[call]] [[BIS__fnc_initLeaflet]];</code> |Example 1=
|p2= params: [[Array]] - Params in format:<br>
0: [[Object]] - Leaflet<br>
1: [[String]] - Texture<br>
2: [[String]] - Localised text, shown when previwing the leaflet in full screen
<br>
'''or'''
<br>
0: [[Object]] - Leaflet<br>
1: [[String]] - Class from CfgLeaflets|= Parameter 2
____________________________________________________________________________________________


| [[Nothing]]|= Return value
|x2= <code>["init", [myLeaflet,"Custom_02"]] [[call]] [[BIS_fnc_initLeaflet]];</code> |Example 2=
____________________________________________________________________________________________


|x1= <code>["init",[myLeaflet,"#(argb,8,8,3)color(1,1,0,1)","Yellow pages"]] [[call]] [[BIS_fnc_initLeaflet]];</code> |=
|x3= <code>["init", [myLeaflet,"West"]] [[call]] [[BIS_fnc_initLeaflet]];</code> |Example 3=
|x2= <code>["init",[myLeaflet,"Custom_02"]] [[call]] [[BIS_fnc_initLeaflet]];</code> |=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[Arma 3 Leaflets]], [[BIS_fnc_initInspectable]]|= See also }}
| [[Arma 3 Leaflets]], [[BIS_fnc_initInspectable]] |See also=
 
}}


<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>
Line 43: Line 44:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:initLeaflet}}]]
[[Category:Function Group: Misc|{{uc:initLeaflet}}]]
[[Category:Function Group: Misc|{{uc:initLeaflet}}]]
[[Category:Functions|{{uc:initLeaflet}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:initLeaflet}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:initLeaflet}}]]

Revision as of 16:31, 4 June 2018

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

Description

Description:
Initialize interactive leaflet.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[mode, parameters] call BIS_fnc_initLeaflet
Parameters:
mode: String - "init" for scripted initialization, other modes are used when leaflets are fired as a weapon
parameters: Array to format:
  • [leaflet, texture, text]
    • leaflet: Object - the leaflet object itself
    • texture: String - texture path
    • text: String - localized text, shown when previewing the leaflet in full screen
  • [leaflet, cfgLeafletsClass]
    • leaflet: Object - the leaflet object itself
    • cfgLeafletsClass: String - class name as string
Return Value:
Nothing

Examples

Example 1:
["init", [myLeaflet, "#(argb,8,8,3)color(1,1,0,1)", "Yellow pages"]] call BIS__fnc_initLeaflet;
Example 2:
["init", [myLeaflet,"Custom_02"]] call BIS_fnc_initLeaflet;
Example 3:
["init", [myLeaflet,"West"]] call BIS_fnc_initLeaflet;

Additional Information

See also:
Arma 3 LeafletsBIS_fnc_initInspectable

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

Notes

Bottom Section

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