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: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public interface IMyShipController : IMyTerminalBlock, 
	IMyCubeBlock, IMyEntity, IMyShipController, IMyTerminalBlock, IMyCubeBlock, 
	IMyEntity, IMyControllableEntity

Public Interface IMyShipController
	Inherits IMyTerminalBlock, IMyCubeBlock, IMyEntity, IMyShipController, 
	IMyTerminalBlock, IMyCubeBlock, IMyEntity, IMyControllableEntity

public interface class IMyShipController : IMyTerminalBlock, 
	IMyCubeBlock, IMyEntity, IMyShipController, IMyTerminalBlock, IMyCubeBlock, 
	IMyEntity, IMyControllableEntity

type IMyShipController =  
    interface
        interface IMyTerminalBlock
        interface IMyCubeBlock
        interface IMyEntity
        interface IMyShipController
        interface IMyTerminalBlock
        interface IMyCubeBlock
        interface IMyEntity
        interface IMyControllableEntity
    end

The IMyShipController type exposes the following members.

Methods

	Name	Description
	AddToGamePruningStructure	Obsolete. (Inherited from IMyEntity.)
	AddUpgradeValue	(Inherited from IMyCubeBlock.)
	BeforeSave	(Inherited from IMyEntity.)
	CalcLocalMatrix	(Inherited from IMyCubeBlock.)
	CalculateCurrentModel	(Inherited from IMyCubeBlock.)
	CalculateShipMass	Gets information about the current mass of the ship. (Inherited from IMyShipController.)
	Close	(Inherited from IMyEntity.)
	Crouch	(Inherited from IMyControllableEntity.)
	DebugDraw	(Inherited from IMyCubeBlock.)
	DebugDrawInvalidTriangles	(Inherited from IMyEntity.)
	Delete	(Inherited from IMyEntity.)
	Die	(Inherited from IMyControllableEntity.)
	DoOverlapSphereTest	(Inherited from IMyEntity.)
	Down	(Inherited from IMyControllableEntity.)
	DrawHud	(Inherited from IMyControllableEntity.)
	EnableColorMaskForSubparts	(Inherited from IMyEntity.)
	GetActions	(Inherited from IMyTerminalBlock.)
	GetActionWithName	(Inherited from IMyTerminalBlock.)
	GetArtificialGravity	Gets the detected artificial gravity vector and power at the current location. (Inherited from IMyShipController.)
	[M:VRage.ModAPI.IMyEntity.GetChildren(System.Collections.Generic.List{VRage.ModAPI.IMyEntity},System.Func`2)]	(Inherited from IMyEntity.)
	GetDiffuseColor	(Inherited from IMyEntity.)
	GetDistanceBetweenCameraAndBoundingSphere	(Inherited from IMyEntity.)
	GetDistanceBetweenCameraAndPosition	(Inherited from IMyEntity.)
	GetFriendlyName	(Inherited from IMyEntity.)
	GetHeadMatrix	(Inherited from IMyControllableEntity.)
	GetIntersectionWithLine	(Inherited from IMyEntity.)
	GetIntersectionWithLineAndBoundingSphere	(Inherited from IMyEntity.)
	GetIntersectionWithSphere	(Inherited from IMyEntity.)
	GetInventory	(Inherited from IMyEntity.)
	GetInventory(Int32)	(Inherited from IMyEntity.)
	GetLargestDistanceBetweenCameraAndBoundingSphere	(Inherited from IMyEntity.)
	GetNaturalGravity	Gets the detected natural gravity vector and power at the current location. (Inherited from IMyShipController.)
	GetObjectBuilder	(Inherited from IMyEntity.)
	GetObjectBuilderCubeBlock	(Inherited from IMyCubeBlock.)
	GetOwnerFactionTag	(Inherited from IMyCubeBlock.)
	GetPlayerRelationToOwner	(Inherited from IMyCubeBlock.)
	GetPosition	(Inherited from IMyEntity.)
	GetProperties	(Inherited from IMyTerminalBlock.)
	GetProperty	(Inherited from IMyTerminalBlock.)
	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.)
	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.)
	GetSmallestDistanceBetweenCameraAndBoundingSphere	(Inherited from IMyEntity.)
	GetSubpart	(Inherited from IMyEntity.)
	GetTopMostParent	(Inherited from IMyEntity.)
	GetTotalGravity	Gets the total accumulated gravity vector and power at the current location, taking both natural and artificial gravity into account. (Inherited from IMyShipController.)
	GetTrianglesIntersectingSphere	(Inherited from IMyEntity.)
	GetUserRelationToOwner	(Inherited from IMyCubeBlock.)
	GetViewMatrix	(Inherited from IMyEntity.)
	GetWorldMatrixNormalizedInv	(Inherited from IMyEntity.)
	HasLocalPlayerAccess	(Inherited from IMyTerminalBlock.)
	HasPlayerAccess	(Inherited from IMyTerminalBlock.)
	Init	(Inherited from IMyCubeBlock.)
	Init(MyObjectBuilder_CubeBlock, IMyCubeGrid)	(Inherited from IMyCubeBlock.)
	IsVisible	(Inherited from IMyEntity.)
	Jump	(Inherited from IMyControllableEntity.)
	MoveAndRotate	(Inherited from IMyControllableEntity.)
	MoveAndRotateStopped	(Inherited from IMyControllableEntity.)
	OnAddedToScene	(Inherited from IMyEntity.)
	OnBuildSuccess	(Inherited from IMyCubeBlock.)
	OnDestroy	(Inherited from IMyCubeBlock.)
	OnModelChange	(Inherited from IMyCubeBlock.)
	OnRegisteredToGridSystems	(Inherited from IMyCubeBlock.)
	OnRemovedByCubeBuilder	(Inherited from IMyCubeBlock.)
	OnRemovedFromScene	(Inherited from IMyEntity.)
	OnUnregisteredFromGridSystems	(Inherited from IMyCubeBlock.)
	PickUp	(Inherited from IMyControllableEntity.)
	PickUpContinues	(Inherited from IMyControllableEntity.)
	RaycastDetectors	(Inherited from IMyCubeBlock.)
	RefreshCustomInfo	Raises AppendingCustomInfo so every subscriber can append custom info. (Inherited from IMyTerminalBlock.)
	ReloadDetectors	(Inherited from IMyCubeBlock.)
	RemoveEffect	(Inherited from IMyCubeBlock.)
	RemoveFromGamePruningStructure	Obsolete. (Inherited from IMyEntity.)
	SearchActionsOfName	(Inherited from IMyTerminalBlock.)
	SetColorMaskForSubparts	(Inherited from IMyEntity.)
	SetCustomName(String)	Obsolete. (Inherited from IMyTerminalBlock.)
	SetCustomName(StringBuilder)	Obsolete. (Inherited from IMyTerminalBlock.)
	SetDamageEffect	(Inherited from IMyCubeBlock.)
	SetEffect(String, Boolean)	(Inherited from IMyCubeBlock.)
	SetEffect(String, Single, Boolean, Boolean, Boolean)	(Inherited from IMyCubeBlock.)
	SetEmissiveParts	(Inherited from IMyEntity.)
	SetEmissivePartsForSubparts	(Inherited from IMyEntity.)
	SetLocalMatrix	(Inherited from IMyEntity.)
	SetPosition	(Inherited from IMyEntity.)
	SetWorldMatrix	(Inherited from IMyEntity.)
	ShowInventory	(Inherited from IMyControllableEntity.)
	ShowTerminal	(Inherited from IMyControllableEntity.)
	SwitchDamping	(Inherited from IMyControllableEntity.)
	SwitchHelmet	(Inherited from IMyControllableEntity.)
	SwitchLeadingGears	(Inherited from IMyControllableEntity.)
	SwitchLights	(Inherited from IMyControllableEntity.)
	SwitchReactors	(Inherited from IMyControllableEntity.)
	SwitchThrusts	(Inherited from IMyControllableEntity.)
	SwitchWalk	(Inherited from IMyControllableEntity.)
	TryGetPlanetElevation	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.)
	TryGetPlanetPosition	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.)
	TryGetSubpart	(Inherited from IMyEntity.)
	Up	(Inherited from IMyControllableEntity.)
	UpdateGamePruningStructure	Obsolete. (Inherited from IMyEntity.)
	UpdateIsWorking	(Inherited from IMyCubeBlock.)
	UpdateVisual	(Inherited from IMyCubeBlock.)
	Use	(Inherited from IMyControllableEntity.)
	UseContinues	(Inherited from IMyControllableEntity.)

Top

Extension Methods

	Name	Description
	ApplyAction(String)	Overloaded. (Defined by TerminalBlockExtentions.)
	ApplyAction(String, ListTerminalActionParameter)	Overloaded. (Defined by TerminalBlockExtentions.)
	GetDefaultValueT	Returns default value of specified property as TypeName (Defined by TerminalPropertyExtensions.)
	GetId	(Defined by TerminalBlockExtentions.)
	GetInventoryCount	(Defined by TerminalBlockExtentions.)
	GetMaximumT	Returns maximum value of specified property as TypeName (Defined by TerminalPropertyExtensions.)
	GetMinimumT	Returns minimum value of specified property as TypeName (Defined by TerminalPropertyExtensions.)
	GetMininumT	Returns minimum value of specified property as TypeName - this call is obsolete due typo in name, use GetMinimumT(IMyTerminalBlock, String) (Defined by TerminalPropertyExtensions.)
	GetUseConveyorSystem	(Defined by TerminalBlockExtentions.)
	GetValueT	Returns value of specified property as TypeName (Defined by TerminalPropertyExtensions.)
	GetValueBool	Returns value of specified property (Defined by TerminalPropertyExtensions.)
	GetValueColor	Returns value of specified property (Defined by TerminalPropertyExtensions.)
	GetValueFloat	Returns value of specified property (Defined by TerminalPropertyExtensions.)
	HasAction	(Defined by TerminalBlockExtentions.)
	HasInventory	(Defined by TerminalBlockExtentions.)
	SetUseConveyorSystem	(Defined by TerminalBlockExtentions.)
	SetValueT	Set value of property with type of TypeName (Defined by TerminalPropertyExtensions.)
	SetValueBool	Set bool value of property (Defined by TerminalPropertyExtensions.)
	SetValueColor	Set bool value of property (Defined by TerminalPropertyExtensions.)
	SetValueFloat	Set float value of property (Defined by TerminalPropertyExtensions.)

Top

Properties

	Name	Description
	BlockDefinition	(Inherited from IMyCubeBlock.)
	CanControlShip	Determines whether this specific ship controller is capable of controlling the ship it's installed on. (Inherited from IMyShipController.)
	CastShadows	(Inherited from IMyEntity.)
	CenterOfMass	Center of mass in world coordinates (Inherited from IMyShipController.)
	CheckConnectionAllowed	(Inherited from IMyCubeBlock.)
	Closed	(Inherited from IMyEntity.)
	Components	(Inherited from IMyEntity.)
	ControllerInfo	(Inherited from IMyControllableEntity.)
	ControlThrusters	Gets or sets whether thrusters are being controlled by this controller. (Inherited from IMyShipController.)
	ControlWheels	Gets or sets whether wheels are being controlled by this controller. (Inherited from IMyShipController.)
	CubeGrid	(Inherited from IMyCubeBlock.)
	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.)
	CustomInfo	(Inherited from IMyTerminalBlock.)
	CustomName	(Inherited from IMyTerminalBlock.)
	CustomNameWithFaction	(Inherited from IMyTerminalBlock.)
	DampenersOverride	Gets or sets whether dampeners are currently enabled. (Inherited from IMyShipController.)
	DebugAsyncLoading	(Inherited from IMyEntity.)
	DefinitionDisplayNameText	(Inherited from IMyCubeBlock.)
	DetailedInfo	(Inherited from IMyTerminalBlock.)
	DisassembleRatio	(Inherited from IMyCubeBlock.)
	DisplayName	(Inherited from IMyEntity.)
	DisplayNameText	(Inherited from IMyCubeBlock.)
	EnabledDamping	(Inherited from IMyControllableEntity.)
	EnabledHelmet	(Inherited from IMyControllableEntity.)
	EnabledLeadingGears	(Inherited from IMyControllableEntity.)
	EnabledLights	(Inherited from IMyControllableEntity.)
	EnabledReactors	(Inherited from IMyControllableEntity.)
	EnabledThrusts	(Inherited from IMyControllableEntity.)
	Entity	(Inherited from IMyControllableEntity.)
	EntityId	(Inherited from IMyEntity.)
	FastCastShadowResolve	(Inherited from IMyEntity.)
	Flags	(Inherited from IMyEntity.)
	ForceFirstPersonCamera	(Inherited from IMyControllableEntity.)
	GameLogic	(Inherited from IMyEntity.)
	HandBrake	Gets or sets the current state of the handbrake. (Inherited from IMyShipController.)
	HasFirstPersonCamera	Gets if this ship controller contains a first-person camera view.
	HasInventory	(Inherited from IMyEntity.)
	HasWheels	Determines whether there are any wheels on this ship. (Inherited from IMyShipController.)
	Hierarchy	(Inherited from IMyEntity.)
	InScene	(Inherited from IMyEntity.)
	InvalidateOnMove	(Inherited from IMyEntity.)
	InventoryCount	(Inherited from IMyEntity.)
	IsBeingHacked	(Inherited from IMyCubeBlock.)
	IsCCDForProjectiles	Obsolete. (Inherited from IMyEntity.)
	IsFunctional	(Inherited from IMyCubeBlock.)
	IsShooting	Gets if the ship is shooting selected weapons.
	IsUnderControl	Indicates whether a block is locally or remotely controlled. (Inherited from IMyShipController.)
	IsVolumetric	(Inherited from IMyEntity.)
	IsWorking	(Inherited from IMyCubeBlock.)
	LastPilot	Get the last character that was piloting the controller.
	LocalAABB	(Inherited from IMyEntity.)
	LocalAABBHr	(Inherited from IMyEntity.)
	LocalMatrix	(Inherited from IMyEntity.)
	LocalVolume	(Inherited from IMyEntity.)
	LocalVolumeOffset	(Inherited from IMyEntity.)
	LocationForHudMarker	Obsolete. (Inherited from IMyEntity.)
	MarkedForClose	(Inherited from IMyEntity.)
	Mass	(Inherited from IMyCubeBlock.)
	Max	(Inherited from IMyCubeBlock.)
	MaxGlassDistSq	(Inherited from IMyEntity.)
	Min	(Inherited from IMyCubeBlock.)
	Model	(Inherited from IMyEntity.)
	MoveIndicator	Gets the current movement direction indicator
	Name	(Inherited from IMyEntity.)
	NearFlag	(Inherited from IMyEntity.)
	NeedsDraw	(Inherited from IMyEntity.)
	NeedsDrawFromParent	(Inherited from IMyEntity.)
	NeedsResolveCastShadow	(Inherited from IMyEntity.)
	NeedsUpdate	(Inherited from IMyEntity.)
	NumberInGrid	(Inherited from IMyCubeBlock.)
	Orientation	(Inherited from IMyCubeBlock.)
	OwnerId	(Inherited from IMyCubeBlock.)
	Parent	(Inherited from IMyEntity.)
	PersistentFlags	(Inherited from IMyEntity.)
	Physics	(Inherited from IMyEntity.)
	Pilot	Get the character that is currently piloting the controller.
	Position	(Inherited from IMyCubeBlock.)
	PositionComp	(Inherited from IMyEntity.)
	PrimaryLookaround	(Inherited from IMyControllableEntity.)
	Render	(Inherited from IMyEntity.)
	ResourceSink	(Inherited from IMyCubeBlock.)
	RollIndicator	Gets the current roll direction indicator
	RotationIndicator	Gets the current rotation direction indicator
	Save	(Inherited from IMyEntity.)
	ShadowBoxLod	(Inherited from IMyEntity.)
	ShowHorizonIndicator	Gets or sets whether the horizon indicator should be displayed for this block. (Inherited from IMyShipController.)
	ShowInTerminal	(Inherited from IMyTerminalBlock.)
	ShowInToolbarConfig	(Inherited from IMyTerminalBlock.)
	ShowOnHUD	(Inherited from IMyTerminalBlock.)
	SkipIfTooSmall	(Inherited from IMyEntity.)
	SlimBlock	(Inherited from IMyCubeBlock.)
	Storage	(Inherited from IMyEntity.)
	Synchronized	(Inherited from IMyEntity.)
	SyncObject	(Inherited from IMyEntity.)
	Transparent	(Inherited from IMyEntity.)
	UpgradeValues	(Inherited from IMyCubeBlock.)
	Visible	(Inherited from IMyEntity.)
	WorldAABB	(Inherited from IMyEntity.)
	WorldAABBHr	(Inherited from IMyEntity.)
	WorldMatrix	(Inherited from IMyEntity.)
	WorldMatrixInvScaled	(Inherited from IMyEntity.)
	WorldMatrixNormalizedInv	(Inherited from IMyEntity.)
	WorldVolume	(Inherited from IMyEntity.)
	WorldVolumeHr	(Inherited from IMyEntity.)

Top

Events

	Name	Description
	AppendingCustomInfo	Event to append custom info. (Inherited from IMyTerminalBlock.)
	CustomNameChanged	(Inherited from IMyTerminalBlock.)
	IsWorkingChanged	(Inherited from IMyCubeBlock.)
	OnClose	(Inherited from IMyEntity.)
	OnClosing	(Inherited from IMyEntity.)
	OnMarkForClose	(Inherited from IMyEntity.)
	OnPhysicsChanged	(Inherited from IMyEntity.)
	OnUpgradeValuesChanged	(Inherited from IMyCubeBlock.)
	OwnershipChanged	(Inherited from IMyTerminalBlock.)
	PropertiesChanged	(Inherited from IMyTerminalBlock.)
	ShowOnHUDChanged	(Inherited from IMyTerminalBlock.)
	VisibilityChanged	(Inherited from IMyTerminalBlock.)

Top

Reference

Sandbox.ModAPI Namespace