BIS fnc initInspectable: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Arguments fix) |
m (template:command argument fix) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Initialize inspectable object: add "Inspect" action to the object. When a player activates it, full-screen detail of the objects is shown. |= | | Initialize inspectable object: add "Inspect" action to the object. When a player activates it, full-screen detail of the objects is shown. |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [inspectable, textureInfos, fullScreenText, soundName] call [[BIS_fnc_initInspectable]] |= | | [inspectable, textureInfos, fullScreenText, soundName] call [[BIS_fnc_initInspectable]] |SYNTAX= | ||
|p1= inspectable: [[Object]] - object on which the action is added |= Parameter 1 | |p1= inspectable: [[Object]] - object on which the action is added |= Parameter 1 | ||
| Line 26: | Line 26: | ||
|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]]. |= Parameter 4 | ||
| [[Nothing]] |= | | [[Nothing]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 34: | Line 34: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[BIS_fnc_holdActionAdd]], [[BIS_fnc_holdActionRemove]] |= | | [[BIS_fnc_holdActionAdd]], [[BIS_fnc_holdActionRemove]] |SEEALSO= | ||
}} | }} | ||
Revision as of 11:28, 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