Show / Hide Table of Contents

Interface 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.

Inherited Members
ITerminalProperty.Id
ITerminalProperty.TypeName
Namespace: Sandbox.ModAPI.Interfaces.Terminal
Assembly: Sandbox.Common.dll
Syntax
public interface IMyTerminalValueControl<TValue> : ITerminalProperty
Type Parameters
Name Description
TValue

Properties

Getter

This is triggered when the value of the control is required.

Declaration
Func<IMyTerminalBlock, TValue> Getter { get; set; }
Property Value
Type Description
System.Func<IMyTerminalBlock, TValue>

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.

Declaration
Action<IMyTerminalBlock, TValue> Setter { get; set; }
Property Value
Type Description
System.Action<IMyTerminalBlock, TValue>

Extension Methods

TerminalPropertyExtensions.As<TValue>(ITerminalProperty)
TerminalPropertyExtensions.Cast<TValue>(ITerminalProperty)
TerminalPropertyExtensions.Is<TValue>(ITerminalProperty)
TerminalPropertyExtensions.AsFloat(ITerminalProperty)
TerminalPropertyExtensions.AsColor(ITerminalProperty)
TerminalPropertyExtensions.AsBool(ITerminalProperty)
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾