ctrlAutoScrollSpeed: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(updated)
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(43 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Returns number of seconds to auto-scroll one line. -1 if auto-scroll is disabled. -2 if scrollbar not present.
|game3= tkoh
<br><br>
|version3= 1.00
Autorscroll is available for [[DialogControls-ListBoxes|CT_LISTBOX]] and [[DialogControls-ControlsGroup|CT_CONTROLS_GROUP]] types of controls only. Autoscroll will wait [[ctrlAutoScrollDelay]] seconds (must be  > 0) and then will scroll the scroll bar down to the bottom. [[ctrlAutoScrollSpeed]] defines the speed with which scrollbar is scrolled. If [[ctrlAutoScrollRewind]] is [[true]], the control will fade out, immediately rewind to the top, then fade in, wait [[ctrlAutoScrollDelay]] seconds and then repeat the scrolling in a loop. If user focuses on the control, autoscrolling is interrupted.
|= Description
____________________________________________________________________________________________


| '''ctrlAutoScrollSpeed''' control |= Syntax
|game4= arma3
|version4= 0.50


|p1= control: [[Control]] - [[DialogControls-ListBoxes|CT_LISTBOX]] or [[DialogControls-ControlsGroup|CT_CONTROLS_GROUP]] |= PARAMETER1
|gr1= GUI Control


|p2= |= PARAMETER2
|gr2= GUI Control - ListBox


|p3= |= PARAMETER3
|gr3= GUI Control - ListNBox


| [[Number]] |= RETURNVALUE
|descr= Returns number of seconds to auto-scroll one line. -1 if auto-scroll is disabled. -2 if scrollbar not present.<br><br>
Autoscroll is available for [[DialogControls-ListBoxes|CT_LISTBOX]] and [[CT_CONTROLS_GROUP]] types of controls only. Autoscroll will wait [[ctrlAutoScrollDelay]] seconds (must be  > 0) and then will scroll the scroll bar down to the bottom. [[ctrlAutoScrollSpeed]] defines the speed with which scrollbar is scrolled. If [[ctrlAutoScrollRewind]] is [[true]], the control will fade out, immediately rewind to the top, then fade in, wait [[ctrlAutoScrollDelay]] seconds and then repeat the scrolling in a loop. If user focuses on the control, autoscrolling is interrupted.


|s1= [[ctrlAutoScrollSpeed]] control


|x1= <code>_ctrlSpeed =  [[ctrlAutoScrollSpeed]] _ctrlGroup;</code>|= EXAMPLE1
|p1= control: [[Control]] - [[DialogControls-ListBoxes|CT_LISTBOX]] or [[CT_CONTROLS_GROUP]]


____________________________________________________________________________________________
|r1= [[Number]]


|  [[ctrlSetAutoScrollSpeed]], [[ctrlSetAutoScrollDelay]], [[ctrlAutoScrollDelay]], [[ctrlSetAutoScrollRewind]], [[ctrlAutoScrollRewind]] |= SEEALSO
|x1= <sqf>_ctrlSpeed = ctrlAutoScrollSpeed _ctrlGroup;</sqf>


| |= MPBEHAVIOUR
|seealso= [[ctrlSetAutoScrollSpeed]] [[ctrlSetAutoScrollDelay]] [[ctrlAutoScrollDelay]] [[ctrlSetAutoScrollRewind]] [[ctrlAutoScrollRewind]]
____________________________________________________________________________________________
}}
}}
<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:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:22, 13 May 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Returns number of seconds to auto-scroll one line. -1 if auto-scroll is disabled. -2 if scrollbar not present.

Autoscroll is available for CT_LISTBOX and CT_CONTROLS_GROUP types of controls only. Autoscroll will wait ctrlAutoScrollDelay seconds (must be > 0) and then will scroll the scroll bar down to the bottom. ctrlAutoScrollSpeed defines the speed with which scrollbar is scrolled. If ctrlAutoScrollRewind is true, the control will fade out, immediately rewind to the top, then fade in, wait ctrlAutoScrollDelay seconds and then repeat the scrolling in a loop. If user focuses on the control, autoscrolling is interrupted.
Groups:
GUI ControlGUI Control - ListBoxGUI Control - ListNBox

Syntax

Syntax:
ctrlAutoScrollSpeed control
Parameters:
control: Control - CT_LISTBOX or CT_CONTROLS_GROUP
Return Value:
Number

Examples

Example 1:
_ctrlSpeed = ctrlAutoScrollSpeed _ctrlGroup;

Additional Information

See also:
ctrlSetAutoScrollSpeed ctrlSetAutoScrollDelay ctrlAutoScrollDelay ctrlSetAutoScrollRewind ctrlAutoScrollRewind

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=ctrlAutoScrollSpeed&oldid=319021"