ITerminalProperty(TValue) Interface

ITerminalPropertyTValue Interface

v01.180.0 (Beta)

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

Terminal block property access

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

Syntax

public interface ITerminalProperty<TValue> : ITerminalProperty

Public Interface ITerminalProperty(Of TValue)
	Inherits ITerminalProperty

generic<typename TValue>
public interface class ITerminalProperty : ITerminalProperty

type ITerminalProperty<'TValue> =  
    interface
        interface ITerminalProperty
    end

The ITerminalPropertyTValue type exposes the following members.

Methods

	Name	Description
	GetDefaultValue	Default value of property (if value is not set, or value from block definition)
	GetMaximum	Maximum value of property (value from block definition)
	GetMinimum	Minimum value of property (value from block definition)
	GetMininum	Obsolete. Minimum value of property (value from block definition) - this function is obsolete, because it contains typo in name, use [!:GetMinimum(Sandbox.ModAPI.Ingame.IMyCubeBlock)]
	GetValue	Retrieve property value
	SetValue	Set property value

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

Properties

	Name	Description
	Id	Property Id (value name) (Inherited from ITerminalProperty.)
	TypeName	Property type (bool - Boolean, float - Single, color - Color) (Inherited from ITerminalProperty.)