infoPanelComponents: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
mNo edit summary
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.72


|1.72|= Game version
|gr1= Custom Panels
____________________________________________________________________________________________


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


| unit [[infoPanelComponents]] panelID |SYNTAX=
|s1= 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]:
|r1= [[Array]] with [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 |PARAMETER1=
|p21= unit: [[Object]] - the concerned vehicle


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


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


|r2= [[Array]] - format [className, componentType, isAccessible]:
|r2= [[Array]] with [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)
____________________________________________________________________________________________


|x1 = <code>{{codecomment|// returns array of all components configured for _helicopter pilot seat}}
|x1= <sqf>
_componentsData = [_helicopter, [-1]] [[infoPanelComponents]] "VehicleSystemsDisplayManagerComponentLeft";</code> |EXAMPLE1=
// returns array of all components configured for _helicopter pilot seat
private _componentsData = [_helicopter, [-1]] infoPanelComponents "left";
</sqf>


| [[Arma 3 Custom Info]], [[infoPanel]], [[infoPanels]], [[setInfoPanel]], [[enableInfoPanelComponent]], [[infoPanelComponentEnabled]] |SEEALSO=
|seealso= [[Arma 3: Custom Info]] [[infoPanel]] [[infoPanels]] [[setInfoPanel]] [[enableInfoPanelComponent]] [[infoPanelComponentEnabled]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Command Group: Custom Panels]]

Latest revision as of 11:19, 16 June 2024

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 with [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 with [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 private _componentsData = [_helicopter, [-1]] infoPanelComponents "left";

Additional Information

See also:
Arma 3: Custom Info infoPanel infoPanels setInfoPanel enableInfoPanelComponent infoPanelComponentEnabled

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
Retrieved from "https://community.bistudio.com/wiki?title=infoPanelComponents&oldid=364839"