BIS fnc initLeaflet: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *(arg|eff|mp|serverExec|gr[0-9]) *= *(.*) * *\|([^=]{12})" to "|$1=$2 |descr=$3")
m (Some wiki formatting)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
 
|version1= 1.76
|1.76


|gr1= Interaction
|gr1= Interaction


|descr= Initialize interactive leaflet.
|descr= Initialise 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


|p2= parameters: [[Array]] to format:
|p2= parameters: [[Array]] in format:
* [leaflet, texture, text]
* [leaflet, texture, text]:
** leaflet: [[Object]] - the leaflet object itself
** leaflet: [[Object]] - the leaflet object itself
** texture: [[String]] - texture path
** texture: [[String]] - texture path
** text: [[String]] - localized text, shown when previewing the leaflet in full screen
** text: [[String]] - localized text, shown when previewing the leaflet in full screen
* [leaflet, cfgLeafletsClass]
* [leaflet, cfgLeafletsClass]:
** leaflet: [[Object]] - the leaflet object itself
** leaflet: [[Object]] - the leaflet object itself
** cfgLeafletsClass: [[String]] - class name as string
** cfgLeafletsClass: [[String]] - class name


|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]]
}}
}}

Latest revision as of 18:46, 14 March 2024

Arma 3 logo black.png1.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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_initLeaflet&oldid=353254"