BIS_fnc_initInspectable

Description

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

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.

Returns: 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_initInspectable; // Show preview instantly

See also

BIS_fnc_holdActionAdd · BIS_fnc_holdActionRemove