BIS fnc initInspectable: Difference between revisions

Latest revision as of 11:46, 6 May 2022

1.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:: Interaction

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 - texture path
- index: Number - (Optional, default 0) index on which the texture will be mapped on the object using setObjectTexture. Use -1 to ignore.
- aspectRatio: Number - (Optional, default -1) texture aspect ratio. 0.5 means width will be 0.5 of the height. -1 means texture default.
Boolean - true to instantly show the inspectable full-screen preview (following params are then 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_holdActionAdd BIS_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

@@ Line 1: / Line 1: @@
-{{Function|= Comments
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |= Game name
+|game1= arma3
+|version1= 1.76
-|1.76|= Game version
+|gr1= Interaction
-____________________________________________________________________________________________
-| Initialize inspectable object: add "Inspect" action to the object. When a player activates it, full-screen detail of the objects is shown. |= Description
+|descr= Initialize inspectable object: add "Inspect" action to the object. When a player activates it, full-screen detail of the objects is shown.
-____________________________________________________________________________________________
-| [inspectable, textureInfos, fullScreenText, soundName] call [[BIS_fnc_initInspectable]] |= Syntax
+|s1= [inspectable, textureInfos, fullScreenText, soundName] call [[BIS_fnc_initInspectable]]
-|p1= inspectable: [[Object]] - object on which the action is added |= Parameter 1
+|p1= inspectable: [[Object]] - object on which the action is added
 |p2= 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.
+** texture: [[String]] - texture path
-** index: [[Number]] - (Optional, default -1) aspect ratio. 0.5 means width will be 0.5 of the height. -1 means texture default.
+** index: [[Number]] - (Optional, default 0) index on which the texture will be mapped on the object using setObjectTexture. Use -1 to ignore.
-* [[Bool]] - true show the full-screen preview instantly ('''following params are ignored''') |= Parameter 2
+** aspectRatio: [[Number]] - (Optional, default -1) texture aspect ratio. 0.5 means width will be 0.5 of the height. -1 means texture default.
+* [[Boolean]] - [[true]] to instantly show the ''inspectable'' full-screen preview ('''following params are then ignored''')
-|p3= fullScreenText: [[String]] - text to be shown after clicking on READ button. Ideally localized. |= Parameter 3
+|p3= fullScreenText: [[String]] - text to be shown after clicking on READ button. Ideally localized.
-|p4= soundName: [[String]] - sound played when entering full-screen preview. Sould be defined in [[Description.ext#CfgSounds|CfgSounds]]. |= Parameter 4
+|p4= soundName: [[String]] - sound played when entering full-screen preview. Sould be defined in [[Description.ext#CfgSounds|CfgSounds]].
-| [[Nothing]] |= Return value
+|r1= [[Nothing]]
-____________________________________________________________________________________________
-|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
+|x1= <sqf>[myLeaflet, "#(argb,8,8,3)color(1,0,1,1)", "This is some Magic Pink"] call BIS_fnc_initInspectable; // initialize</sqf>
-|x2= <code>[myLeaflet, [[true]]] [[call]] [[BIS_fnc_initLeaflet]]; {{codecomment|// Show preview instantly}}</code> |= Example 2
+|x2= <sqf>[myLeaflet, true] call BIS_fnc_initLeaflet; // Show preview instantly</sqf>
-____________________________________________________________________________________________
-| [[BIS_fnc_holdActionAdd]], [[BIS_fnc_holdActionRemove]] |= See also
+|seealso= [[BIS_fnc_holdActionAdd]] [[BIS_fnc_holdActionRemove]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Misc|{{uc:initInspectable}}]]
-[[Category:Functions|{{uc:initInspectable}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:initInspectable}}]]