IMyShipConnector 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 IMyShipConnector : IMyFunctionalBlock, 
	IMyTerminalBlock, IMyCubeBlock, IMyEntity

Public Interface IMyShipConnector
	Inherits IMyFunctionalBlock, IMyTerminalBlock, IMyCubeBlock, IMyEntity

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

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

The IMyShipConnector type exposes the following members.

Methods

	Name	Description
	Connect	Attempts to connect. If Status is anything else but [!:ConnectorStatus.Connectable], this method does nothing.
	Disconnect	Disconnects this connector.
	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.)
	ToggleConnect	Toggles between [!:ConnectorStatus.Connected] and [!:ConnectorStatus.Unconnected], depending on the current status. Another connector must be in range for this method to have any effect.
	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.)
	CollectAll	Gets or sets whether this connector should be pulling items into its inventory.
	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.)
	IsBeingHacked	(Inherited from IMyCubeBlock.)
	IsConnected	Obsolete.
	IsFunctional	(Inherited from IMyCubeBlock.)
	IsLocked	Obsolete.
	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.)
	OtherConnector	Gets the connector this one is connected to when Status is [!:ConnectorStatus.Connected].
	OwnerId	(Inherited from IMyCubeBlock.)
	Position	(Inherited from IMyCubeBlock.)
	PullStrength	Gets or sets the currently configured strength of the pull when the connector is within range of another.
	ShowInTerminal	(Inherited from IMyTerminalBlock.)
	ShowInToolbarConfig	(Inherited from IMyTerminalBlock.)
	ShowOnHUD	(Inherited from IMyTerminalBlock.)
	Status	Determines the current status of the connector.
	ThrowOut	Gets or sets whether this connector should throw out anything placed in its inventory.
	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