2019-10-26 16:40:31 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 10:08:05 +02:00
<class name= "EditorSpinSlider" inherits= "Range" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2019-10-26 16:40:31 +02:00
<brief_description >
2021-05-25 17:38:19 +02:00
Godot editor's control for editing numeric values.
2019-10-26 16:40:31 +02:00
</brief_description>
<description >
2021-05-19 14:19:07 +02:00
This [Control] node is used in the editor's Inspector dock to allow editing of numeric values. Can be used with [EditorInspectorPlugin] to recreate the same behavior.
2023-11-10 12:44:07 +01:00
If the [member Range.step] value is [code]1[/code], the [EditorSpinSlider] will display up/down arrows, similar to [SpinBox]. If the [member Range.step] value is not [code]1[/code], a slider will be displayed instead.
2019-10-26 16:40:31 +02:00
</description>
<tutorials >
</tutorials>
<members >
<member name= "flat" type= "bool" setter= "set_flat" getter= "is_flat" default= "false" >
2022-10-06 21:59:48 +02:00
If [code]true[/code], the slider will not draw background.
2019-10-26 16:40:31 +02:00
</member>
2022-11-06 20:27:24 +01:00
<member name= "focus_mode" type= "int" setter= "set_focus_mode" getter= "get_focus_mode" overrides= "Control" enum= "Control.FocusMode" default= "2" />
2022-04-09 23:31:22 +02:00
<member name= "hide_slider" type= "bool" setter= "set_hide_slider" getter= "is_hiding_slider" default= "false" >
2023-07-04 15:20:15 +02:00
If [code]true[/code], the slider and up/down arrows are hidden.
2022-04-09 23:31:22 +02:00
</member>
2019-10-26 16:40:31 +02:00
<member name= "label" type= "String" setter= "set_label" getter= "get_label" default= """" >
2022-10-06 21:59:48 +02:00
The text that displays to the left of the value.
2019-10-26 16:40:31 +02:00
</member>
<member name= "read_only" type= "bool" setter= "set_read_only" getter= "is_read_only" default= "false" >
2022-10-06 21:59:48 +02:00
If [code]true[/code], the slider can't be interacted with.
2019-10-26 16:40:31 +02:00
</member>
2023-06-15 16:06:22 +02:00
<member name= "size_flags_vertical" type= "int" setter= "set_v_size_flags" getter= "get_v_size_flags" overrides= "Control" enum= "Control.SizeFlags" is_bitfield= "true" default= "1" />
2022-11-09 08:59:49 +01:00
<member name= "step" type= "float" setter= "set_step" getter= "get_step" overrides= "Range" default= "1.0" />
Fix editor suffixes and degrees conversion
* Functions to convert to/from degrees are all gone. Conversion is done by the editor.
* Use PROPERTY_HINT_ANGLE instead of PROPERTY_HINT_RANGE to edit radian angles in degrees.
* Added possibility to add suffixes to range properties, use "min,max[,step][,suffix:<something>]" example "0,100,1,suffix:m"
* In general, can add suffixes for EditorSpinSlider
Not covered by this PR, will have to be addressed by future ones:
* Ability to switch radians/degrees in the inspector for angle properties (if actually wanted).
* Animations previously made will most likely break, need to add a way to make old ones compatible.
* Only added a "px" suffix to 2D position and a "m" one to 3D position, someone needs to go through the rest of the engine and add all remaining suffixes.
* Likely also need to track down usage of EditorSpinSlider outside properties to add suffixes to it too.
2021-06-29 21:42:12 +02:00
<member name= "suffix" type= "String" setter= "set_suffix" getter= "get_suffix" default= """" >
The suffix to display after the value (in a faded color). This should generally be a plural word. You may have to use an abbreviation if the suffix is too long to be displayed.
</member>
2019-10-26 16:40:31 +02:00
</members>
2022-12-08 13:38:01 +01:00
<signals >
<signal name= "grabbed" >
<description >
Emitted when the spinner/slider is grabbed.
</description>
</signal>
<signal name= "ungrabbed" >
<description >
Emitted when the spinner/slider is ungrabbed.
</description>
</signal>
<signal name= "value_focus_entered" >
<description >
Emitted when the value form gains focus.
</description>
</signal>
<signal name= "value_focus_exited" >
<description >
Emitted when the value form loses focus.
</description>
</signal>
</signals>
2019-10-26 16:40:31 +02:00
</class>
