Skip to content
This repository was archived by the owner on Dec 13, 2025. It is now read-only.

Sandbox.ModAPI.Ingame.IMyRemoteControl

Malware edited this page Dec 21, 2018 · 63 revisions

Index

IMyRemoteControl Interface

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

Properties

Member Description
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

Member Description
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&nbsp;GetWaypointInfo(List<MyWaypointInfo>&nbsp;waypoints) Gets basic information about the currently configured waypoints.
void&nbsp;AddWaypoint(Vector3D&nbsp;coords,&nbsp;string&nbsp;name) Adds a new waypoint.
void&nbsp;AddWaypoint(MyWaypointInfo&nbsp;coords) Adds a new waypoint.
void&nbsp;SetAutoPilotEnabled(bool&nbsp;enabled) Enables or disables the autopilot.
void&nbsp;SetCollisionAvoidance(bool&nbsp;enabled) Enables or disables collision avoidance.
void&nbsp;SetDockingMode(bool&nbsp;enabled) Enables or disables docking mode.
IMyInventory&nbsp;GetInventory() Simply get the MyInventoryBase component stored in this entity.

Inherited from IMyEntity
IMyInventory&nbsp;GetInventory(int&nbsp;index) Search for inventory component with maching index.

Inherited from IMyEntity
Vector3D&nbsp;GetPosition() Inherited from IMyEntity
string&nbsp;GetOwnerFactionTag() Tag of faction owning block

Inherited from IMyCubeBlock
MyRelationsBetweenPlayerAndBlock&nbsp;GetPlayerRelationToOwner() Inherited from IMyCubeBlock
MyRelationsBetweenPlayerAndBlock&nbsp;GetUserRelationToOwner(long&nbsp;playerId) Inherited from IMyCubeBlock
void&nbsp;UpdateIsWorking() Inherited from IMyCubeBlock
void&nbsp;UpdateVisual() Inherited from IMyCubeBlock
bool&nbsp;HasLocalPlayerAccess() Inherited from IMyTerminalBlock
bool&nbsp;HasPlayerAccess(long&nbsp;playerId) Inherited from IMyTerminalBlock
void&nbsp;SetCustomName(string&nbsp;text) Inherited from IMyTerminalBlock
void&nbsp;SetCustomName(StringBuilder&nbsp;text) Inherited from IMyTerminalBlock
void&nbsp;GetActions(List<ITerminalAction>&nbsp;resultList,&nbsp;Func<ITerminalAction,&nbsp;bool>&nbsp;collect) Inherited from IMyTerminalBlock
void&nbsp;SearchActionsOfName(string&nbsp;name,&nbsp;List<ITerminalAction>&nbsp;resultList,&nbsp;Func<ITerminalAction,&nbsp;bool>&nbsp;collect) Inherited from IMyTerminalBlock
ITerminalAction&nbsp;GetActionWithName(string&nbsp;name) Inherited from IMyTerminalBlock
ITerminalProperty&nbsp;GetProperty(string&nbsp;id) Inherited from IMyTerminalBlock
void&nbsp;GetProperties(List<ITerminalProperty>&nbsp;resultList,&nbsp;Func<ITerminalProperty,&nbsp;bool>&nbsp;collect) Inherited from IMyTerminalBlock
bool&nbsp;IsSameConstructAs(IMyTerminalBlock&nbsp;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&nbsp;GetNaturalGravity() Gets the detected natural gravity vector and power at the current location.

Inherited from IMyShipController
Vector3D&nbsp;GetArtificialGravity() Gets the detected artificial gravity vector and power at the current location.

Inherited from IMyShipController
Vector3D&nbsp;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&nbsp;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&nbsp;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&nbsp;CalculateShipMass() Gets information about the current mass of the ship.

Inherited from IMyShipController
bool&nbsp;TryGetPlanetPosition(ref&nbsp;Vector3D&nbsp;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&nbsp;TryGetPlanetElevation(MyPlanetElevation&nbsp;detail,&nbsp;ref&nbsp;double&nbsp;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

Clone this wiki locally