Interface ITerminalProperty<TValue>

Terminal block property access

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

Property type (TypeName)

Methods

GetDefaultValue(IMyCubeBlock)

Default value of property (if value is not set, or value from block definition)

Declaration
TValue GetDefaultValue(IMyCubeBlock block)
Parameters
Type Name Description
IMyCubeBlock block

block reference
Returns
Type Description
TValue

value of type TypeName

GetMaximum(IMyCubeBlock)

Maximum value of property (value from block definition)

Declaration
TValue GetMaximum(IMyCubeBlock block)
Parameters
Type Name Description
IMyCubeBlock block

block reference
Returns
Type Description
TValue

value of type TypeName

GetMinimum(IMyCubeBlock)

Minimum value of property (value from block definition)

Declaration
TValue GetMinimum(IMyCubeBlock block)
Parameters
Type Name Description
IMyCubeBlock block

block reference
Returns
Type Description
TValue

value of type TypeName

GetMininum(IMyCubeBlock)

Minimum value of property (value from block definition) - this function is obsolete, because it contains typo in name, use GetMinimum(IMyCubeBlock)

Declaration
TValue GetMininum(IMyCubeBlock block)
Parameters
Type Name Description
IMyCubeBlock block

block reference
Returns
Type Description
TValue

value of type TypeName

GetValue(IMyCubeBlock)

Retrieve property value

Declaration
TValue GetValue(IMyCubeBlock block)
Parameters
Type Name Description
IMyCubeBlock block

block reference
Returns
Type Description
TValue

value of type TypeName

SetValue(IMyCubeBlock, TValue)

Set property value

Declaration
void SetValue(IMyCubeBlock block, TValue value)
Parameters
Type Name Description
IMyCubeBlock block

block reference
TValue value

value of type TypeName

Extension Methods