BIS fnc highlightControl: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1= GUI |GROUP1=") |
m (Page filled, added example image) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma3 | |game1= arma3 | ||
|1. | |version1= 1.56 | ||
|gr1= GUI |GROUP1= | |gr1= GUI|GROUP1= | ||
| | |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]] | ||
| | |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. | ||
| | |p2= thickness: [[Number]] - (Optional, default 20) Thickness of the border | ||
| | |r1= [[Control]] - Returns the created highlight control. | ||
|x1= <code></ | |x1= <code><nowiki>[</nowiki>[[findDisplay]] 313 [[displayCtrl]] 1023] [[call]] [[BIS_fnc_highlightControl]]; {{cc|Will highlight the play button in [[Eden Editor]]}} | ||
| | <nowiki>[</nowiki>[[findDisplay]] 313] [[call]] [[BIS_fnc_highlightControl]]; {{cc|Will remove the previously created highlight effect}}</code> | ||
}} | |x2= <code>[] [[spawn]] | ||
{ | |||
[[disableSerialization]] | |||
[[private]] _ctrlHighlight = <nowiki>[</nowiki>[[findDisplay]] 313 displayCtrl 1023),5] [[call]] [[BIS_fnc_highlightControl]]; | |||
sleep 2; | |||
[[ctrlDelete]] _ctrlHighlight; | |||
};{{cc|Will highlight the play button in [[Eden Editor]] and removes the effect after two seconds}}</code> | |||
|exec= call | |||
|seealso= | |||
}} | |||
Revision as of 12:59, 8 October 2020
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
- 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; // Will highlight the play button in Eden Editor [findDisplay 313] call BIS_fnc_highlightControl; // Will remove the previously created highlight effect- Example 2:
[] spawn { disableSerialization private _ctrlHighlight = [findDisplay 313 displayCtrl 1023),5] call BIS_fnc_highlightControl; sleep 2; ctrlDelete _ctrlHighlight; };// Will highlight 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