Show / Hide Table of Contents

Interface IMyTerminalControl

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

Namespace: Sandbox.ModAPI.Interfaces.Terminal
Assembly: Sandbox.Common.dll
Syntax
public interface IMyTerminalControl

Properties

Enabled

Allows you to set if the control is enabled

Declaration
Func<IMyTerminalBlock, bool> Enabled { get; set; }
Property Value
Type Description
System.Func<IMyTerminalBlock, System.Boolean>

Id

Identifier of control

Declaration
string Id { get; }
Property Value
Type Description
System.String

SupportsMultipleBlocks

Allows you to set if the control is visible when the block is selected as a group

Declaration
bool SupportsMultipleBlocks { get; set; }
Property Value
Type Description
System.Boolean

Visible

Allows you to set if the control is visible

Declaration
Func<IMyTerminalBlock, bool> Visible { get; set; }
Property Value
Type Description
System.Func<IMyTerminalBlock, System.Boolean>

Methods

RedrawControl()

Recreates the control GUI. This allows you to update the Title of some controls.

Declaration
void RedrawControl()

UpdateVisual()

This updates a control that is currently displayed, allowing you to refresh it's state

Declaration
void UpdateVisual()
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾