infoPanelComponents: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)]]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1= Custom Panels |GROUP1=
|gr1= Custom Panels |GROUP1=
____________________________________________________________________________________________


| Returns array of all components available to given object info panel. |DESCRIPTION=
| Returns array of all components available to given object info panel. |DESCRIPTION=
____________________________________________________________________________________________


| unit [[infoPanelComponents]] panelID |SYNTAX=
| unit [[infoPanelComponents]] panelID |SYNTAX=
Line 35: Line 32:
* componentType: [[String]] - componentType - component type
* componentType: [[String]] - componentType - component type
* isAccessible: [[Boolean]] - boolean flag that shows if component is currently accessible (lack of required item can make it temporarily inaccessible) |RETURNVALUE2=
* isAccessible: [[Boolean]] - boolean flag that shows if component is currently accessible (lack of required item can make it temporarily inaccessible) |RETURNVALUE2=
____________________________________________________________________________________________


|x1 = <code>{{codecomment|// returns array of all components configured for _helicopter pilot seat}}
|x1 = <code>{{codecomment|// returns array of all components configured for _helicopter pilot seat}}

Revision as of 01:45, 17 January 2021

Hover & click on the images for description

Description

Description:
Returns array of all components available to given object info panel.
Groups:
Custom Panels

Syntax

Syntax:
unit infoPanelComponents panelID
Parameters:
unit: Object - the concerned vehicle
panelID: String - "left" or "right" can be used as panel names
Return Value:
Array - format [className, componentType, isAccessible]:
  • className: String - component classname as defined in object/vehicle config
  • componentType: String - componentType - component type
  • isAccessible: Boolean - boolean flag that shows if component is currently accessible (lack of required item can make it temporarily inaccessible)

Alternative Syntax

Syntax:
[unit, turretPath] infoPanelComponents panelID
Parameters:
unit: Object - the concerned vehicle
turretPath: Array - turret index
panelID: String - "left" or "right" can be used as panel names
Return Value:
Array - format [className, componentType, isAccessible]:
  • className: String - component classname as defined in object/vehicle config
  • componentType: String - componentType - component type
  • isAccessible: Boolean - boolean flag that shows if component is currently accessible (lack of required item can make it temporarily inaccessible)

Examples

Example 1:
// returns array of all components configured for _helicopter pilot seat _componentsData = [_helicopter, [-1]] infoPanelComponents "VehicleSystemsDisplayManagerComponentLeft";

Additional Information

See also:
Arma 3 Custom InfoinfoPanelinfoPanelssetInfoPanelenableInfoPanelComponentinfoPanelComponentEnabled

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