infoPanels: 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 all info panels configured for given object or object and turret path. |DESCRIPTION=
| Returns array all info panels configured for given object or object and turret path.


| [[infoPanels]] unit |SYNTAX=
| [[infoPanels]] unit


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


| [[Array]] - format [<nowiki/>[infoPanelId1, infoPanelShortcutId1], [infoPanelId2, infoPanelShortcutId2], …]:
| [[Array]] - format [<nowiki/>[infoPanelId1, infoPanelShortcutId1], [infoPanelId2, infoPanelShortcutId2], …]:
* infoPanelId: [[String]] - name of the info panel class as defined in vehicle config
* infoPanelId: [[String]] - name of the info panel class as defined in vehicle config
* infopanelShortcutId: [[String]] - shortcut representation of ''infopanelId'', currently are supported only shortcuts "left" and "right" |RETURNVALUE=
* infopanelShortcutId: [[String]] - shortcut representation of ''infopanelId'', currently are supported only shortcuts "left" and "right"


|s2= [[infoPanels]] [unit, turretPath] |Alternative Syntax=
|s2= [[infoPanels]] [unit, turretPath]


|p21= unit: [[Object]] - the concerned vehicle |PARAMETER21=
|p21= unit: [[Object]] - the concerned vehicle |PARAMETER21=
Line 25: Line 25:
|r2= [[Array]] - format [<nowiki/>[infoPanelId1, infoPanelShortcutId1], [infoPanelId2, infoPanelShortcutId2], …]:
|r2= [[Array]] - format [<nowiki/>[infoPanelId1, infoPanelShortcutId1], [infoPanelId2, infoPanelShortcutId2], …]:
* infoPanelId: [[String]] - name of the info panel class as defined in vehicle config
* infoPanelId: [[String]] - name of the info panel class as defined in vehicle config
* infopanelShortcutId: [[String]] - shortcut representation of ''infopanelId'', currently are supported only shortcuts "left" and "right" |RETURNVALUE2=
* infopanelShortcutId: [[String]] - shortcut representation of ''infopanelId'', currently are supported only shortcuts "left" and "right"


|x1 = <code>[[infoPanels]] [<nowiki/>[[vehicle]] [[player]], [0]];</code> |EXAMPLE1=
|x1 = <code>[[infoPanels]] [<nowiki/>[[vehicle]] [[player]], [0]];</code>


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



Revision as of 00:42, 18 January 2021

Hover & click on the images for description

Description

Description:
Returns array all info panels configured for given object or object and turret path.
Groups:
Custom Panels

Syntax

Syntax:
infoPanels unit
Parameters:
unit: Object - the concerned vehicle
Return Value:
Array - format [[infoPanelId1, infoPanelShortcutId1], [infoPanelId2, infoPanelShortcutId2], …]:
  • infoPanelId: String - name of the info panel class as defined in vehicle config
  • infopanelShortcutId: String - shortcut representation of infopanelId, currently are supported only shortcuts "left" and "right"

Alternative Syntax

Syntax:
infoPanels [unit, turretPath]
Parameters:
unit: Object - the concerned vehicle
turretPath: Array - turret index
Return Value:
Array - format [[infoPanelId1, infoPanelShortcutId1], [infoPanelId2, infoPanelShortcutId2], …]:
  • infoPanelId: String - name of the info panel class as defined in vehicle config
  • infopanelShortcutId: String - shortcut representation of infopanelId, currently are supported only shortcuts "left" and "right"

Examples

Example 1:
infoPanels [vehicle player, [0]];

Additional Information

See also:
Arma 3 Custom InfoinfoPanelsetInfoPanelinfoPanelComponentsenableInfoPanelComponentinfoPanelComponentEnabled

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