Click or drag to resize
IMyRemoteControl 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
public interface IMyRemoteControl : IMyShipController, 
	IMyTerminalBlock, IMyCubeBlock, IMyEntity

The IMyRemoteControl type exposes the following members.

Methods
  NameDescription
Public methodAddWaypoint
Adds a new waypoint.
Public methodCalculateShipMass
Gets information about the current mass of the ship.
(Inherited from IMyShipController.)
Public methodClearWaypoints
Removes all existing waypoints.
Public methodGetActions (Inherited from IMyTerminalBlock.)
Public methodGetActionWithName (Inherited from IMyTerminalBlock.)
Public methodGetArtificialGravity
Gets the detected artificial gravity vector and power at the current location.
(Inherited from IMyShipController.)
Public methodGetInventory (Inherited from IMyEntity.)
Public methodGetInventory(Int32) (Inherited from IMyEntity.)
Public methodGetNaturalGravity
Gets the detected natural gravity vector and power at the current location.
(Inherited from IMyShipController.)
Public methodGetNearestPlayer
Gets the nearest player's position. Will only work if the remote control belongs to an NPC
Public methodGetOwnerFactionTag (Inherited from IMyCubeBlock.)
Public methodGetPlayerRelationToOwner Obsolete. (Inherited from IMyCubeBlock.)
Public methodGetPosition (Inherited from IMyEntity.)
Public methodGetProperties (Inherited from IMyTerminalBlock.)
Public methodGetProperty (Inherited from IMyTerminalBlock.)
Public methodGetShipSpeed
Gets the basic ship speed in meters per second, for when you just need to know how fast you're going.
(Inherited from IMyShipController.)
Public methodGetShipVelocities
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.
(Inherited from IMyShipController.)
Public methodGetTotalGravity
Gets the total accumulated gravity vector and power at the current location, taking both natural and artificial gravity into account.
(Inherited from IMyShipController.)
Public methodGetUserRelationToOwner (Inherited from IMyCubeBlock.)
Public methodGetWaypointInfo
Gets basic information about the currently configured waypoints.
Public methodHasLocalPlayerAccess (Inherited from IMyTerminalBlock.)
Public methodHasPlayerAccess (Inherited from IMyTerminalBlock.)
Public methodSearchActionsOfName (Inherited from IMyTerminalBlock.)
Public methodSetAutoPilotEnabled
Enables or disables the autopilot.
Public methodSetCustomName(String) Obsolete. (Inherited from IMyTerminalBlock.)
Public methodSetCustomName(StringBuilder) Obsolete. (Inherited from IMyTerminalBlock.)
Public methodTryGetPlanetElevation
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.
(Inherited from IMyShipController.)
Public methodTryGetPlanetPosition
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.
(Inherited from IMyShipController.)
Public methodUpdateIsWorking Obsolete. (Inherited from IMyCubeBlock.)
Public methodUpdateVisual Obsolete. (Inherited from IMyCubeBlock.)
Top
Extension Methods
  NameDescription
Public Extension MethodApplyAction(String)Overloaded. (Defined by TerminalBlockExtentions.)
Public Extension MethodApplyAction(String, ListTerminalActionParameter)Overloaded. (Defined by TerminalBlockExtentions.)
Public Extension MethodGetDefaultValueT
Returns default value of specified property as TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetId (Defined by TerminalBlockExtentions.)
Public Extension MethodGetInventoryCount (Defined by TerminalBlockExtentions.)
Public Extension MethodGetMaximumT
Returns maximum value of specified property as TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetMinimumT
Returns minimum value of specified property as TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetMininumT (Defined by TerminalPropertyExtensions.)
Public Extension MethodGetUseConveyorSystem (Defined by TerminalBlockExtentions.)
Public Extension MethodGetValueT
Returns value of specified property as TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetValueBool
Returns value of specified property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetValueColor
Returns value of specified property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetValueFloat
Returns value of specified property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodHasAction (Defined by TerminalBlockExtentions.)
Public Extension MethodHasInventory (Defined by TerminalBlockExtentions.)
Public Extension MethodSetUseConveyorSystem (Defined by TerminalBlockExtentions.)
Public Extension MethodSetValueT
Set value of property with type of TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodSetValueBool
Set bool value of property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodSetValueColor
Set bool value of property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodSetValueFloat
Set float value of property
(Defined by TerminalPropertyExtensions.)
Top
Properties
  NameDescription
Public propertyBlockDefinition (Inherited from IMyCubeBlock.)
Public propertyCanControlShip
Determines whether this specific ship controller is capable of controlling the ship it's installed on.
(Inherited from IMyShipController.)
Public propertyCenterOfMass
Center of mass in world coordinates
(Inherited from IMyShipController.)
Public propertyCheckConnectionAllowed (Inherited from IMyCubeBlock.)
Public propertyComponents (Inherited from IMyEntity.)
Public propertyControlThrusters
Gets or sets whether thrusters are being controlled by this controller.
(Inherited from IMyShipController.)
Public propertyControlWheels
Gets or sets whether wheels are being controlled by this controller.
(Inherited from IMyShipController.)
Public propertyCubeGrid (Inherited from IMyCubeBlock.)
Public propertyCustomData
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.)
Public propertyCustomInfo (Inherited from IMyTerminalBlock.)
Public propertyCustomName (Inherited from IMyTerminalBlock.)
Public propertyCustomNameWithFaction (Inherited from IMyTerminalBlock.)
Public propertyDampenersOverride
Gets or sets whether dampeners are currently enabled.
(Inherited from IMyShipController.)
Public propertyDefinitionDisplayNameText (Inherited from IMyCubeBlock.)
Public propertyDetailedInfo (Inherited from IMyTerminalBlock.)
Public propertyDisassembleRatio (Inherited from IMyCubeBlock.)
Public propertyDisplayName (Inherited from IMyEntity.)
Public propertyDisplayNameText (Inherited from IMyCubeBlock.)
Public propertyEntityId (Inherited from IMyEntity.)
Public propertyHandBrake
Gets or sets the current state of the handbrake.
(Inherited from IMyShipController.)
Public propertyHasInventory (Inherited from IMyEntity.)
Public propertyHasWheels
Determines whether there are any wheels on this ship.
(Inherited from IMyShipController.)
Public propertyInventoryCount (Inherited from IMyEntity.)
Public propertyIsAutoPilotEnabled
Determines whether the autopilot is currently enabled.
Public propertyIsBeingHacked (Inherited from IMyCubeBlock.)
Public propertyIsFunctional (Inherited from IMyCubeBlock.)
Public propertyIsUnderControl
Indicates whether a block is locally or remotely controlled.
(Inherited from IMyShipController.)
Public propertyIsWorking (Inherited from IMyCubeBlock.)
Public propertyMass (Inherited from IMyCubeBlock.)
Public propertyMax (Inherited from IMyCubeBlock.)
Public propertyMin (Inherited from IMyCubeBlock.)
Public propertyMoveIndicator
Directional input from user/autopilot. Values can be very large with high controller sensitivity
(Inherited from IMyShipController.)
Public propertyName (Inherited from IMyEntity.)
Public propertyNumberInGrid (Inherited from IMyCubeBlock.)
Public propertyOrientation (Inherited from IMyCubeBlock.)
Public propertyOwnerId (Inherited from IMyCubeBlock.)
Public propertyPosition (Inherited from IMyCubeBlock.)
Public propertyRollIndicator
Roll input from user/autopilot. Values can be very large with high controller sensitivity
(Inherited from IMyShipController.)
Public propertyRotationIndicator
Pitch, yaw input from user/autopilot. Values can be very large with high controller sensitivity
(Inherited from IMyShipController.)
Public propertyShowHorizonIndicator
Gets or sets whether the horizon indicator should be displayed for this block.
(Inherited from IMyShipController.)
Public propertyShowInTerminal (Inherited from IMyTerminalBlock.)
Public propertyShowInToolbarConfig (Inherited from IMyTerminalBlock.)
Public propertyShowOnHUD (Inherited from IMyTerminalBlock.)
Public propertyWorldAABB (Inherited from IMyEntity.)
Public propertyWorldAABBHr (Inherited from IMyEntity.)
Public propertyWorldMatrix (Inherited from IMyEntity.)
Public propertyWorldVolume (Inherited from IMyEntity.)
Public propertyWorldVolumeHr (Inherited from IMyEntity.)
Top
See Also