Sandbox.ModAPI.Ingame.IMyRemoteControl

IMyRemoteControl Interface

Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common.dll
Implements:

Properties

_`bool IsAutoPilotEnabled`_	Determines whether the autopilot is currently enabled.
_`float SpeedLimit`_	Gets or sets the autopilot speed limit
_`FlightMode FlightMode`_	Gets or sets the current flight mode
_`Direction Direction`_	Gets or sets the current flight direction
_`MyWaypointInfo CurrentWaypoint`_	Gets the current target waypoint
_`MyEntityComponentContainer Components`_	_Inherited from `IMyEntity`_
_`long EntityId`_	_Inherited from `IMyEntity`_
_`string Name`_	_Inherited from `IMyEntity`_
_`string DisplayName`_	_Inherited from `IMyEntity`_
_`bool HasInventory`_	Returns true if this entity has got at least one inventory. Note that one aggregate inventory can contain zero simple inventories => zero will be returned even if GetInventory() != null. _Inherited from `IMyEntity`_
_`int InventoryCount`_	Returns the count of the number of inventories this entity has. _Inherited from `IMyEntity`_
_`BoundingBoxD WorldAABB`_	_Inherited from `IMyEntity`_
_`BoundingBoxD WorldAABBHr`_	_Inherited from `IMyEntity`_
_`MatrixD WorldMatrix`_	_Inherited from `IMyEntity`_
_`BoundingSphereD WorldVolume`_	_Inherited from `IMyEntity`_
_`BoundingSphereD WorldVolumeHr`_	_Inherited from `IMyEntity`_
_`SerializableDefinitionId BlockDefinition`_	_Inherited from `IMyCubeBlock`_
_`bool CheckConnectionAllowed`_	_Inherited from `IMyCubeBlock`_
_`IMyCubeGrid CubeGrid`_	Grid in which the block is placed _Inherited from `IMyCubeBlock`_
_`string DefinitionDisplayNameText`_	Definition name _Inherited from `IMyCubeBlock`_
_`float DisassembleRatio`_	Is set in definition Ratio at which is the block disassembled (grinding) _Inherited from `IMyCubeBlock`_
_`string DisplayNameText`_	Translated block name _Inherited from `IMyCubeBlock`_
_`bool IsBeingHacked`_	Hacking of the block is in progress _Inherited from `IMyCubeBlock`_
_`bool IsFunctional`_	True if integrity is above breaking threshold _Inherited from `IMyCubeBlock`_
_`bool IsWorking`_	True if block is able to do its work depening on block type (is functional, powered, enabled, etc...) _Inherited from `IMyCubeBlock`_
_`Vector3I Max`_	Maximum coordinates of grid cells occupied by this block _Inherited from `IMyCubeBlock`_
_`float Mass`_	Block mass _Inherited from `IMyCubeBlock`_
_`Vector3I Min`_	Minimum coordinates of grid cells occupied by this block _Inherited from `IMyCubeBlock`_
_`int NumberInGrid`_	Order in which were the blocks of same type added to grid Used in default display name _Inherited from `IMyCubeBlock`_
_`MyBlockOrientation Orientation`_	Returns block orientation in base 6 directions _Inherited from `IMyCubeBlock`_
_`long OwnerId`_	Id of player owning block (not steam Id) _Inherited from `IMyCubeBlock`_
_`Vector3I Position`_	Position in grid coordinates _Inherited from `IMyCubeBlock`_
_`string CustomName`_	_Inherited from `IMyTerminalBlock`_
_`string CustomNameWithFaction`_	_Inherited from `IMyTerminalBlock`_
_`string DetailedInfo`_	_Inherited from `IMyTerminalBlock`_
_`string CustomInfo`_	_Inherited from `IMyTerminalBlock`_
_`string 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`_
_`bool ShowOnHUD`_	_Inherited from `IMyTerminalBlock`_
_`bool ShowInTerminal`_	_Inherited from `IMyTerminalBlock`_
_`bool ShowInToolbarConfig`_	_Inherited from `IMyTerminalBlock`_
_`bool ShowInInventory`_	_Inherited from `IMyTerminalBlock`_
_`bool CanControlShip`_	Determines whether this specific ship controller is capable of controlling the ship it's installed on. _Inherited from `IMyShipController`_
_`bool IsUnderControl`_	Indicates whether a block is locally or remotely controlled. _Inherited from `IMyShipController`_
_`bool HasWheels`_	Determines whether there are any wheels on this ship. _Inherited from `IMyShipController`_
_`bool ControlWheels`_	Gets or sets whether wheels are being controlled by this controller. _Inherited from `IMyShipController`_
_`bool ControlThrusters`_	Gets or sets whether thrusters are being controlled by this controller. _Inherited from `IMyShipController`_
_`bool HandBrake`_	Gets or sets the current state of the handbrake. _Inherited from `IMyShipController`_
_`bool DampenersOverride`_	Gets or sets whether dampeners are currently enabled. _Inherited from `IMyShipController`_
_`bool ShowHorizonIndicator`_	Gets or sets whether the horizon indicator should be displayed for this block. _Inherited from `IMyShipController`_
_`Vector3 MoveIndicator`_	Directional input from user/autopilot. Values can be very large with high controller sensitivity _Inherited from `IMyShipController`_
_`Vector2 RotationIndicator`_	Pitch, yaw input from user/autopilot. Values can be very large with high controller sensitivity _Inherited from `IMyShipController`_
_`float RollIndicator`_	Roll input from user/autopilot. Values can be very large with high controller sensitivity _Inherited from `IMyShipController`_
_`Vector3D CenterOfMass`_	Center of mass in world coordinates _Inherited from `IMyShipController`_
_`bool IsMainCockpit`_	Gets or sets if this controller is the main one. _Inherited from `IMyShipController`_

### Methods

_`bool GetNearestPlayer(ref Vector3D playerPosition)`_	Gets the nearest player's position. Will only work if the remote control belongs to an NPC
_`void ClearWaypoints()`_	Removes all existing waypoints.
_`void GetWaypointInfo(List waypoints)`_	Gets basic information about the currently configured waypoints.
_`void AddWaypoint(Vector3D coords, string name)`_	Adds a new waypoint.
_`void AddWaypoint(MyWaypointInfo coords)`_	Adds a new waypoint.
_`void SetAutoPilotEnabled(bool enabled)`_	Enables or disables the autopilot.
_`void SetCollisionAvoidance(bool enabled)`_	Enables or disables collision avoidance.
_`void SetDockingMode(bool enabled)`_	Enables or disables docking mode.
_`IMyInventory GetInventory()`_	Simply get the MyInventoryBase component stored in this entity. _Inherited from `IMyEntity`_
_`IMyInventory GetInventory(int index)`_	Search for inventory component with maching index. _Inherited from `IMyEntity`_
_`Vector3D GetPosition()`_	_Inherited from `IMyEntity`_
_`string GetOwnerFactionTag()`_	Tag of faction owning block _Inherited from `IMyCubeBlock`_
_`MyRelationsBetweenPlayerAndBlock GetPlayerRelationToOwner()`_	_Inherited from `IMyCubeBlock`_
_`MyRelationsBetweenPlayerAndBlock GetUserRelationToOwner(long playerId)`_	_Inherited from `IMyCubeBlock`_
_`void UpdateIsWorking()`_	_Inherited from `IMyCubeBlock`_
_`void UpdateVisual()`_	_Inherited from `IMyCubeBlock`_
_`bool HasLocalPlayerAccess()`_	_Inherited from `IMyTerminalBlock`_
_`bool HasPlayerAccess(long playerId)`_	_Inherited from `IMyTerminalBlock`_
_`void SetCustomName(string text)`_	_Inherited from `IMyTerminalBlock`_
_`void SetCustomName(StringBuilder text)`_	_Inherited from `IMyTerminalBlock`_
_`void GetActions(List resultList, Func collect)`_	_Inherited from `IMyTerminalBlock`_
_`void SearchActionsOfName(string name, List resultList, Func collect)`_	_Inherited from `IMyTerminalBlock`_
_`ITerminalAction GetActionWithName(string name)`_	_Inherited from `IMyTerminalBlock`_
_`ITerminalProperty GetProperty(string id)`_	_Inherited from `IMyTerminalBlock`_
_`void GetProperties(List resultList, Func collect)`_	_Inherited from `IMyTerminalBlock`_
_`bool IsSameConstructAs(IMyTerminalBlock other)`_	Determines whether this block is mechanically connected to the other. This is any block connected with rotors or pistons or other mechanical devices, but not things like connectors. This will in most cases constitute your complete construct. Be aware that using merge blocks combines grids into one, so this function will not filter out grids connected that way. Also be aware that detaching the heads of pistons and rotors will cause this connection to change. _Inherited from `IMyTerminalBlock`_
_`Vector3D GetNaturalGravity()`_	Gets the detected natural gravity vector and power at the current location. _Inherited from `IMyShipController`_
_`Vector3D GetArtificialGravity()`_	Gets the detected artificial gravity vector and power at the current location. _Inherited from `IMyShipController`_
_`Vector3D GetTotalGravity()`_	Gets the total accumulated gravity vector and power at the current location, taking both natural and artificial gravity into account. _Inherited from `IMyShipController`_
_`double GetShipSpeed()`_	Gets the basic ship speed in meters per second, for when you just need to know how fast you're going. _Inherited from `IMyShipController`_
_`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. _Inherited from `IMyShipController`_
_`MyShipMass CalculateShipMass()`_	Gets information about the current mass of the ship. _Inherited from `IMyShipController`_
_`bool TryGetPlanetPosition(ref 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. _Inherited from `IMyShipController`_
_`bool TryGetPlanetElevation(MyPlanetElevation detail, ref 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. _Inherited from `IMyShipController`_

Do you have questions, comments, suggestions for improvements? Is there something I can do better? Did I make a mistake? Please add an issue here, and prefix your issue title with Wiki. Thank you, your help will be very appreciated!

Sandbox.ModAPI.Ingame.IMyRemoteControl

IMyRemoteControl Interface

Properties

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!