Show / Hide Table of Contents

Namespace Sandbox.ModAPI.Interfaces.Terminal

Interfaces

IMyTerminalAction

This is an interface wrapper for terminal actions that appear on a toolbar. An instance of this interface is created via MyAPIGateway.TerminalControls.CreateAction. Once created, you may modify various fields to control how the action behaves.

IMyTerminalControl

This is the base terminal control interface. All controls implement this.

IMyTerminalControlButton

This is a control button. When a button is clicked an action is performed.

IMyTerminalControlCheckbox

This is a checkbox. A label appears and a box appears next to it

IMyTerminalControlColor

This is a color control. This terminal controls allows you to select colors.

IMyTerminalControlCombobox

This is a combobox control. It is a field that gives a drop down list that contains options that you can select.

IMyTerminalControlLabel

This is a simple label control.

IMyTerminalControlListbox

This is a list box. It contains a list of items that a user can select.

IMyTerminalControlOnOffSwitch

This is an on / off switch or toggle button. It gives two options that a user can toggled between.

IMyTerminalControlProperty<TValue>

This is a control property. This is use to set properties on a block that can be referenced in the ProgrammableBlock.

IMyTerminalControlSeparator

This is a simple line separator used to separate controls in a visible manner.

IMyTerminalControlSlider

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

IMyTerminalControlTextbox

This is a textbox where a user can enter values into.

IMyTerminalControlTitleTooltip

This is a base interface for other interfaces. Almost all controls implement this, and allows you to set the label (Title) of the control and also the tooltip that appears when hovering over the control.

IMyTerminalValueControl<TValue>

This is a value control interface that a few controls implement. When a value changes, the Setter action is performed. When a value is queried the Getter action is performed.

☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾