BIS fnc initLeaflet: Difference between revisions

Latest revision as of 18:46, 14 March 2024

1.76

Hover & click on the images for description

Description

Description:: Initialise interactive leaflet.
Execution:: call
Groups:: Interaction

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 in 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

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: Leaflets BIS_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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.76
-|1.76|Game version=
+|gr1= Interaction
-____________________________________________________________________________________________
-| Initialize interactive leaflet. |Description=
+|descr= Initialise interactive leaflet.
-____________________________________________________________________________________________
-| [mode, parameters] call [[BIS_fnc_initLeaflet]] |Syntax=
+|s1= [mode, parameters] call [[BIS_fnc_initLeaflet]]
-|p1= mode: [[String]] - "init" for scripted initialization, other modes are used when leaflets are fired as a weapon |Parameter 1=
+|p1= mode: [[String]] - "init" for scripted initialization, other modes are used when leaflets are fired as a weapon
-|p2= parameters: [[Array]] to format:
+|p2= parameters: [[Array]] in format:
-* [leaflet, texture, text]
+* [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, cfgLeafletsClass]:
 ** leaflet: [[Object]] - the leaflet object itself
-** cfgLeafletsClass: [[String]] - class name as string |Parameter 2=
+** cfgLeafletsClass: [[String]] - class name
-| [[Nothing]] |Return value=
+|r1= [[Nothing]]
-____________________________________________________________________________________________
-|x1= <code>["init", [myLeaflet, "#(argb,8,8,3)color(1,1,0,1)", "Yellow pages"]] [[call]] [[BIS__fnc_initLeaflet]];</code> |Example 1=
+|x1= <sqf>["init", [myLeaflet, "#(argb,8,8,3)color(1,1,0,1)", "Yellow pages"]] call BIS_fnc_initLeaflet;</sqf>
-|x2= <code>["init", [myLeaflet,"Custom_02"]] [[call]] [[BIS_fnc_initLeaflet]];</code> |Example 2=
+|x2= <sqf>["init", [myLeaflet, "Custom_02"]] call BIS_fnc_initLeaflet;</sqf>
-|x3= <code>["init", [myLeaflet,"West"]] [[call]] [[BIS_fnc_initLeaflet]];</code> |Example 3=
+|x3= <sqf>["init", [myLeaflet, "West"]] call BIS_fnc_initLeaflet;</sqf>
-____________________________________________________________________________________________
-| [[Arma 3 Leaflets]], [[BIS_fnc_initInspectable]] |See also=
+|seealso= [[Arma 3: Leaflets]] [[BIS_fnc_initInspectable]]
 }}
-<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:Functions|{{uc:initLeaflet}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:initLeaflet}}]]