enableInfoPanelComponent: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Add panelID "left"/"right")
m (Text replacement - "[[Arma 3 " to "[[Arma 3: ")
 
(29 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
____________________________________________________________________________________________


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


| unit [[enableInfoPanelComponent]] [panelID, componentClassOrType, enable] |= Syntax
|s1= unit [[enableInfoPanelComponent]] [panelID, componentClassOrType, enable]


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


|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


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


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


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


|s2= [unit, turretPath] [[enableInfoPanelComponent]] [panelID, componentClassOrType, enable] |= Alternative Syntax
|s2= [unit, turretPath] [[enableInfoPanelComponent]] [panelID, componentClassOrType, enable]


|p21= unit: [[Object]] - the concerned vehicle |= Parameter 1
|p21= unit: [[Object]] - the concerned vehicle


|p22= turretPath: [[Array]] - turret index |= Parameter 2
|p22= turretPath: [[Array]] - turret index


|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


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


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


|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)
____________________________________________________________________________________________


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


| [[Arma 3 Custom Info]], [[infopanel]], [[infopanels]], [[setInfoPanel]], [[infoPanelComponents]], [[infoPanelComponentEnabled]] |= See also
|seealso= [[Arma 3: Custom Info]] [[infoPanel]] [[infoPanels]] [[setInfoPanel]] [[infoPanelComponents]] [[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 10:38, 6 May 2024

Arma 3 logo black.png1.72
Hover & click on the images for description

Description

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

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 Info infoPanel infoPanels setInfoPanel infoPanelComponents 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=enableInfoPanelComponent&oldid=364264"