Interface IMyTerminalBlock

Describes assembler block (mods interface)

Inherited Members
Namespace: Sandbox.ModAPI
Assembly: Sandbox.Common.dll
Syntax
public interface IMyTerminalBlock : IMyCubeBlock, IMyEntity, IMyTerminalBlock, IMyCubeBlock, IMyEntity

Properties

IsDetailedInfoDirty

Gets whether detailed info is dirty and to be updated

Declaration
bool IsDetailedInfoDirty { get; }
Property Value
Type Description
System.Boolean

Methods

ClearDetailedInfo()

Clears detailed info

Declaration
void ClearDetailedInfo()

GetDetailedInfo()

Gets detailed info instance

Declaration
StringBuilder GetDetailedInfo()
Returns
Type Description
System.Text.StringBuilder

IsInSameLogicalGroupAs(IMyTerminalBlock)

Determines whether this block is in the same logical group as the other, meaning they're connected either mechanically or via blocks like connectors. Be aware that using merge blocks combines grids into one, so this function will not filter out grids connected that way.

Declaration
bool IsInSameLogicalGroupAs(IMyTerminalBlock other)
Parameters
Type Name Description
IMyTerminalBlock other

Block
Returns
Type Description
System.Boolean

True if blocks belongs to same grids, or their grids connected with Logical

IsSameConstructAs(IMyTerminalBlock)

Determines whether this block is mechanically connected to the other. This is any block connected with rotors or pistons or other mechanical devices, but not things like connectors. This will in most cases constitute your complete construct. Be aware that using merge blocks combines grids into one, so this function will not filter out grids connected that way.

Declaration
bool IsSameConstructAs(IMyTerminalBlock other)
Parameters
Type Name Description
IMyTerminalBlock other
Returns
Type Description
System.Boolean

True if blocks belongs to same grids, or their grids connected with Logical

RefreshCustomInfo()

Raises AppendingCustomInfo so every subscriber can append custom info.

Declaration
void RefreshCustomInfo()

SetDetailedInfoDirty()

Sets detailed info dirty and to be updated

Declaration
void SetDetailedInfoDirty()

Events

AppendingCustomInfo

Event to append custom info.

Declaration
event Action<IMyTerminalBlock, StringBuilder> AppendingCustomInfo
Event Type
Type Description
System.Action<IMyTerminalBlock, System.Text.StringBuilder>

CustomDataChanged

Called when custom data of block changed

Declaration
event Action<IMyTerminalBlock> CustomDataChanged
Event Type
Type Description
System.Action<IMyTerminalBlock>

CustomNameChanged

Called when custom name of block changed

Declaration
event Action<IMyTerminalBlock> CustomNameChanged
Event Type
Type Description
System.Action<IMyTerminalBlock>

OwnershipChanged

Called when block ownership changed

Declaration
event Action<IMyTerminalBlock> OwnershipChanged
Event Type
Type Description
System.Action<IMyTerminalBlock>

PropertiesChanged

Called when any of block properties changed. It could be anything, starting from CustomName ending with Inventory items

Declaration
event Action<IMyTerminalBlock> PropertiesChanged
Event Type
Type Description
System.Action<IMyTerminalBlock>

ShowOnHUDChanged

Called when ShowOnHUD Changed

Declaration
event Action<IMyTerminalBlock> ShowOnHUDChanged
Event Type
Type Description
System.Action<IMyTerminalBlock>

VisibilityChanged

Called properties that modify the visibility of this block's controls, are changed

Declaration
event Action<IMyTerminalBlock> VisibilityChanged
Event Type
Type Description
System.Action<IMyTerminalBlock>

Extension Methods