Click or drag to resize
IMyTerminalControlSlider Interface

[This is preliminary documentation and is subject to change.]

This is a value slider. A slider can be moved by a user and a value selected.

Namespace: Sandbox.ModAPI.Interfaces.Terminal
Assembly: Sandbox.Common (in Sandbox.Common.dll) Version: 1.0.0.0
Syntax
C#
public interface IMyTerminalControlSlider : IMyTerminalControl, 
	IMyTerminalValueControl<float>, ITerminalProperty, IMyTerminalControlTitleTooltip

The IMyTerminalControlSlider type exposes the following members.

Properties
  NameDescription
Public propertyEnabled
Allows you to set if the control is enabled
(Inherited from IMyTerminalControl.)
Public propertyGetter
This is triggered when the value of the control is required.
(Inherited from IMyTerminalValueControlTValue.)
Public propertyId
Identifier of control
(Inherited from IMyTerminalControl.)
Public propertySetter
This is triggered when the value of the control is set by the user. Depending on the control, this may be called a lot.
(Inherited from IMyTerminalValueControlTValue.)
Public propertySupportsMultipleBlocks
Allows you to set if the control is visible when the block is selected as a group
(Inherited from IMyTerminalControl.)
Public propertyTitle
Allows you to get or set the Label that appears on the control
(Inherited from IMyTerminalControlTitleTooltip.)
Public propertyTooltip
Allows you to get or set the tooltip that appears when you hover over the control
(Inherited from IMyTerminalControlTitleTooltip.)
Public propertyTypeName
Property type (bool - Boolean, float - Single, color - Color)
(Inherited from ITerminalProperty.)
Public propertyVisible
Allows you to set if the control is visible
(Inherited from IMyTerminalControl.)
Public propertyWriter
This is triggered when a slider value is modified. Appending to the stringbuilder allows you to modify the text that is displayed along side the slider when it updates.
Top
Methods
  NameDescription
Public methodRedrawControl
Recreates the control GUI. This allows you to update the Title of some controls.
(Inherited from IMyTerminalControl.)
Public methodSetDualLogLimits(Single, Single, Single)
Allows you to set the upper and lower limits of the slider, interpolating on a logarithmic scale at both ends
Public methodSetDualLogLimits(FuncIMyTerminalBlock, Single, FuncIMyTerminalBlock, Single, Single)
Allows you to set the upper and lower limits of the slider with delegates, interpolating on a logarithmic scale at both ends
Public methodSetLimits(Single, Single)
Allows you to set the upper and lower limits of the slider
Public methodSetLimits(FuncIMyTerminalBlock, Single, FuncIMyTerminalBlock, Single)
Allows you to set the upper and lower limits of the slider with delegates
Public methodSetLogLimits(Single, Single)
Allows you to set the upper and lower limits of the slider, interpolating on a logarithmic scale
Public methodSetLogLimits(FuncIMyTerminalBlock, Single, FuncIMyTerminalBlock, Single)
Allows you to set the upper and lower limits of the slider with delegates, interpolating on a logarithmic scale
Public methodUpdateVisual
This updates a control that is currently displayed, allowing you to refresh it's state
(Inherited from IMyTerminalControl.)
Top
Extension Methods
See Also