BIS fnc initLeaflet: Difference between revisions

From Bohemia Interactive Community
m (Some wiki formatting)
(Add position-class syntax and example, thanks Puotek on Discord)
 
Line 10: Line 10:
|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 initialisation, other mode ("fired") is used when leaflets are fired as a weapon


|p2= parameters: [[Array]] in format:
|p2= parameters: [[Array]] in format:
Line 19: Line 19:
* [leaflet, cfgLeafletsClass]:
* [leaflet, cfgLeafletsClass]:
** leaflet: [[Object]] - the leaflet object itself
** leaflet: [[Object]] - the leaflet object itself
** cfgLeafletsClass: [[String]] - class name
* [position, cfgLeafletsClass]:
** position: [[Array]] format [[Position]] - desired placement position (see [[createVehicle]])
** cfgLeafletsClass: [[String]] - class name
** cfgLeafletsClass: [[String]] - class name


Line 28: Line 31:


|x3= <sqf>["init", [myLeaflet, "West"]] call BIS_fnc_initLeaflet;</sqf>
|x3= <sqf>["init", [myLeaflet, "West"]] call BIS_fnc_initLeaflet;</sqf>
|x4= <sqf>["init", [getPosATL player, "Custom_02"]] call BIS_fnc_initLeaflet;</sqf>


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

Latest revision as of 14:43, 29 September 2025

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 initialisation, other mode ("fired") is 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
  • [position, cfgLeafletsClass]:
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;
Example 4:
["init", [getPosATL player, "Custom_02"]] 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