| IMyShipController Interface |
[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)
SyntaxThe IMyShipController type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | CalculateShipMass |
Gets information about the current mass of the ship.
|
| GetActions | (Inherited from IMyTerminalBlock.) |
| GetActionWithName | (Inherited from IMyTerminalBlock.) |
| GetArtificialGravity |
Gets the detected artificial gravity vector and power at the current location.
|
| GetInventory | (Inherited from IMyEntity.) |
| GetInventory(Int32) | (Inherited from IMyEntity.) |
| GetNaturalGravity |
Gets the detected natural gravity vector and power at the current location.
|
| GetOwnerFactionTag | (Inherited from IMyCubeBlock.) |
| GetPlayerRelationToOwner | Obsolete. (Inherited from IMyCubeBlock.) |
| GetPosition | (Inherited from IMyEntity.) |
| GetProperties | (Inherited from IMyTerminalBlock.) |
| GetProperty | (Inherited from IMyTerminalBlock.) |
| GetShipSpeed |
Gets the basic ship speed in meters per second, for when you just need to know how fast you're going.
|
| GetShipVelocities |
Determines the linear velocities in meters per second and angular velocities in radians per second.
Provides a more accurate representation of the directions and axis speeds.
|
| GetTotalGravity |
Gets the total accumulated gravity vector and power at the current location,
taking both natural and artificial gravity into account.
|
| GetUserRelationToOwner | (Inherited from IMyCubeBlock.) |
| HasLocalPlayerAccess | (Inherited from IMyTerminalBlock.) |
| HasPlayerAccess | (Inherited from IMyTerminalBlock.) |
| SearchActionsOfName | (Inherited from IMyTerminalBlock.) |
| SetCustomName(String) | Obsolete. (Inherited from IMyTerminalBlock.) |
| SetCustomName(StringBuilder) | Obsolete. (Inherited from IMyTerminalBlock.) |
| TryGetPlanetElevation |
Attempts to get the elevation of the ship in relation to the nearest planet. This method is only available
when a ship is within the gravity well of a planet.
|
| TryGetPlanetPosition |
Attempts to get the world position of the nearest planet. This method is only available when a ship is
within the gravity well of a planet.
|
| UpdateIsWorking | Obsolete. (Inherited from IMyCubeBlock.) |
| UpdateVisual | Obsolete. (Inherited from IMyCubeBlock.) |
Extension MethodsTop
Properties| Name | Description | |
|---|---|---|
 | BlockDefinition | (Inherited from IMyCubeBlock.) |
| CanControlShip |
Determines whether this specific ship controller is capable of controlling the ship it's installed on.
|
| CenterOfMass |
Center of mass in world coordinates
|
| CheckConnectionAllowed | (Inherited from IMyCubeBlock.) |
| Components | (Inherited from IMyEntity.) |
| ControlThrusters |
Gets or sets whether thrusters are being controlled by this controller.
|
| ControlWheels |
Gets or sets whether wheels are being controlled by this controller.
|
| 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.) |
| DampenersOverride |
Gets or sets whether dampeners are currently enabled.
|
| DefinitionDisplayNameText | (Inherited from IMyCubeBlock.) |
| DetailedInfo | (Inherited from IMyTerminalBlock.) |
| DisassembleRatio | (Inherited from IMyCubeBlock.) |
| DisplayName | (Inherited from IMyEntity.) |
| DisplayNameText | (Inherited from IMyCubeBlock.) |
| EntityId | (Inherited from IMyEntity.) |
| HandBrake |
Gets or sets the current state of the handbrake.
|
| HasInventory | (Inherited from IMyEntity.) |
| HasWheels |
Determines whether there are any wheels on this ship.
|
| InventoryCount | (Inherited from IMyEntity.) |
| IsBeingHacked | (Inherited from IMyCubeBlock.) |
| IsFunctional | (Inherited from IMyCubeBlock.) |
| IsUnderControl |
Indicates whether a block is locally or remotely controlled.
|
| IsWorking | (Inherited from IMyCubeBlock.) |
| Mass | (Inherited from IMyCubeBlock.) |
| Max | (Inherited from IMyCubeBlock.) |
| Min | (Inherited from IMyCubeBlock.) |
| MoveIndicator |
Directional input from user/autopilot. Values can be very large with high controller sensitivity
|
| Name | (Inherited from IMyEntity.) |
| NumberInGrid | (Inherited from IMyCubeBlock.) |
| Orientation | (Inherited from IMyCubeBlock.) |
| OwnerId | (Inherited from IMyCubeBlock.) |
| Position | (Inherited from IMyCubeBlock.) |
| RollIndicator |
Roll input from user/autopilot. Values can be very large with high controller sensitivity
|
| RotationIndicator |
Pitch, yaw input from user/autopilot. Values can be very large with high controller sensitivity
|
| ShowHorizonIndicator |
Gets or sets whether the horizon indicator should be displayed for this block.
|
| ShowInTerminal | (Inherited from IMyTerminalBlock.) |
| ShowInToolbarConfig | (Inherited from IMyTerminalBlock.) |
| ShowOnHUD | (Inherited from IMyTerminalBlock.) |
| WorldAABB | (Inherited from IMyEntity.) |
| WorldAABBHr | (Inherited from IMyEntity.) |
| WorldMatrix | (Inherited from IMyEntity.) |
| WorldVolume | (Inherited from IMyEntity.) |
| WorldVolumeHr | (Inherited from IMyEntity.) |
See Also