BIS fnc initLeaflet: Difference between revisions

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


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


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


| <pre>/*
| Initialize interactive leaflet. |= Description
____________________________________________________________________________________________


Description:
| [mode, params] spawn [[BIS_fnc_initLeaflet]] |= Syntax
Initialize interactive leaflet.
____________________________________________________________________________________________
 
Parameter(s):
0: STRING - mode; use "init" for scripted initialization, other modes are used when leaflets are fired as a weapon.
1: ARRAY - params in one of the following formats
0: OBJECT - leaflet
1: STRINg - texture
2: STRING - localized text, shown when previewing the leaflet in full screen


or
|p1= mode: [[String]] - Use "init" for scripted initialization, other modes are used when leaflets are fired as a weapon. |= Parameter 1
 
|p2= params: [[Array]] - Params in format:<br>
0: OBJECT - leaflet
0: [[Object]] - Leaflet<br>
1: STRING - class from CfgLeaflets
1: [[String]] - Texture<br>
 
2: [[String]] - Localised text, shown when previwing the leaflet in full screen
Examples:
<br>
["init",[myLeaflet,"#(argb,8,8,3)color(1,1,0,1)","Yellow pages"]] call bis_fnc_initLeaflet;
'''or'''
 
<br>
["init",[myLeaflet,"Custom_02"]] call bis_fnc_initLeaflet;
0: [[Object]] - Leaflet<br>
 
1: [[String]] - Class from CfgLeaflets|= Parameter 2
Returns:
NOTHING
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_initLeaflet]]; --> |= Syntax
| [[Nothing]]|= Return value
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


}}


<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>

Revision as of 16:28, 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, params] spawn BIS_fnc_initLeaflet
Parameters:
mode: String - Use "init" for scripted initialization, other modes are used when leaflets are fired as a weapon.
params: Array - Params in format:
0: Object - Leaflet
1: String - Texture
2: String - Localised text, shown when previwing the leaflet in full screen
or
0: Object - Leaflet
1: String - Class from CfgLeaflets
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;

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=107977"