Slider#

type krpc_UI_Slider_t#

A control for choosing a number by dragging a handle along a track. Added to a krpc_UI_Canvas_t or a krpc_UI_Panel_t.

krpc_error_t krpc_UI_Slider_RectTransform(krpc_connection_t connection, krpc_UI_RectTransform_t *returnValue, krpc_UI_Slider_t instance)#: The rect transform for the UI object.

krpc_error_t krpc_UI_Slider_LayoutElement(krpc_connection_t connection, krpc_UI_LayoutElement_t *returnValue, krpc_UI_Slider_t instance)#: How much space the UI object asks a layout for.

Note

Only has an effect when the object is in a panel that has a layout. A canvas is not inside a layout and does not have one.

krpc_error_t krpc_UI_Slider_Visible(krpc_connection_t connection, bool *returnValue, krpc_UI_Slider_t instance)#

krpc_error_t krpc_UI_Slider_set_Visible(krpc_connection_t connection, krpc_UI_Slider_t instance, bool value)#: Whether the UI object is visible.

Note

This is the object’s own setting, which is what it was last set to. An object is only drawn when everything it is inside is visible as well, so an interface can be built with its parts visible, inside a panel that is not, and shown all at once by making that panel visible.

krpc_error_t krpc_UI_Slider_Value(krpc_connection_t connection, float *returnValue, krpc_UI_Slider_t instance)#

krpc_error_t krpc_UI_Slider_set_Value(krpc_connection_t connection, krpc_UI_Slider_t instance, float value)#: The value of the slider, between krpc_UI_Slider_Min() and krpc_UI_Slider_Max(). Setting a value outside the range is refused.

krpc_error_t krpc_UI_Slider_Min(krpc_connection_t connection, float *returnValue, krpc_UI_Slider_t instance)#

krpc_error_t krpc_UI_Slider_set_Min(krpc_connection_t connection, krpc_UI_Slider_t instance, float value)#: The value at the low end of the slider, which is its left hand end, or the bottom of a vertical slider. Must not be greater than krpc_UI_Slider_Max().

krpc_error_t krpc_UI_Slider_Max(krpc_connection_t connection, float *returnValue, krpc_UI_Slider_t instance)#

krpc_error_t krpc_UI_Slider_set_Max(krpc_connection_t connection, krpc_UI_Slider_t instance, float value)#: The value at the high end of the slider, which is its right hand end, or the top of a vertical slider. Must not be less than krpc_UI_Slider_Min().

krpc_error_t krpc_UI_Slider_Changed(krpc_connection_t connection, bool *returnValue, krpc_UI_Slider_t instance)#

krpc_error_t krpc_UI_Slider_set_Changed(krpc_connection_t connection, krpc_UI_Slider_t instance, bool value)#: Whether the slider has been changed.

Note

This property is set to true when the user moves the slider, and not when a client sets its value. A client script should reset the property to false in order to detect subsequent changes.

krpc_error_t krpc_UI_Slider_Interactable(krpc_connection_t connection, bool *returnValue, krpc_UI_Slider_t instance)#

krpc_error_t krpc_UI_Slider_set_Interactable(krpc_connection_t connection, krpc_UI_Slider_t instance, bool value)#: Whether the control responds to the user.

Note

A control that is not interactable is drawn grayed out and ignores the user, but is still visible. Set its visibility to false to hide it instead.

krpc_error_t krpc_UI_Slider_Color(krpc_connection_t connection, krpc_StdLib_ColorRGBA_t *returnValue, krpc_UI_Slider_t instance)#

krpc_error_t krpc_UI_Slider_set_Color(krpc_connection_t connection, krpc_UI_Slider_t instance, const krpc_StdLib_ColorRGBA_t *value)#: The color the control is tinted with. White, the default, leaves the control drawn as the skin has it.

Note

The tint multiplies the sprite the control is drawn with, in every state, so a control can show a state of its own, an engaged autopilot for instance, by color. It is applied to the part of the control that responds to the user: the body of a button, dropdown or input field, the box of a toggle, and the handle of a slider. A control’s label is tinted through the color of its text.

krpc_error_t krpc_UI_Slider_Tooltip(krpc_connection_t connection, char **returnValue, krpc_UI_Slider_t instance)#

krpc_error_t krpc_UI_Slider_set_Tooltip(krpc_connection_t connection, krpc_UI_Slider_t instance, const char *value)#: A short piece of text shown beside the pointer while it rests on the control. Empty, the default, shows nothing.

krpc_error_t krpc_UI_Slider_Remove(krpc_connection_t connection, krpc_UI_Slider_t instance)#: Remove the UI object.