BIS fnc highlightControl: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Page filled, added example image)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


|game1= arma3
|game1= arma3
|version1= 1.56
|version1= 1.56


|gr1= GUI|GROUP1=
|gr1= GUI


|descr= Highlights given control by drawing a border around it and letting it pulsate. The effect is visible until explicitly removed. [[File:A3 BIS fnc highlightControl.jpg]]
|descr= Highlights given control by drawing a border around it and letting it pulsate. The effect is visible until explicitly removed. <br>
[[File:A3 BIS_fnc_highlightControl.jpg]]


|s1= [displayOrControl, thickness] call [[BIS_fnc_highlightControl]]
|s1= [displayOrControl, thickness] call [[BIS_fnc_highlightControl]]


|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


|r1= [[Control]] - Returns the created highlight control.
|p2= thickness: [[Number]] - (Optional, default 20) thickness of the border


|x1= <code><nowiki>[</nowiki>[[findDisplay]] 313 [[displayCtrl]] 1023] [[call]] [[BIS_fnc_highlightControl]]; {{cc|Will highlight the play button in [[Eden Editor]]}}
|r1= [[Control]] - returns the created highlight control.


<nowiki>[</nowiki>[[findDisplay]] 313] [[call]] [[BIS_fnc_highlightControl]]; {{cc|Will remove the previously created highlight effect}}</code>
|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>


|x2= <code>[] [[spawn]]
|x2= <sqf>
[] spawn
{
{
   [[disableSerialization]]
   disableSerialization;
   [[private]] _ctrlHighlight = <nowiki>[</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;
};{{cc|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>
|exec= call


|seealso=
|seealso=
}}
}}

Latest revision as of 15:47, 8 November 2023

Arma 3 logo black.png1.56
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_highlightControl&oldid=349033"