infoPanelComponents: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma3 |Game name=
| arma3


|1.72|Game version=
|1.72


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


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


| unit [[infoPanelComponents]] panelID |SYNTAX=
| unit [[infoPanelComponents]] panelID


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


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


| [[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) |RETURNVALUE=
* isAccessible: [[Boolean]] - boolean flag that shows if component is currently accessible (lack of required item can make it temporarily inaccessible)


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


|p21= unit: [[Object]] - the concerned vehicle |PARAMETER21=
|p21= unit: [[Object]] - the concerned vehicle |PARAMETER21=
Line 31: Line 31:
* 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) |RETURNVALUE2=
* isAccessible: [[Boolean]] - boolean flag that shows if component is currently accessible (lack of required item can make it temporarily inaccessible)


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


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


Revision as of 01:40, 18 January 2021

Arma 3 logo black.png1.72
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

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=infoPanelComponents&oldid=204954"