enableInfoPanelComponent: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix See also links)
m (template:command argument fix)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Controls availability of component to given object info panel. |= Description
| Controls availability of component to given object info panel. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| unit [[enableInfoPanelComponent]] [panelID, componentClassOrType, enable] |= Syntax
| unit [[enableInfoPanelComponent]] [panelID, componentClassOrType, enable] |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=


|p3= componentClassOrType: [[String]] |= Parameter 3
|p3= componentClassOrType: [[String]] |PARAMETER3=


|p4= enable: [[Boolean]] |= Parameter 4
|p4= enable: [[Boolean]] |PARAMETER4=


| [[Boolean]] - [[true]] if component was successfully enabled on the panel, [[false]] otherwise (e.g. component is not available for the object) |= Return value
| [[Boolean]] - [[true]] if component was successfully enabled on the panel, [[false]] otherwise (e.g. component is not available for the object) |RETURNVALUE=


|s2= [unit, turretPath] [[enableInfoPanelComponent]] [panelID, componentClassOrType, enable] |= Alternative Syntax
|s2= [unit, turretPath] [[enableInfoPanelComponent]] [panelID, componentClassOrType, enable] |= 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=


|p24= componentClassOrType: [[String]] |= Parameter 4
|p24= componentClassOrType: [[String]] |PARAMETER4=


|p25= enable: [[Boolean]] |= Parameter 4
|p25= enable: [[Boolean]] |PARAMETER4=


|r2= [[Boolean]] - [[true]] if component was successfully enabled on the panel, [[false]] otherwise (e.g. component is not available for the object) |= Return value
|r2= [[Boolean]] - [[true]] if component was successfully enabled on the panel, [[false]] otherwise (e.g. component is not available for the object) |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1 = <code>{{codecomment|// enables slingload assistant on player's vehicle right panel at driver position}}
|x1 = <code>{{codecomment|// enables slingload assistant on player's vehicle right panel at driver position}}
<nowiki>[</nowiki>[[vehicle]] [[player]], [-1]] [[enableInfoPanelComponent]] ["VehicleSystemsDisplayManagerComponentRight", "SlingLoadDisplay", [[true]]];</code> |= Example 1
<nowiki>[</nowiki>[[vehicle]] [[player]], [-1]] [[enableInfoPanelComponent]] ["VehicleSystemsDisplayManagerComponentRight", "SlingLoadDisplay", [[true]]];</code> |EXAMPLE1=


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



Revision as of 14:38, 7 April 2019

Hover & click on the images for description

Description

Description:
Controls availability of component to given object info panel.
Groups:
Uncategorised

Syntax

Syntax:
unit enableInfoPanelComponent [panelID, componentClassOrType, enable]
Parameters:
unit: Object - the concerned vehicle
panelID: String - "left" or "right" can be used as panel names
componentClassOrType: String
enable: Boolean
Return Value:
Boolean - true if component was successfully enabled on the panel, false otherwise (e.g. component is not available for the object)

Alternative Syntax

Syntax:
[unit, turretPath] enableInfoPanelComponent [panelID, componentClassOrType, enable]
Parameters:
unit: Object - the concerned vehicle
turretPath: Array - turret index
panelID: String - "left" or "right" can be used as panel names
componentClassOrType: String
enable: Boolean
Return Value:
Boolean - true if component was successfully enabled on the panel, false otherwise (e.g. component is not available for the object)

Examples

Example 1:
// enables slingload assistant on player's vehicle right panel at driver position [vehicle player, [-1]] enableInfoPanelComponent ["VehicleSystemsDisplayManagerComponentRight", "SlingLoadDisplay", true];

Additional Information

See also:
Arma 3 Custom InfoinfoPanelinfoPanelssetInfoPanelinfoPanelComponentsinfoPanelComponentEnabled

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