BIS fnc initLeaflet: Difference between revisions

Latest revision as of 17: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: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.76
-| arma3 |= Game name
+|gr1= Interaction
-|1.00|= Game version
+|descr= Initialise interactive leaflet.
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [mode, parameters] call [[BIS_fnc_initLeaflet]]
-	Description:
+|p1= mode: [[String]] - "init" for scripted initialization, other modes are used when leaflets are fired as a weapon
-	Initialize interactive leaflet.
-	Parameter(s):
+|p2= parameters: [[Array]] in format:
-: STRING - mode; use "init" for scripted initialization, other modes are used when leaflets are fired as a weapon.
+* [leaflet, texture, text]:
-: ARRAY - params in one of the following formats
+** leaflet: [[Object]] - the leaflet object itself
-: OBJECT - leaflet
+** texture: [[String]] - texture path
-: STRINg - texture
+** text: [[String]] - localized text, shown when previewing the leaflet in full screen
-: STRING - localized text, shown when previewing the leaflet in full screen
+* [leaflet, cfgLeafletsClass]:
+** leaflet: [[Object]] - the leaflet object itself
+** cfgLeafletsClass: [[String]] - class name
-			or
+|r1= [[Nothing]]
-: OBJECT - leaflet
+|x1= <sqf>["init", [myLeaflet, "#(argb,8,8,3)color(1,1,0,1)", "Yellow pages"]] call BIS_fnc_initLeaflet;</sqf>
-: STRING - class from CfgLeaflets
-	Examples:
+|x2= <sqf>["init", [myLeaflet, "Custom_02"]] call BIS_fnc_initLeaflet;</sqf>
-		["init",[myLeaflet,"#(argb,8,8,3)color(1,1,0,1)","Yellow pages"]] call bis_fnc_initLeaflet;
-		["init",[myLeaflet,"Custom_02"]] call bis_fnc_initLeaflet;
+|x3= <sqf>["init", [myLeaflet, "West"]] call BIS_fnc_initLeaflet;</sqf>
-	Returns:
-	NOTHING
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_initLeaflet]]; --> |= Syntax
-|p1= |= Parameter 1
-| |= Return value
-____________________________________________________________________________________________
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| |= 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:Function Group: Misc|{{uc:initLeaflet}}]]
-[[Category:Functions|{{uc:initLeaflet}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:initLeaflet}}]]