IMyTerminalControls.CreateProperty(TValue, TBlock) Method

IMyTerminalControlsCreatePropertyTValue, TBlock Method

v01.180.0 (Beta)

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

This creates a property that can be added to a block. A property is not visible on the terminal screen but can hold a value that can be used in programmable blocks.

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

Syntax

C++

Copy

IMyTerminalControlProperty<TValue> CreateProperty<TValue, TBlock>(
	string id
)

Function CreateProperty(Of TValue, TBlock) ( 
	id As String
) As IMyTerminalControlProperty(Of TValue)

generic<typename TValue, typename TBlock>
IMyTerminalControlProperty<TValue>^ CreateProperty(
	String^ id
)

abstract CreateProperty : 
        id : string -> IMyTerminalControlProperty<'TValue>

Parameters

id: Type: SystemString
A unique identifier for this property

Type Parameters

TValue: The type of property you're creating
TBlock: The ModAPI interface of the associated block

Return Value

Type: IMyTerminalControlPropertyTValue
Returns an IMyTerminalControlProperty that can be added to a block via AddControl

Reference

IMyTerminalControls Interface

Sandbox.ModAPI Namespace