Interface IMyShipConnector

Describes connector block (PB scripting interface)

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

Properties

CollectAll

Gets or sets whether this connector should be pulling items into its inventory.

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

IsConnected

Gets whether the connector is connected. For more precise state use Status.

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

IsLocked

Obsolete

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

IsParkingEnabled

Is this block triggered by the parking signal?

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

OtherConnector

Gets the connector this one is connected to when Status is Connected.

Declaration
IMyShipConnector OtherConnector { get; }
Property Value
Type Description
IMyShipConnector

PullStrength

Gets or sets the currently configured strength of the pull when the connector is within range of another.

Declaration
float PullStrength { get; set; }
Property Value
Type Description
System.Single

Status

Determines the current status of the connector.

Declaration
MyShipConnectorStatus Status { get; }
Property Value
Type Description
MyShipConnectorStatus

ThrowOut

Gets or sets whether this connector should throw out anything placed in its inventory.

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

Methods

Connect()

Attempts to connect. If Status is anything else but Connectable, this method does nothing.

Declaration
void Connect()

Disconnect()

Disconnects this connector.

Declaration
void Disconnect()

ToggleConnect()

Toggles between Connected and Unconnected, depending on the current status. Another connector must be in range for this method to have any effect.

Declaration
void ToggleConnect()

Extension Methods