Public Member Functions | |
| Vector3D | GetNaturalGravity () |
| Gets the detected natural gravity vector and power at the current location. More... | |
| Vector3D | GetArtificialGravity () |
| Gets the detected artificial gravity vector and power at the current location. More... | |
| Vector3D | GetTotalGravity () |
| Gets the total accumulated gravity vector and power at the current location, taking both natural and artificial gravity into account. More... | |
| double | GetShipSpeed () |
| Gets the basic ship speed in meters per second, for when you just need to know how fast you're going. More... | |
| MyShipVelocities | 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. More... | |
| MyShipMass | CalculateShipMass () |
| Gets information about the current mass of the ship. More... | |
| bool | TryGetPlanetPosition (out Vector3D position) |
| 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. More... | |
| bool | TryGetPlanetElevation (MyPlanetElevation detail, out double elevation) |
| 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. More... | |
 Public Member Functions inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock | |
| bool | HasLocalPlayerAccess () |
| bool | HasPlayerAccess (long playerId) |
| void | SetCustomName (string text) |
| void | SetCustomName (StringBuilder text) |
| void | GetActions (List< Sandbox.ModAPI.Interfaces.ITerminalAction > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool > collect=null) |
| void | SearchActionsOfName (string name, List< Sandbox.ModAPI.Interfaces.ITerminalAction > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool > collect=null) |
| Sandbox.ModAPI.Interfaces.ITerminalAction | GetActionWithName (string name) |
| Sandbox.ModAPI.Interfaces.ITerminalProperty | GetProperty (string id) |
| void | GetProperties (List< Sandbox.ModAPI.Interfaces.ITerminalProperty > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalProperty, bool > collect=null) |
| bool | HasLocalPlayerAccess () |
| bool | HasPlayerAccess (long playerId) |
| void | RequestShowOnHUD (bool enable) |
| void | SetCustomName (string text) |
| void | SetCustomName (StringBuilder text) |
| void | GetActions (List< Sandbox.ModAPI.Interfaces.ITerminalAction > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool > collect=null) |
| Public Member Functions inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock | |
| string | GetOwnerFactionTag () |
| Sandbox.Common.MyRelationsBetweenPlayerAndBlock | GetPlayerRelationToOwner () |
| Sandbox.Common.MyRelationsBetweenPlayerAndBlock | GetUserRelationToOwner (long playerId) |
| void | UpdateIsWorking () |
| void | UpdateVisual () |
Properties | |
| bool | IsUnderControl [get] |
| Indicates whether a block is locally or remotely controlled. More... | |
| bool | ControlWheels [get] |
| Indicates whether wheels are being controlled by this controller. More... | |
| bool | ControlThrusters [get] |
| Indicates whether thrusters are being controlled by this controller. More... | |
| bool | HandBrake [get] |
| Indicates the current state of the handbrake. More... | |
| bool | DampenersOverride [get] |
| Indicates whether dampeners are currently enabled. More... | |
| Vector3 | MoveIndicator [get] |
| Directional input from user/autopilot. Values can be very large with high controller sensitivity More... | |
| Vector2 | RotationIndicator [get] |
| Pitch, yaw input from user/autopilot. Values can be very large with high controller sensitivity More... | |
| float | RollIndicator [get] |
| Roll input from user/autopilot. Values can be very large with high controller sensitivity More... | |
| Properties inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock | |
| string | CustomName [get] |
| string | CustomNameWithFaction [get] |
| string | DetailedInfo [get] |
| string | CustomInfo [get] |
| string | CustomData [get, set] |
| Gets or sets the Custom Data string. NOTE: Only use this for user input. For storing large mod configs, create your own MyModStorageComponent More... | |
| bool | ShowOnHUD [get] |
| Properties inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock | |
| Sandbox.Common.ObjectBuilders.Definitions.SerializableDefinitionId | BlockDefinition [get] |
| bool | CheckConnectionAllowed [get] |
| IMyCubeGrid | CubeGrid [get] |
| String | DefinitionDisplayNameText [get] |
| float | DisassembleRatio [get] |
| String | DisplayNameText [get] |
| bool | IsBeingHacked [get] |
| bool | IsFunctional [get] |
| bool | IsWorking [get] |
| VRageMath.Vector3I | Max [get] |
| VRageMath.Vector3I | Min [get] |
| int | NumberInGrid [get] |
| VRageMath.MyBlockOrientation | Orientation [get] |
| long | OwnerId [get] |
| VRageMath.Vector3I | Position [get] |
Additional Inherited Members | |
| Events inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock | |
| Action< IMyTerminalBlock > | CustomNameChanged |
| Action< IMyTerminalBlock > | OwnershipChanged |
| Action< IMyTerminalBlock > | PropertiesChanged |
| Action< IMyTerminalBlock > | ShowOnHUDChanged |
| Action< IMyTerminalBlock > | VisibilityChanged |
| Events inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock | |
| Action< IMyCubeBlock > | IsWorkingChanged |
Detailed Description
Definition at line 65 of file IMyShipController.cs.
Member Function Documentation
| MyShipMass Sandbox.ModAPI.Ingame.IMyShipController.CalculateShipMass | ( | ) |
Gets information about the current mass of the ship.
- Returns
Implemented in Sandbox.Game.Entities.MyShipController.
| Vector3D Sandbox.ModAPI.Ingame.IMyShipController.GetArtificialGravity | ( | ) |
Gets the detected artificial gravity vector and power at the current location.
- Returns
Implemented in Sandbox.Game.Entities.MyShipController.
| Vector3D Sandbox.ModAPI.Ingame.IMyShipController.GetNaturalGravity | ( | ) |
Gets the detected natural gravity vector and power at the current location.
- Returns
Implemented in Sandbox.Game.Entities.MyRemoteControl, and Sandbox.Game.Entities.MyShipController.
| double Sandbox.ModAPI.Ingame.IMyShipController.GetShipSpeed | ( | ) |
Gets the basic ship speed in meters per second, for when you just need to know how fast you're going.
- Returns
| MyShipVelocities Sandbox.ModAPI.Ingame.IMyShipController.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.
| Vector3D Sandbox.ModAPI.Ingame.IMyShipController.GetTotalGravity | ( | ) |
Gets the total accumulated gravity vector and power at the current location, taking both natural and artificial gravity into account.
- Returns
Implemented in Sandbox.Game.Entities.MyShipController.
| bool Sandbox.ModAPI.Ingame.IMyShipController.TryGetPlanetElevation | ( | MyPlanetElevation | detail, |
| out double | elevation | ||
| ) |
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.
- Parameters
-
detail elevation
- Returns
| bool Sandbox.ModAPI.Ingame.IMyShipController.TryGetPlanetPosition | ( | out Vector3D | position | ) |
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.
- Parameters
-
position
- Returns
Property Documentation
|
get |
Indicates whether thrusters are being controlled by this controller.
Definition at line 80 of file IMyShipController.cs.
|
get |
Indicates whether wheels are being controlled by this controller.
Definition at line 75 of file IMyShipController.cs.
|
get |
Indicates whether dampeners are currently enabled.
Definition at line 90 of file IMyShipController.cs.
|
get |
Indicates the current state of the handbrake.
Definition at line 85 of file IMyShipController.cs.
|
get |
Indicates whether a block is locally or remotely controlled.
Definition at line 70 of file IMyShipController.cs.
|
get |
Directional input from user/autopilot. Values can be very large with high controller sensitivity
Definition at line 149 of file IMyShipController.cs.
|
get |
Roll input from user/autopilot. Values can be very large with high controller sensitivity
Definition at line 159 of file IMyShipController.cs.
|
get |
Pitch, yaw input from user/autopilot. Values can be very large with high controller sensitivity
Definition at line 154 of file IMyShipController.cs.
The documentation for this interface was generated from the following file:
- Sources/Sandbox.Common/ModAPI/Ingame/IMyShipController.cs
