IMyTerminalControlProperty(TValue) Interface

IMyTerminalControlPropertyTValue Interface

v01.180.0 (Beta)

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

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

Namespace: Sandbox.ModAPI.Interfaces.Terminal
Assembly: Sandbox.Common (in Sandbox.Common.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public interface IMyTerminalControlProperty<TValue> : IMyTerminalControl, 
	IMyTerminalValueControl<TValue>, ITerminalProperty

Public Interface IMyTerminalControlProperty(Of TValue)
	Inherits IMyTerminalControl, IMyTerminalValueControl(Of TValue), ITerminalProperty

generic<typename TValue>
public interface class IMyTerminalControlProperty : IMyTerminalControl, 
	IMyTerminalValueControl<TValue>, ITerminalProperty

type IMyTerminalControlProperty<'TValue> =  
    interface
        interface IMyTerminalControl
        interface IMyTerminalValueControl<'TValue>
        interface ITerminalProperty
    end

Type Parameters

TValue

The IMyTerminalControlPropertyTValue type exposes the following members.

Methods

	Name	Description
	RedrawControl	Recreates the control GUI. This allows you to update the Title of some controls. (Inherited from IMyTerminalControl.)
	UpdateVisual	This updates a control that is currently displayed, allowing you to refresh it's state (Inherited from IMyTerminalControl.)

Top

Extension Methods

	Name	Description
	AsTValue	Property type cast (Defined by TerminalPropertyExtensions.)
	AsBool	Property type cast (Defined by TerminalPropertyExtensions.)
	AsColor	Property type cast (Defined by TerminalPropertyExtensions.)
	AsFloat	Property type cast (Defined by TerminalPropertyExtensions.)
	CastTValue	Property type cast (Defined by TerminalPropertyExtensions.)
	IsTValue	Check property type (Defined by TerminalPropertyExtensions.)

Top

Properties

	Name	Description
	Enabled	Allows you to set if the control is enabled (Inherited from IMyTerminalControl.)
	Getter	This is triggered when the value of the control is required. (Inherited from IMyTerminalValueControlTValue.)
	Id	Identifier of control (Inherited from IMyTerminalControl.)
	Setter	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.)
	SupportsMultipleBlocks	Allows you to set if the control is visible when the block is selected as a group (Inherited from IMyTerminalControl.)
	TypeName	Property type (bool - Boolean, float - Single, color - Color) (Inherited from ITerminalProperty.)
	Visible	Allows you to set if the control is visible (Inherited from IMyTerminalControl.)

Top

Reference

Sandbox.ModAPI.Interfaces.Terminal Namespace