Click or drag to resize
IMyShipController Interface
v01.180.0 (Beta)

[This is preliminary documentation and is subject to change.]

Namespace: Sandbox.ModAPI
Assembly: Sandbox.Common (in Sandbox.Common.dll) Version: (
public interface IMyShipController : IMyTerminalBlock, 
	IMyCubeBlock, IMyEntity, IMyShipController, IMyTerminalBlock, IMyCubeBlock, 
	IMyEntity, IMyControllableEntity

The IMyShipController type exposes the following members.

Public methodAddToGamePruningStructure Obsolete. (Inherited from IMyEntity.)
Public methodAddUpgradeValue (Inherited from IMyCubeBlock.)
Public methodBeforeSave (Inherited from IMyEntity.)
Public methodCalcLocalMatrix (Inherited from IMyCubeBlock.)
Public methodCalculateCurrentModel (Inherited from IMyCubeBlock.)
Public methodCalculateShipMass
Gets information about the current mass of the ship.
(Inherited from IMyShipController.)
Public methodClose (Inherited from IMyEntity.)
Public methodCrouch (Inherited from IMyControllableEntity.)
Public methodDebugDraw (Inherited from IMyCubeBlock.)
Public methodDebugDrawInvalidTriangles (Inherited from IMyEntity.)
Public methodDelete (Inherited from IMyEntity.)
Public methodDie (Inherited from IMyControllableEntity.)
Public methodDoOverlapSphereTest (Inherited from IMyEntity.)
Public methodDown (Inherited from IMyControllableEntity.)
Public methodDrawHud (Inherited from IMyControllableEntity.)
Public methodEnableColorMaskForSubparts (Inherited from IMyEntity.)
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 method[M:VRage.ModAPI.IMyEntity.GetChildren(System.Collections.Generic.List{VRage.ModAPI.IMyEntity},System.Func`2)] (Inherited from IMyEntity.)
Public methodGetDiffuseColor (Inherited from IMyEntity.)
Public methodGetDistanceBetweenCameraAndBoundingSphere (Inherited from IMyEntity.)
Public methodGetDistanceBetweenCameraAndPosition (Inherited from IMyEntity.)
Public methodGetFriendlyName (Inherited from IMyEntity.)
Public methodGetHeadMatrix (Inherited from IMyControllableEntity.)
Public methodGetIntersectionWithLine (Inherited from IMyEntity.)
Public methodGetIntersectionWithLineAndBoundingSphere (Inherited from IMyEntity.)
Public methodGetIntersectionWithSphere (Inherited from IMyEntity.)
Public methodGetInventory (Inherited from IMyEntity.)
Public methodGetInventory(Int32) (Inherited from IMyEntity.)
Public methodGetLargestDistanceBetweenCameraAndBoundingSphere (Inherited from IMyEntity.)
Public methodGetNaturalGravity
Gets the detected natural gravity vector and power at the current location.
(Inherited from IMyShipController.)
Public methodGetObjectBuilder (Inherited from IMyEntity.)
Public methodGetObjectBuilderCubeBlock (Inherited from IMyCubeBlock.)
Public methodGetOwnerFactionTag (Inherited from IMyCubeBlock.)
Public methodGetPlayerRelationToOwner (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 methodGetSmallestDistanceBetweenCameraAndBoundingSphere (Inherited from IMyEntity.)
Public methodGetSubpart (Inherited from IMyEntity.)
Public methodGetTopMostParent (Inherited from IMyEntity.)
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 methodGetTrianglesIntersectingSphere (Inherited from IMyEntity.)
Public methodGetUserRelationToOwner (Inherited from IMyCubeBlock.)
Public methodGetViewMatrix (Inherited from IMyEntity.)
Public methodGetWorldMatrixNormalizedInv (Inherited from IMyEntity.)
Public methodHasLocalPlayerAccess (Inherited from IMyTerminalBlock.)
Public methodHasPlayerAccess (Inherited from IMyTerminalBlock.)
Public methodInit (Inherited from IMyCubeBlock.)
Public methodInit(MyObjectBuilder_CubeBlock, IMyCubeGrid) (Inherited from IMyCubeBlock.)
Public methodIsVisible (Inherited from IMyEntity.)
Public methodJump (Inherited from IMyControllableEntity.)
Public methodMoveAndRotate (Inherited from IMyControllableEntity.)
Public methodMoveAndRotateStopped (Inherited from IMyControllableEntity.)
Public methodOnAddedToScene (Inherited from IMyEntity.)
Public methodOnBuildSuccess (Inherited from IMyCubeBlock.)
Public methodOnDestroy (Inherited from IMyCubeBlock.)
Public methodOnModelChange (Inherited from IMyCubeBlock.)
Public methodOnRegisteredToGridSystems (Inherited from IMyCubeBlock.)
Public methodOnRemovedByCubeBuilder (Inherited from IMyCubeBlock.)
Public methodOnRemovedFromScene (Inherited from IMyEntity.)
Public methodOnUnregisteredFromGridSystems (Inherited from IMyCubeBlock.)
Public methodPickUp (Inherited from IMyControllableEntity.)
Public methodPickUpContinues (Inherited from IMyControllableEntity.)
Public methodRaycastDetectors (Inherited from IMyCubeBlock.)
Public methodRefreshCustomInfo
Raises AppendingCustomInfo so every subscriber can append custom info.
(Inherited from IMyTerminalBlock.)
Public methodReloadDetectors (Inherited from IMyCubeBlock.)
Public methodRemoveEffect (Inherited from IMyCubeBlock.)
Public methodRemoveFromGamePruningStructure Obsolete. (Inherited from IMyEntity.)
Public methodSearchActionsOfName (Inherited from IMyTerminalBlock.)
Public methodSetColorMaskForSubparts (Inherited from IMyEntity.)
Public methodSetCustomName(String) Obsolete. (Inherited from IMyTerminalBlock.)
Public methodSetCustomName(StringBuilder) Obsolete. (Inherited from IMyTerminalBlock.)
Public methodSetDamageEffect (Inherited from IMyCubeBlock.)
Public methodSetEffect(String, Boolean) (Inherited from IMyCubeBlock.)
Public methodSetEffect(String, Single, Boolean, Boolean, Boolean) (Inherited from IMyCubeBlock.)
Public methodSetEmissiveParts (Inherited from IMyEntity.)
Public methodSetEmissivePartsForSubparts (Inherited from IMyEntity.)
Public methodSetLocalMatrix (Inherited from IMyEntity.)
Public methodSetPosition (Inherited from IMyEntity.)
Public methodSetWorldMatrix (Inherited from IMyEntity.)
Public methodShowInventory (Inherited from IMyControllableEntity.)
Public methodShowTerminal (Inherited from IMyControllableEntity.)
Public methodSwitchDamping (Inherited from IMyControllableEntity.)
Public methodSwitchHelmet (Inherited from IMyControllableEntity.)
Public methodSwitchLeadingGears (Inherited from IMyControllableEntity.)
Public methodSwitchLights (Inherited from IMyControllableEntity.)
Public methodSwitchReactors (Inherited from IMyControllableEntity.)
Public methodSwitchThrusts (Inherited from IMyControllableEntity.)
Public methodSwitchWalk (Inherited from IMyControllableEntity.)
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 methodTryGetSubpart (Inherited from IMyEntity.)
Public methodUp (Inherited from IMyControllableEntity.)
Public methodUpdateGamePruningStructure Obsolete. (Inherited from IMyEntity.)
Public methodUpdateIsWorking (Inherited from IMyCubeBlock.)
Public methodUpdateVisual (Inherited from IMyCubeBlock.)
Public methodUse (Inherited from IMyControllableEntity.)
Public methodUseContinues (Inherited from IMyControllableEntity.)
Extension Methods
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.)
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 propertyCastShadows (Inherited from IMyEntity.)
Public propertyCenterOfMass
Center of mass in world coordinates
(Inherited from IMyShipController.)
Public propertyCheckConnectionAllowed (Inherited from IMyCubeBlock.)
Public propertyClosed (Inherited from IMyEntity.)
Public propertyComponents (Inherited from IMyEntity.)
Public propertyControllerInfo (Inherited from IMyControllableEntity.)
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 propertyDebugAsyncLoading (Inherited from IMyEntity.)
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 propertyEnabledDamping (Inherited from IMyControllableEntity.)
Public propertyEnabledHelmet (Inherited from IMyControllableEntity.)
Public propertyEnabledLeadingGears (Inherited from IMyControllableEntity.)
Public propertyEnabledLights (Inherited from IMyControllableEntity.)
Public propertyEnabledReactors (Inherited from IMyControllableEntity.)
Public propertyEnabledThrusts (Inherited from IMyControllableEntity.)
Public propertyEntity (Inherited from IMyControllableEntity.)
Public propertyEntityId (Inherited from IMyEntity.)
Public propertyFastCastShadowResolve (Inherited from IMyEntity.)
Public propertyFlags (Inherited from IMyEntity.)
Public propertyForceFirstPersonCamera (Inherited from IMyControllableEntity.)
Public propertyGameLogic (Inherited from IMyEntity.)
Public propertyHandBrake
Gets or sets the current state of the handbrake.
(Inherited from IMyShipController.)
Public propertyHasFirstPersonCamera
Gets if this ship controller contains a first-person camera view.
Public propertyHasInventory (Inherited from IMyEntity.)
Public propertyHasWheels
Determines whether there are any wheels on this ship.
(Inherited from IMyShipController.)
Public propertyHierarchy (Inherited from IMyEntity.)
Public propertyInScene (Inherited from IMyEntity.)
Public propertyInvalidateOnMove (Inherited from IMyEntity.)
Public propertyInventoryCount (Inherited from IMyEntity.)
Public propertyIsBeingHacked (Inherited from IMyCubeBlock.)
Public propertyIsCCDForProjectiles Obsolete. (Inherited from IMyEntity.)
Public propertyIsFunctional (Inherited from IMyCubeBlock.)
Public propertyIsShooting
Gets if the ship is shooting selected weapons.
Public propertyIsUnderControl
Indicates whether a block is locally or remotely controlled.
(Inherited from IMyShipController.)
Public propertyIsVolumetric (Inherited from IMyEntity.)
Public propertyIsWorking (Inherited from IMyCubeBlock.)
Public propertyLastPilot
Get the last character that was piloting the controller.
Public propertyLocalAABB (Inherited from IMyEntity.)
Public propertyLocalAABBHr (Inherited from IMyEntity.)
Public propertyLocalMatrix (Inherited from IMyEntity.)
Public propertyLocalVolume (Inherited from IMyEntity.)
Public propertyLocalVolumeOffset (Inherited from IMyEntity.)
Public propertyLocationForHudMarker Obsolete. (Inherited from IMyEntity.)
Public propertyMarkedForClose (Inherited from IMyEntity.)
Public propertyMass (Inherited from IMyCubeBlock.)
Public propertyMax (Inherited from IMyCubeBlock.)
Public propertyMaxGlassDistSq (Inherited from IMyEntity.)
Public propertyMin (Inherited from IMyCubeBlock.)
Public propertyModel (Inherited from IMyEntity.)
Public propertyMoveIndicator
Gets the current movement direction indicator
Public propertyName (Inherited from IMyEntity.)
Public propertyNearFlag (Inherited from IMyEntity.)
Public propertyNeedsDraw (Inherited from IMyEntity.)
Public propertyNeedsDrawFromParent (Inherited from IMyEntity.)
Public propertyNeedsResolveCastShadow (Inherited from IMyEntity.)
Public propertyNeedsUpdate (Inherited from IMyEntity.)
Public propertyNumberInGrid (Inherited from IMyCubeBlock.)
Public propertyOrientation (Inherited from IMyCubeBlock.)
Public propertyOwnerId (Inherited from IMyCubeBlock.)
Public propertyParent (Inherited from IMyEntity.)
Public propertyPersistentFlags (Inherited from IMyEntity.)
Public propertyPhysics (Inherited from IMyEntity.)
Public propertyPilot
Get the character that is currently piloting the controller.
Public propertyPosition (Inherited from IMyCubeBlock.)
Public propertyPositionComp (Inherited from IMyEntity.)
Public propertyPrimaryLookaround (Inherited from IMyControllableEntity.)
Public propertyRender (Inherited from IMyEntity.)
Public propertyResourceSink (Inherited from IMyCubeBlock.)
Public propertyRollIndicator
Gets the current roll direction indicator
Public propertyRotationIndicator
Gets the current rotation direction indicator
Public propertySave (Inherited from IMyEntity.)
Public propertyShadowBoxLod (Inherited from IMyEntity.)
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 propertySkipIfTooSmall (Inherited from IMyEntity.)
Public propertySlimBlock (Inherited from IMyCubeBlock.)
Public propertyStorage (Inherited from IMyEntity.)
Public propertySynchronized (Inherited from IMyEntity.)
Public propertySyncObject (Inherited from IMyEntity.)
Public propertyTransparent (Inherited from IMyEntity.)
Public propertyUpgradeValues (Inherited from IMyCubeBlock.)
Public propertyVisible (Inherited from IMyEntity.)
Public propertyWorldAABB (Inherited from IMyEntity.)
Public propertyWorldAABBHr (Inherited from IMyEntity.)
Public propertyWorldMatrix (Inherited from IMyEntity.)
Public propertyWorldMatrixInvScaled (Inherited from IMyEntity.)
Public propertyWorldMatrixNormalizedInv (Inherited from IMyEntity.)
Public propertyWorldVolume (Inherited from IMyEntity.)
Public propertyWorldVolumeHr (Inherited from IMyEntity.)
Public eventAppendingCustomInfo
Event to append custom info.
(Inherited from IMyTerminalBlock.)
Public eventCustomNameChanged (Inherited from IMyTerminalBlock.)
Public eventIsWorkingChanged (Inherited from IMyCubeBlock.)
Public eventOnClose (Inherited from IMyEntity.)
Public eventOnClosing (Inherited from IMyEntity.)
Public eventOnMarkForClose (Inherited from IMyEntity.)
Public eventOnPhysicsChanged (Inherited from IMyEntity.)
Public eventOnUpgradeValuesChanged (Inherited from IMyCubeBlock.)
Public eventOwnershipChanged (Inherited from IMyTerminalBlock.)
Public eventPropertiesChanged (Inherited from IMyTerminalBlock.)
Public eventShowOnHUDChanged (Inherited from IMyTerminalBlock.)
Public eventVisibilityChanged (Inherited from IMyTerminalBlock.)
See Also