Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlSlider Interface Reference

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

Inheritance diagram for Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlSlider:

Public Member Functions
void	SetLimits (float min, float max)
	Allows you to set the upper and lower limits of the slider More...
void	SetLogLimits (float min, float max)
	Allows you to set the upper and lower limits of the slider, interpolating on a logarithmic scale More...
void	SetDualLogLimits (float absMin, float absMax, float centerBand)
	Allows you to set the upper and lower limits of the slider, interpolating on a logarithmic scale at both ends More...
void	SetLimits (Func< IMyTerminalBlock, float > minGetter, Func< IMyTerminalBlock, float > maxGetter)
	Allows you to set the upper and lower limits of the slider with delegates More...
void	SetLogLimits (Func< IMyTerminalBlock, float > minGetter, Func< IMyTerminalBlock, float > maxGetter)
	Allows you to set the upper and lower limits of the slider with delegates, interpolating on a logarithmic scale More...
void	SetDualLogLimits (Func< IMyTerminalBlock, float > minGetter, Func< IMyTerminalBlock, float > maxGetter, float centerBand)
	Allows you to set the upper and lower limits of the slider with delegates, interpolating on a logarithmic scale at both ends More...
Public Member Functions inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl
void	RedrawControl ()
	Recreates the control GUI. This allows you to update the Title of some controls. More...
void	UpdateVisual ()
	This updates a control that is currently displayed, allowing you to refresh it's state More...

Properties
Action< IMyTerminalBlock, StringBuilder >	Writer [get, set]
	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. More...
Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl
string	Id [get]
	Identifier of control More...
Func< IMyTerminalBlock, bool >	Enabled [set]
	Allows you to set if the control is enabled More...
Func< IMyTerminalBlock, bool >	Visible [set]
	Allows you to set if the control is visible More...
bool	SupportsMultipleBlocks [get, set]
	Allows you to set if the control is visible when the block is selected as a group More...
Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalValueControl< float >
Func< IMyTerminalBlock, TValue >	Getter [get, set]
	This is triggered when the value of the control is required. More...
Action< IMyTerminalBlock, TValue >	Setter [get, set]
	This is triggered when the value of the control is set by the user. Depending on the control, this may be called a lot. More...
Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlTitleTooltip
MyStringId	Title [get, set]
	Allows you to get or set the Label that appears on the control More...
MyStringId	Tooltip [get, set]
	Allows you to get or set the tooltip that appears when you hover over the control More...

Detailed Description

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

Definition at line 10 of file IMyTerminalControlSlider.cs.

Member Function Documentation

void Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlSlider.SetDualLogLimits	(	float	absMin,
		float	absMax,
		float	centerBand
	)

Allows you to set the upper and lower limits of the slider, interpolating on a logarithmic scale at both ends

Parameters

min
max

Implemented in Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.

void Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlSlider.SetDualLogLimits	(	Func< IMyTerminalBlock, float >	minGetter,
		Func< IMyTerminalBlock, float >	maxGetter,
		float	centerBand
	)

Allows you to set the upper and lower limits of the slider with delegates, interpolating on a logarithmic scale at both ends

Parameters

min
max

void Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlSlider.SetLimits	(	float	min,
		float	max
	)

Allows you to set the upper and lower limits of the slider

Parameters

min	Minimum value
max	Maximum value

Implemented in Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.

void Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlSlider.SetLimits	(	Func< IMyTerminalBlock, float >	minGetter,
		Func< IMyTerminalBlock, float >	maxGetter
	)

Allows you to set the upper and lower limits of the slider with delegates

Parameters

min
max

void Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlSlider.SetLogLimits	(	float	min,
		float	max
	)

Allows you to set the upper and lower limits of the slider, interpolating on a logarithmic scale

Parameters

min
max

Implemented in Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.

void Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlSlider.SetLogLimits	(	Func< IMyTerminalBlock, float >	minGetter,
		Func< IMyTerminalBlock, float >	maxGetter
	)

Allows you to set the upper and lower limits of the slider with delegates, interpolating on a logarithmic scale

Parameters

min
max

Property Documentation

Action<IMyTerminalBlock, StringBuilder> Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlSlider.Writer

getset

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.

Definition at line 52 of file IMyTerminalControlSlider.cs.

---

The documentation for this interface was generated from the following file:

• Sources/Sandbox.Common/ModAPI/Interfaces/Terminal/IMyTerminalControlSlider.cs