BIS fnc initInspectable: Difference between revisions
Jump to navigation
Jump to search
m (template:command argument fix) |
m (template:command argument fix) |
||
| Line 12: | Line 12: | ||
| [inspectable, textureInfos, fullScreenText, soundName] call [[BIS_fnc_initInspectable]] |SYNTAX= | | [inspectable, textureInfos, fullScreenText, soundName] call [[BIS_fnc_initInspectable]] |SYNTAX= | ||
|p1= inspectable: [[Object]] - object on which the action is added |= | |p1= inspectable: [[Object]] - object on which the action is added |PARAMETER1= | ||
|p2= textureInfos: can be one of the following: | |p2= textureInfos: can be one of the following: | ||
| Line 20: | Line 20: | ||
** index: [[Number]] - (Optional, default 0) index on which the texture will be mapped on the object using setObjectTexture. Use -1 to ignore. | ** 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. | ** aspectRatio: [[Number]] - (Optional, default -1) texture aspect ratio. 0.5 means width will be 0.5 of the height. -1 means texture default. | ||
* [[Bool]] - [[true]] to instantly show the ''inspectable'' full-screen preview ('''following params are then ignored''') |= | * [[Bool]] - [[true]] to instantly show the ''inspectable'' full-screen preview ('''following params are then ignored''') |PARAMETER2= | ||
|p3= fullScreenText: [[String]] - text to be shown after clicking on READ button. Ideally localized. |= | |p3= fullScreenText: [[String]] - text to be shown after clicking on READ button. Ideally localized. |PARAMETER3= | ||
|p4= soundName: [[String]] - sound played when entering full-screen preview. Sould be defined in [[Description.ext#CfgSounds|CfgSounds]]. |= | |p4= soundName: [[String]] - sound played when entering full-screen preview. Sould be defined in [[Description.ext#CfgSounds|CfgSounds]]. |PARAMETER4= | ||
| [[Nothing]] |RETURNVALUE= | | [[Nothing]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>[myLeaflet, "#(argb,8,8,3)color(1,0,1,1)", "This is some Magic Pink"] [[call]] [[BIS_fnc_initInspectable]]; {{codecomment|// Initialize}}</code> |= | |x1= <code>[myLeaflet, "#(argb,8,8,3)color(1,0,1,1)", "This is some Magic Pink"] [[call]] [[BIS_fnc_initInspectable]]; {{codecomment|// Initialize}}</code> |EXAMPLE1= | ||
|x2= <code>[myLeaflet, [[true]]] [[call]] [[BIS_fnc_initLeaflet]]; {{codecomment|// Show preview instantly}}</code> |= | |x2= <code>[myLeaflet, [[true]]] [[call]] [[BIS_fnc_initLeaflet]]; {{codecomment|// Show preview instantly}}</code> |EXAMPLE2= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 14:30, 7 April 2019
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 - 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.
- Bool - 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
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