BIS fnc initLeaflet: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *arma3 * * *\| *([0-2]\.[0-9]{2}) * " to "|game1= arma3 |version1= $1 ")
m (Some wiki formatting)
Line 8: Line 8:
|descr= Initialize interactive leaflet.
|descr= Initialize interactive leaflet.


|s1=[mode, parameters] call [[BIS_fnc_initLeaflet]]
|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
|p1= mode: [[String]] - "init" for scripted initialization, other modes are used when leaflets are fired as a weapon
Line 23: Line 23:
|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>["init", [myLeaflet, "#(argb,8,8,3)color(1,1,0,1)", "Yellow pages"]] [[call]] [[BIS__fnc_initLeaflet]];</code>
|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>
|x2= <sqf>["init", [myLeaflet,"Custom_02"]] call BIS_fnc_initLeaflet;</sqf>


|x3= <code>["init", [myLeaflet,"West"]] [[call]] [[BIS_fnc_initLeaflet]];</code>
|x3= <sqf>["init", [myLeaflet,"West"]] call BIS_fnc_initLeaflet;</sqf>


|seealso= [[Arma 3 Leaflets]], [[BIS_fnc_initInspectable]]
|seealso= [[Arma 3 Leaflets]] [[BIS_fnc_initInspectable]]
}}
}}

Revision as of 12:48, 6 May 2022

Hover & click on the images for description

Description

Description:
Initialize 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 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 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