infoPanelComponentEnabled: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Fix See also links) |
m (template:command argument fix) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Controls availability of component to given object info panel. |= | | Controls availability of component to given object info panel. |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| unit [[infoPanelComponentEnabled]] [panelID, componentClassOrType] |= | | unit [[infoPanelComponentEnabled]] [panelID, componentClassOrType] |SYNTAX= | ||
|p1= unit: [[Object]] - the concerned vehicle |= | |p1= unit: [[Object]] - the concerned vehicle |PARAMETER1= | ||
|p2= panelID: [[String]] - "left" or "right" can be used as panel names |= | |p2= panelID: [[String]] - "left" or "right" can be used as panel names |PARAMETER2= | ||
|p3= componentClassOrType: [[String]] |= | |p3= componentClassOrType: [[String]] |PARAMETER3= | ||
| [[Boolean]] - [[true]] if component was successfully enabled on the panel, [[false]] otherwise (e.g. component is not available for the object) |= | | [[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] [[infoPanelComponentEnabled]] [panelID, componentClassOrType] |= Alternative Syntax | |s2= [unit, turretPath] [[infoPanelComponentEnabled]] [panelID, componentClassOrType] |= Alternative Syntax | ||
|p21= unit: [[Object]] - the concerned vehicle |= | |p21= unit: [[Object]] - the concerned vehicle |PARAMETER1= | ||
|p22= turretPath: [[Array]] - turret index |= | |p22= turretPath: [[Array]] - turret index |PARAMETER2= | ||
|p23= panelID: [[String]] - "left" or "right" can be used as panel names |= | |p23= panelID: [[String]] - "left" or "right" can be used as panel names |PARAMETER3= | ||
|p24= componentClassOrType: [[String]] |= | |p24= componentClassOrType: [[String]] |PARAMETER4= | ||
|r2= [[Boolean]] |= | |r2= [[Boolean]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>{{codecomment|//returns true if specific component "SensorDisplay" is enabled on player vehicle's left panel}} | |x1= <code>{{codecomment|//returns true if specific component "SensorDisplay" is enabled on player vehicle's left panel}} | ||
_state = <nowiki>[</nowiki>[[vehicle]] [[player]], [-1]] [[infoPanelComponentEnabled]] ["VehicleSystemsDisplayManagerComponentLeft", "SensorDisplay"];</code> |= | _state = <nowiki>[</nowiki>[[vehicle]] [[player]], [-1]] [[infoPanelComponentEnabled]] ["VehicleSystemsDisplayManagerComponentLeft", "SensorDisplay"];</code> |EXAMPLE1= | ||
|x2= <code>{{codecomment|//returns true if all "SensorsDisplayComponent" components are enabled on player vehicle's left panel, otherwise returns false}} | |x2= <code>{{codecomment|//returns true if all "SensorsDisplayComponent" components are enabled on player vehicle's left panel, otherwise returns false}} | ||
_state = <nowiki>[</nowiki>[[vehicle]] [[player]], [-1]] [[infoPanelComponentEnabled]] ["VehicleSystemsDisplayManagerComponentLeft", "SensorsDisplayComponent"];</code> |= | _state = <nowiki>[</nowiki>[[vehicle]] [[player]], [-1]] [[infoPanelComponentEnabled]] ["VehicleSystemsDisplayManagerComponentLeft", "SensorsDisplayComponent"];</code> |EXAMPLE2= | ||
| [[Arma 3 Custom Info]], [[infoPanel]], [[infoPanels]], [[setInfoPanel]], [[infoPanelComponents]], [[enableInfoPanelComponent]] |= | | [[Arma 3 Custom Info]], [[infoPanel]], [[infoPanels]], [[setInfoPanel]], [[infoPanelComponents]], [[enableInfoPanelComponent]] |SEEALSO= | ||
}} | }} | ||
Revision as of 15:41, 7 April 2019
Description
- Description:
- Controls availability of component to given object info panel.
- Groups:
- Uncategorised
Syntax
- Syntax:
- unit infoPanelComponentEnabled [panelID, componentClassOrType]
- Parameters:
- unit: Object - the concerned vehicle
- panelID: String - "left" or "right" can be used as panel names
- componentClassOrType: String
- 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] infoPanelComponentEnabled [panelID, componentClassOrType]
- Parameters:
- unit: Object - the concerned vehicle
- turretPath: Array - turret index
- panelID: String - "left" or "right" can be used as panel names
- componentClassOrType: String
- Return Value:
- Boolean
Examples
- Example 1:
//returns true if specific component "SensorDisplay" is enabled on player vehicle's left panel _state = [vehicle player, [-1]] infoPanelComponentEnabled ["VehicleSystemsDisplayManagerComponentLeft", "SensorDisplay"];- Example 2:
//returns true if all "SensorsDisplayComponent" components are enabled on player vehicle's left panel, otherwise returns false _state = [vehicle player, [-1]] infoPanelComponentEnabled ["VehicleSystemsDisplayManagerComponentLeft", "SensorsDisplayComponent"];
Additional Information
- See also:
- Arma 3 Custom InfoinfoPanelinfoPanelssetInfoPanelinfoPanelComponentsenableInfoPanelComponent
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