BIS fnc highlightControl: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "BIS fnc " to "BIS_fnc_")
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )T([a-z])" to "$1t$3")
Line 13: Line 13:
|p1= displayOrControl: [[Control]] - Can be a [[Control]] or a [[Display]]. When a display is passed as parameter, the function will delete the previously created highlight control on that given display.
|p1= displayOrControl: [[Control]] - Can be a [[Control]] or a [[Display]]. When a display is passed as parameter, the function will delete the previously created highlight control on that given display.


|p2= thickness: [[Number]] - (Optional, default 20) Thickness of the border
|p2= thickness: [[Number]] - (Optional, default 20) thickness of the border


|r1= [[Control]] - Returns the created highlight control.
|r1= [[Control]] - Returns the created highlight control.

Revision as of 12:32, 8 November 2023

Hover & click on the images for description

Description

Description:
Highlights given control by drawing a border around it and letting it pulsate. The effect is visible until explicitly removed.
A3 BIS fnc highlightControl.jpg
Execution:
call
Groups:
GUI

Syntax

Syntax:
[displayOrControl, thickness] call BIS_fnc_highlightControl
Parameters:
displayOrControl: Control - Can be a Control or a Display. When a display is passed as parameter, the function will delete the previously created highlight control on that given display.
thickness: Number - (Optional, default 20) thickness of the border
Return Value:
Control - Returns the created highlight control.

Examples

Example 1:
[findDisplay 313 displayCtrl 1023] call BIS_fnc_highlightControl; // highlights the play button in Eden Editor [findDisplay 313] call BIS_fnc_highlightControl; // removes the previously created highlight effect
Example 2:
[] spawn { disableSerialization; private _ctrlHighlight = [findDisplay 313 displayCtrl 1023),5] call BIS_fnc_highlightControl; sleep 2; ctrlDelete _ctrlHighlight; }; // highlights the play button in Eden Editor and removes the effect after two seconds

Additional Information

See also:
See also needed

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