BIS fnc initInspectable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(Page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Initialize inspectable object: add "Inspect" action to the object. When a player activates it, full-screen detail of the objects is shown. |= Description
____________________________________________________________________________________________


Description:
| [inspectable, textureInfos, fullScreenText, soundName] call [[BIS_fnc_initInspectable]] |= Syntax
Initialize inspectable object.
Adds "Inspect" action to the object. When player activates it, full-screen detail of the objects is shown.


Parameter(s):
|p1= inspectable: [[Object]] - object on which the action is added |= Parameter 1
0: OBJECT - object on which the action is added
1:
STRING - texture
ARRAY of following items:
0: STRING - texture
1 (Optional): NUMBER - index on which the texture will be mapped on the object using setObjectTexture. Use -1 to ignore. Default is 0.
2 (Optional): NUMBER - aspect ratio. 0.5 means width will be 0.5 of the height. Default is -1, which means texture default.
BOOL - show the full-screen preview instantly (following params are ignored)
2: (Optional) STRING - text of the texture, shown after clicking on READ button. Ideally localized.
3 (Optional): STRING - sound played when enetering full-screen preview. Class from CfgSounds.


Examples:
|p2= textureInfos: can be one of the following:
// Initialize
* [[String]] - texture path
[this,"#(argb,8,8,3)color(1,0,1,1)","Pink"] call bis_fnc_initInspectable;
* [[Array]] - [texture, index, aspectRatio]:
** texture: [[String]] - (Optional, default 0) index on which the texture will be mapped on the object using setObjectTexture. Use -1 to ignore.
** index: [[Number]] - (Optional, default -1) aspect ratio. 0.5 means width will be 0.5 of the height. -1 means texture default.
* [[Bool]] - true show the full-screen preview instantly ('''following params are ignored''') |= Parameter 2


// Show preview instantly
|p3= fullScreenText: [[String]] - text to be shown after clicking on READ button. Ideally localized. |= Parameter 3
[myLeaflet,true] call bis_fnc_initLeaflet;


Returns:
|p4= soundName: [[String]] - sound played when entering full-screen preview. Sould be defined in [[Description.ext#CfgSounds|CfgSounds]]. |= Parameter 4
NOTHING
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
| [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_initInspectable]]; --> |= Syntax
|x1= <code>[myLeaflet, "#(argb,8,8,3)color(1,0,1,1)", "This is some Magic Pink"] [[call]] [[BIS_fnc_initInspectable]]; {{codecomment|// Initialize}}</code> |= Example 1
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________


|x1= <code></code> |=  
|x2= <code>[myLeaflet, [[true]]] [[call]] [[BIS_fnc_initLeaflet]]; {{codecomment|// Show preview instantly}}</code> |= Example 2
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[BIS_fnc_holdActionAdd]], [[BIS_fnc_holdActionRemove]] |= See also


}}
}}

Revision as of 23:55, 19 April 2018

Arma 3 logo black.png1.76
Hover & click on the images for description

Description

Description:
Initialize inspectable object: add "Inspect" action to the object. When a player activates it, full-screen detail of the objects is shown.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[inspectable, textureInfos, fullScreenText, soundName] call BIS_fnc_initInspectable
Parameters:
inspectable: Object - object on which the action is added
textureInfos: can be one of the following:
  • String - texture path
  • Array - [texture, index, aspectRatio]:
    • texture: String - (Optional, default 0) index on which the texture will be mapped on the object using setObjectTexture. Use -1 to ignore.
    • index: Number - (Optional, default -1) aspect ratio. 0.5 means width will be 0.5 of the height. -1 means texture default.
  • Bool - true show the full-screen preview instantly (following params are ignored)
fullScreenText: String - text to be shown after clicking on READ button. Ideally localized.
soundName: String - sound played when entering full-screen preview. Sould be defined in CfgSounds.
Return Value:
Nothing

Examples

Example 1:
[myLeaflet, "#(argb,8,8,3)color(1,0,1,1)", "This is some Magic Pink"] call BIS_fnc_initInspectable; // Initialize
Example 2:
[myLeaflet, true] call BIS_fnc_initLeaflet; // Show preview instantly

Additional Information

See also:
BIS_fnc_holdActionAddBIS_fnc_holdActionRemove

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

Notes

Bottom Section

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