BIS fnc highlightControl: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.56


| arma3 |= Game name
|gr1= GUI


|1.00|= Game version
|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]]


| ''N/A'' |DESCRIPTION=
|s1= [displayOrControl, thickness] call [[BIS_fnc_highlightControl]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_highlightControl]]; --> |SYNTAX=
|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= |PARAMETER1=


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


|x1= <code></code> |=
|r1= [[Control]] - returns the created highlight control.
____________________________________________________________________________________________


| |SEEALSO=
|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= <sqf>
[] 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
</sqf>
|seealso=
}}
}}
<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:Function Group: Default|{{uc:highlightControl}}]]
[[Category:Functions|{{uc:highlightControl}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:highlightControl}}]]

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"