infoPanelComponents: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page creation)
 
m (template:command argument fix)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| 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=


|p1= unit: [[Object]] - the concerned vehicle |= Parameter 1
|p1= unit: [[Object]] - the concerned vehicle |PARAMETER1=


|p2= panelID: [[String]] - "left" or "right" can be used as panel names |= Parameter 2
|p2= panelID: [[String]] - "left" or "right" can be used as panel names |PARAMETER2=


| [[Array]] - format [className, componentType, isAccessible]:
| [[Array]] - format [className, componentType, isAccessible]:
* className: [[String]] - component classname as defined in object/vehicle config
* className: [[String]] - component classname as defined in object/vehicle config
* 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) |= Return value
* isAccessible: [[Boolean]] - boolean flag that shows if component is currently accessible (lack of required item can make it temporarily inaccessible) |RETURNVALUE=


|s2= [unit, turretPath] [[infoPanelComponents]] panelID |= Alternative Syntax
|s2= [unit, turretPath] [[infoPanelComponents]] panelID |= Alternative Syntax


|p21= unit: [[Object]] - the concerned vehicle |= Parameter 1
|p21= unit: [[Object]] - the concerned vehicle |PARAMETER1=


|p22= turretPath: [[Array]] - turret index |= Parameter 2
|p22= turretPath: [[Array]] - turret index |PARAMETER2=


|p23= panelID: [[String]] - "left" or "right" can be used as panel names |= Parameter 3
|p23= panelID: [[String]] - "left" or "right" can be used as panel names |PARAMETER3=


|r2= [[Array]] - format [className, componentType, isAccessible]:
|r2= [[Array]] - format [className, componentType, isAccessible]:
* className: [[String]] - component classname as defined in object/vehicle config
* className: [[String]] - component classname as defined in object/vehicle config
* 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) |= Return value
* isAccessible: [[Boolean]] - boolean flag that shows if component is currently accessible (lack of required item can make it temporarily inaccessible) |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|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}}
_componentsData = [_helicopter, [-1]] [[infoPanelComponents]] "VehicleSystemsDisplayManagerComponentLeft";</code> |= Example 1
_componentsData = [_helicopter, [-1]] [[infoPanelComponents]] "VehicleSystemsDisplayManagerComponentLeft";</code> |EXAMPLE1=


| [[Arma 3 Custom Info]], [[infoPanel]], [[infoPanels]], [[setInfoPanel]], [[enableInfoPanelComponent]], [[infoPanelComponentEnabled]] |= See also
| [[Arma 3 Custom Info]], [[infoPanel]], [[infoPanels]], [[setInfoPanel]], [[enableInfoPanelComponent]], [[infoPanelComponentEnabled]] |SEEALSO=
}}
}}



Revision as of 14:41, 7 April 2019

Hover & click on the images for description

Description

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

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