BIS fnc highlightControl: Difference between revisions

Revision as of 12:12, 13 July 2022

Hover & click on the images for description

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

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.

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

: 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

@@ Line 17: / Line 17: @@
 |r1= [[Control]] - Returns the created highlight control.
-|x1= <code><nowiki>[</nowiki>[[findDisplay]] 313 [[displayCtrl]] 1023] [[call]] [[BIS_fnc_highlightControl]]; // Will highlight the play button in [[Eden Editor]]
+|x1= <sqf>
+[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
+</sqf>
-<nowiki>[</nowiki>[[findDisplay]] 313] [[call]] [[BIS_fnc_highlightControl]]; // Will remove the previously created highlight effect</code>
+|x2= <sqf>
+[] spawn
-|x2= <code>[] [[spawn]]
 {
-   [[disableSerialization]];
+   disableSerialization;
-   [[private]] _ctrlHighlight = [<nowiki/>[[findDisplay]] 313 [[displayCtrl]] 1023),5] [[call]] [[BIS_fnc_highlightControl]];
+   private _ctrlHighlight = [findDisplay 313 displayCtrl 1023),5] call BIS_fnc_highlightControl;
-   [[sleep]] 2;
+   sleep 2;
-   [[ctrlDelete]] _ctrlHighlight;
+   ctrlDelete _ctrlHighlight;
-}; // Will highlight the play button in [[Eden Editor]] and removes the effect after two seconds</code>
+}; // highlights the play button in Eden Editor and removes the effect after two seconds
+</sqf>
 |seealso=
 }}