asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document Range's value_changed signal is also emitted with code changes

Browse source 
This also mentions that the signal is potentially emitted every frame,
which can have performance implications.

(cherry picked from commit cdbb31adc9)
This commit is contained in:
Hugo Locurcio 2022-03-14 17:14:57 +01:00 committed by Rémi Verschelde
parent 8eb539d5c1
commit 1a300503c6
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/classes/Range.xml
View file

@ -13,13 +13,13 @@
<return type="void" /> <return type="void" />
<argument index="0" name="with" type="Node" /> <argument index="0" name="with" type="Node" />
<description> <description>
Binds two ranges together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group. Binds two [Range]s together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group.
</description> </description>
</method> </method>
<method name="unshare"> <method name="unshare">
<return type="void" /> <return type="void" />
<description> <description>
Stops range from sharing its member variables with any other. Stops the [Range] from sharing its member variables with any other.
</description> </description>
</method> </method>
</methods> </methods>
@ -64,7 +64,8 @@
<signal name="value_changed"> <signal name="value_changed">
<argument index="0" name="value" type="float" /> <argument index="0" name="value" type="float" />
<description> <description>
Emitted when [member value] changes. Emitted when [member value] changes. When used on a [Slider], this is called continuously while dragging (potentially every frame). If you are performing an expensive operation in a function connected to [signal value_changed], consider using a [i]debouncing[/i] [Timer] to call the function less often.
[b]Note:[/b] Unlike signals such as [signal LineEdit.text_changed], [signal value_changed] is also emitted when [code]value[/code] is set directly via code.
</description> </description>
</signal> </signal>
</signals> </signals>