BIS fnc initLeaflet: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.76|Game version=
|1.76


|gr1 = Interaction |GROUP1=
|gr1 = Interaction


| Initialize interactive leaflet. |Description=
| Initialize interactive leaflet.


| [mode, parameters] call [[BIS_fnc_initLeaflet]] |Syntax=
| [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]] to format:
Line 20: Line 20:
* [leaflet, cfgLeafletsClass]
* [leaflet, cfgLeafletsClass]
** leaflet: [[Object]] - the leaflet object itself
** leaflet: [[Object]] - the leaflet object itself
** cfgLeafletsClass: [[String]] - class name as string |Parameter 2=
** cfgLeafletsClass: [[String]] - class name as string


| [[Nothing]] |Return value=
| [[Nothing]]


|x1= <code>["init", [myLeaflet, "#(argb,8,8,3)color(1,1,0,1)", "Yellow pages"]] [[call]] [[BIS__fnc_initLeaflet]];</code> |Example 1=
|x1= <code>["init", [myLeaflet, "#(argb,8,8,3)color(1,1,0,1)", "Yellow pages"]] [[call]] [[BIS__fnc_initLeaflet]];</code>


|x2= <code>["init", [myLeaflet,"Custom_02"]] [[call]] [[BIS_fnc_initLeaflet]];</code> |Example 2=
|x2= <code>["init", [myLeaflet,"Custom_02"]] [[call]] [[BIS_fnc_initLeaflet]];</code>


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


| [[Arma 3 Leaflets]], [[BIS_fnc_initInspectable]] |See also=
| [[Arma 3 Leaflets]], [[BIS_fnc_initInspectable]]
}}
}}


Revision as of 00:11, 18 January 2021

Arma 3 logo black.png1.76
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 LeafletsBIS_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


Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_initLeaflet&oldid=203167"