IMyTerminalValueControl(TValue) Interface

IMyTerminalValueControl<TValue> Interface

v01.180.0 (Beta)

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

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.

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 IMyTerminalValueControl<TValue> : ITerminalProperty

Public Interface IMyTerminalValueControl(Of TValue)
	Inherits ITerminalProperty

generic<typename TValue>
public interface class IMyTerminalValueControl : ITerminalProperty

type IMyTerminalValueControl<'TValue> =  
    interface
        interface ITerminalProperty
    end

Type Parameters

TValue

The IMyTerminalValueControl< TValue> type exposes the following members.

Extension Methods

	Name	Description
	As<TValue>	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.)
	Cast<TValue>	Property type cast (Defined by TerminalPropertyExtensions.)
	Is<TValue>	Check property type (Defined by TerminalPropertyExtensions.)

Top

Properties

	Name	Description
	Getter	This is triggered when the value of the control is required.
	Id	Property Id (value name) (Inherited from ITerminalProperty.)
	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.
	TypeName	Property type (bool - Boolean, float - Single, color - Color) (Inherited from ITerminalProperty.)

Top

Reference

Sandbox.ModAPI.Interfaces.Terminal Namespace