IMyMechanicalConnectionBlock Interface

v01.180.0 (Beta)

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

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

Syntax

C++

Copy

public interface IMyMechanicalConnectionBlock : IMyFunctionalBlock, 
	IMyTerminalBlock, IMyCubeBlock, IMyEntity

Public Interface IMyMechanicalConnectionBlock
	Inherits IMyFunctionalBlock, IMyTerminalBlock, IMyCubeBlock, IMyEntity

public interface class IMyMechanicalConnectionBlock : IMyFunctionalBlock, 
	IMyTerminalBlock, IMyCubeBlock, IMyEntity

type IMyMechanicalConnectionBlock =  
    interface
        interface IMyFunctionalBlock
        interface IMyTerminalBlock
        interface IMyCubeBlock
        interface IMyEntity
    end

The IMyMechanicalConnectionBlock type exposes the following members.

Methods

	Name	Description
	Attach	Attaches a nearby top part to the block
	Detach	Detaches the top from the base
	GetActions	(Inherited from IMyTerminalBlock.)
	GetActionWithName	(Inherited from IMyTerminalBlock.)
	GetInventory	(Inherited from IMyEntity.)
	GetInventory(Int32)	(Inherited from IMyEntity.)
	GetOwnerFactionTag	(Inherited from IMyCubeBlock.)
	GetPlayerRelationToOwner	Obsolete. (Inherited from IMyCubeBlock.)
	GetPosition	(Inherited from IMyEntity.)
	GetProperties	(Inherited from IMyTerminalBlock.)
	GetProperty	(Inherited from IMyTerminalBlock.)
	GetUserRelationToOwner	(Inherited from IMyCubeBlock.)
	HasLocalPlayerAccess	(Inherited from IMyTerminalBlock.)
	HasPlayerAccess	(Inherited from IMyTerminalBlock.)
	RequestEnable	Obsolete. (Inherited from IMyFunctionalBlock.)
	SearchActionsOfName	(Inherited from IMyTerminalBlock.)
	SetCustomName(String)	Obsolete. (Inherited from IMyTerminalBlock.)
	SetCustomName(StringBuilder)	Obsolete. (Inherited from IMyTerminalBlock.)
	UpdateIsWorking	Obsolete. (Inherited from IMyCubeBlock.)
	UpdateVisual	Obsolete. (Inherited from IMyCubeBlock.)

Top

Extension Methods

	Name	Description
	ApplyAction(String)	Overloaded. (Defined by TerminalBlockExtentions.)
	ApplyAction(String, ListTerminalActionParameter)	Overloaded. (Defined by TerminalBlockExtentions.)
	GetDefaultValueT	Returns default value of specified property as TypeName (Defined by TerminalPropertyExtensions.)
	GetId	(Defined by TerminalBlockExtentions.)
	GetInventoryCount	(Defined by TerminalBlockExtentions.)
	GetMaximumT	Returns maximum value of specified property as TypeName (Defined by TerminalPropertyExtensions.)
	GetMinimumT	Returns minimum value of specified property as TypeName (Defined by TerminalPropertyExtensions.)
	GetMininumT	Returns minimum value of specified property as TypeName - this call is obsolete due typo in name, use GetMinimumT(IMyTerminalBlock, String) (Defined by TerminalPropertyExtensions.)
	GetUseConveyorSystem	(Defined by TerminalBlockExtentions.)
	GetValueT	Returns value of specified property as TypeName (Defined by TerminalPropertyExtensions.)
	GetValueBool	Returns value of specified property (Defined by TerminalPropertyExtensions.)
	GetValueColor	Returns value of specified property (Defined by TerminalPropertyExtensions.)
	GetValueFloat	Returns value of specified property (Defined by TerminalPropertyExtensions.)
	HasAction	(Defined by TerminalBlockExtentions.)
	HasInventory	(Defined by TerminalBlockExtentions.)
	SetUseConveyorSystem	(Defined by TerminalBlockExtentions.)
	SetValueT	Set value of property with type of TypeName (Defined by TerminalPropertyExtensions.)
	SetValueBool	Set bool value of property (Defined by TerminalPropertyExtensions.)
	SetValueColor	Set bool value of property (Defined by TerminalPropertyExtensions.)
	SetValueFloat	Set float value of property (Defined by TerminalPropertyExtensions.)

Top

Properties

	Name	Description
	BlockDefinition	(Inherited from IMyCubeBlock.)
	CheckConnectionAllowed	(Inherited from IMyCubeBlock.)
	Components	(Inherited from IMyEntity.)
	CubeGrid	(Inherited from IMyCubeBlock.)
	CustomData	Gets or sets the Custom Data string. NOTE: Only use this for user input. For storing large mod configs, create your own MyModStorageComponent (Inherited from IMyTerminalBlock.)
	CustomInfo	(Inherited from IMyTerminalBlock.)
	CustomName	(Inherited from IMyTerminalBlock.)
	CustomNameWithFaction	(Inherited from IMyTerminalBlock.)
	DefinitionDisplayNameText	(Inherited from IMyCubeBlock.)
	DetailedInfo	(Inherited from IMyTerminalBlock.)
	DisassembleRatio	(Inherited from IMyCubeBlock.)
	DisplayName	(Inherited from IMyEntity.)
	DisplayNameText	(Inherited from IMyCubeBlock.)
	Enabled	(Inherited from IMyFunctionalBlock.)
	EntityId	(Inherited from IMyEntity.)
	HasInventory	(Inherited from IMyEntity.)
	InventoryCount	(Inherited from IMyEntity.)
	IsAttached	Gets if the block base is attached to something
	IsBeingHacked	(Inherited from IMyCubeBlock.)
	IsFunctional	(Inherited from IMyCubeBlock.)
	IsLocked	Obsolete. Gets if the block is safety locked (welded)
	IsWorking	(Inherited from IMyCubeBlock.)
	Mass	(Inherited from IMyCubeBlock.)
	Max	(Inherited from IMyCubeBlock.)
	Min	(Inherited from IMyCubeBlock.)
	Name	(Inherited from IMyEntity.)
	NumberInGrid	(Inherited from IMyCubeBlock.)
	Orientation	(Inherited from IMyCubeBlock.)
	OwnerId	(Inherited from IMyCubeBlock.)
	PendingAttachment	Gets if the block is looking for a top part
	Position	(Inherited from IMyCubeBlock.)
	SafetyLock	Gets if the block is safety locked (welded)
	SafetyLockSpeed	Gets or sets the speed at which this device will engage it's safety lock (IsLocked).
	ShowInTerminal	(Inherited from IMyTerminalBlock.)
	ShowInToolbarConfig	(Inherited from IMyTerminalBlock.)
	ShowOnHUD	(Inherited from IMyTerminalBlock.)
	Top	Gets the attached top part entity
	TopGrid	Gets the grid of the attached top part
	WorldAABB	(Inherited from IMyEntity.)
	WorldAABBHr	(Inherited from IMyEntity.)
	WorldMatrix	(Inherited from IMyEntity.)
	WorldVolume	(Inherited from IMyEntity.)
	WorldVolumeHr	(Inherited from IMyEntity.)

Top

Reference

Sandbox.ModAPI.Ingame Namespace