Class MyAutopilotComponent

[MyComponentType]
[MyComponentBuilder]
public class MyAutopilotComponent : MyEventProxyEntityComponent, IMyEntityComponentBase, IMyComponentBase, IMyEventProxy, IMyEventOwner

Constructors

MyAutopilotComponent()

Declaration

public MyAutopilotComponent()

Fields

AutoPilotEnabled

Declaration

public Sync<bool, SyncDirection.BothWays> AutoPilotEnabled

Field Value

Type	Description
VRage.Sync.Sync<System.Boolean, VRage.Sync.SyncDirection.BothWays>

WaypointsFromPathRecorder

Declaration

public bool WaypointsFromPathRecorder

Field Value

Type	Description
System.Boolean

Properties

AutomaticBehaviour

Declaration

public IRemoteControlAutomaticBehaviour AutomaticBehaviour { get; set; }

Property Value

Type	Description
IRemoteControlAutomaticBehaviour

AutoPilotControlThrust

Declaration

public Vector3 AutoPilotControlThrust { get; set; }

Property Value

Type	Description
Vector3

Clipboard

Declaration

public static MyObjectBuilder_AutopilotClipboard Clipboard { get; }

Property Value

Type	Description
MyObjectBuilder_AutopilotClipboard

ComponentTypeDebugString

Declaration

public override string ComponentTypeDebugString { get; }

Property Value

Type	Description
System.String

Overrides

MyEntityComponentBase.ComponentTypeDebugString

CurrentDestination

Declaration

public Vector3D CurrentDestination { get; }

Property Value

Type	Description
Vector3D

CurrentDirection

Declaration

public Base6Directions.Direction CurrentDirection { get; set; }

Property Value

Type	Description
Base6Directions.Direction

CurrentFlightMode

Declaration

public FlightMode CurrentFlightMode { get; set; }

Property Value

Type	Description
FlightMode

CurrentWaypoint

Declaration

public MyAutopilotWaypoint CurrentWaypoint { get; set; }

Property Value

Type	Description
MyAutopilotWaypoint

CurrentWaypointIndex

Declaration

public int CurrentWaypointIndex { get; }

Property Value

Type	Description
System.Int32

CurrentWaypointName

Declaration

public string CurrentWaypointName { get; }

Property Value

Type	Description
System.String

CustomLookAtPositionInterceptor

Declaration

public CustomLookAtInterceptor CustomLookAtPositionInterceptor { get; set; }

Property Value

Type	Description
CustomLookAtInterceptor

Definition

Declaration

public MyAutopilotComponentDefinition Definition { get; }

Property Value

Type	Description
MyAutopilotComponentDefinition

DirectionNames

Declaration

public static Dictionary<Base6Directions.Direction, MyStringId> DirectionNames { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<Base6Directions.Direction, MyStringId>

FacingDirection

Declaration

public Base6Directions.DirectionFlags FacingDirection { get; set; }

Property Value

Type	Description
Base6Directions.DirectionFlags

FlightMode

Declaration

public FlightMode FlightMode { get; }

Property Value

Type	Description
FlightMode

ForceBehaviorUpdate

Declaration

public bool ForceBehaviorUpdate { get; set; }

Property Value

Type	Description
System.Boolean

ForcedRotation

Declaration

public Nullable<QuaternionD> ForcedRotation { get; }

Property Value

Type	Description
System.Nullable<QuaternionD>

HasWaypoints

Declaration

public bool HasWaypoints { get; }

Property Value

Type	Description
System.Boolean

HeightAdjustmentWaypoint

Declaration

public MyAutopilotWaypoint HeightAdjustmentWaypoint { get; set; }

Property Value

Type	Description
MyAutopilotWaypoint

IsAlignedToGravity

Declaration

public bool IsAlignedToGravity { get; set; }

Property Value

Type	Description
System.Boolean

IsDockingModeEnabled

Declaration

public bool IsDockingModeEnabled { get; set; }

Property Value

Type	Description
System.Boolean

IsIdle

Declaration

public bool IsIdle { get; }

Property Value

Type	Description
System.Boolean

IsMovementPaused

Declaration

public bool IsMovementPaused { get; set; }

Property Value

Type	Description
System.Boolean

IsUsingCollisionAvoidance

Must be used in GUI Only

Declaration

public bool IsUsingCollisionAvoidance { get; set; }

Property Value

Type	Description
System.Boolean

IsUsingCollisionAvoidanceForLogic

Must be used in logic

Declaration

public bool IsUsingCollisionAvoidanceForLogic { get; }

Property Value

Type	Description
System.Boolean

IsWaypointBelowMinHeight

Declaration

public bool IsWaypointBelowMinHeight { get; }

Property Value

Type	Description
System.Boolean

IsWorkAreaReturningToStart

Declaration

public bool IsWorkAreaReturningToStart { get; set; }

Property Value

Type	Description
System.Boolean

LookAtPosition

Declaration

public Nullable<Vector3D> LookAtPosition { get; set; }

Property Value

Type	Description
System.Nullable<Vector3D>

MaxPitchAngle

Declaration

public float MaxPitchAngle { get; set; }

Property Value

Type	Description
System.Single

MaxRollAngle

Declaration

public float MaxRollAngle { get; set; }

Property Value

Type	Description
System.Single

MinHeightAboveTerrain

Declaration

public float MinHeightAboveTerrain { get; set; }

Property Value

Type	Description
System.Single

MinHeightAboveTerraingRaw

Declaration

public float MinHeightAboveTerraingRaw { get; }

Property Value

Type	Description
System.Single

MinHeightAboveTerrainUnadjusted

Declaration

public float MinHeightAboveTerrainUnadjusted { get; }

Property Value

Type	Description
System.Single

PreciseRotation

Declaration

public bool PreciseRotation { get; set; }

Property Value

Type	Description
System.Boolean

ReferencePosition

Declaration

public Vector3D ReferencePosition { get; }

Property Value

Type	Description
Vector3D

SelectedGpsLocations

Declaration

public List<IMyGps> SelectedGpsLocations { get; }

Property Value

Type	Description
System.Collections.Generic.List<IMyGps>

SelectedWaypoints

Declaration

public List<MyAutopilotWaypoint> SelectedWaypoints { get; }

Property Value

Type	Description
System.Collections.Generic.List<MyAutopilotWaypoint>

ShipController

Declaration

public IMyShipControl ShipController { get; }

Property Value

Type	Description
Sandbox.Game.Entities.Interfaces.IMyShipControl

SpeedLimit

Declaration

public float SpeedLimit { get; set; }

Property Value

Type	Description
System.Single

TargettingAimDelta

Declaration

public double TargettingAimDelta { get; set; }

Property Value

Type	Description
System.Double

ThrustComp

Declaration

public MyEntityThrustComponent ThrustComp { get; }

Property Value

Type	Description
Sandbox.Game.GameSystems.MyEntityThrustComponent

WaitForFreeWay

Declaration

public bool WaitForFreeWay { get; set; }

Property Value

Type	Description
System.Boolean

Waypoints

Declaration

public List<MyAutopilotWaypoint> Waypoints { get; }

Property Value

Type	Description
System.Collections.Generic.List<MyAutopilotWaypoint>

WaypointThresholdDistance

Declaration

public float WaypointThresholdDistance { get; set; }

Property Value

Type	Description
System.Single

WorkAreaStartForward

Declaration

public Vector3D WorkAreaStartForward { get; set; }

Property Value

Type	Description
Vector3D

Methods

AddedToScene()

Declaration

public void AddedToScene()

AddSelectedWaypoints()

Declaration

public void AddSelectedWaypoints()

AddWaypoint(MyWaypointInfo)

Declaration

public void AddWaypoint(MyWaypointInfo coords)

Parameters

Type	Name	Description
MyWaypointInfo	coords

AddWaypoint(Vector3D, String, Boolean)

Declaration

public void AddWaypoint(Vector3D point, string name, bool setAsCurrent)

Parameters

Type	Name	Description
Vector3D	point
System.String	name
System.Boolean	setAsCurrent

AddWaypointBroadcast(MatrixD, Int64, String)

Declaration

[Event(null, 3546)]
[Reliable]
[Server]
[Broadcast]
public void AddWaypointBroadcast(MatrixD Matrix, long RelatedEntityId, string Name)

Parameters

Type	Name	Description
MatrixD	Matrix
System.Int64	RelatedEntityId
System.String	Name

AdvanceWaypoint(Boolean, Boolean)

Declaration

public void AdvanceWaypoint(bool reportRemoval = true, bool playAction = true)

Parameters

Type	Name	Description
System.Boolean	reportRemoval
System.Boolean	playAction

AlignToMinHeight(MyAutopilotWaypoint)

Declaration

public bool AlignToMinHeight(MyAutopilotWaypoint waypoint)

Parameters

Type	Name	Description
MyAutopilotWaypoint	waypoint

Returns

Type	Description
System.Boolean

CanAddWaypoints()

Declaration

public bool CanAddWaypoints()

Returns

Type	Description
System.Boolean

CanEnableAutoPilot()

Declaration

public bool CanEnableAutoPilot()

Returns

Type	Description
System.Boolean

CanMoveWaypointsDown()

Declaration

public bool CanMoveWaypointsDown()

Returns

Type	Description
System.Boolean

CanMoveWaypointsUp()

Declaration

public bool CanMoveWaypointsUp()

Returns

Type	Description
System.Boolean

CanRemoveWaypoints()

Declaration

public bool CanRemoveWaypoints()

Returns

Type	Description
System.Boolean

ChangeDirection(Base6Directions.Direction)

Declaration

public void ChangeDirection(Base6Directions.Direction direction)

Parameters

Type	Name	Description
Base6Directions.Direction	direction

ChangeFlightMode(FlightMode, Boolean)

Declaration

public void ChangeFlightMode(FlightMode flightMode, bool forceEnable = false)

Parameters

Type	Name	Description
FlightMode	flightMode
System.Boolean	forceEnable

ClearWaypoints(Boolean)

Declaration

public void ClearWaypoints(bool advanceWaypoint = true)

Parameters

Type	Name	Description
System.Boolean	advanceWaypoint

CopyAutopilotSetup()

Declaration

public void CopyAutopilotSetup()

Deserialize(MyObjectBuilder_ComponentBase)

Declaration

public override void Deserialize(MyObjectBuilder_ComponentBase builder)

Parameters

Type	Name	Description
MyObjectBuilder_ComponentBase	builder

Overrides

MyComponentBase.Deserialize(MyObjectBuilder_ComponentBase)

FillDirectionCombo(List<MyTerminalControlComboBoxItem>)

Declaration

public static void FillDirectionCombo(List<MyTerminalControlComboBoxItem> list)

Parameters

Type	Name	Description
System.Collections.Generic.List<MyTerminalControlComboBoxItem>	list

FillFlightModeCombo(List<MyTerminalControlComboBoxItem>)

Declaration

public static void FillFlightModeCombo(List<MyTerminalControlComboBoxItem> list)

Parameters

Type	Name	Description
System.Collections.Generic.List<MyTerminalControlComboBoxItem>	list

FillGpsList(ICollection<MyGuiControlListbox.Item>, ICollection<MyGuiControlListbox.Item>)

Declaration

public void FillGpsList(ICollection<MyGuiControlListbox.Item> gpsItemList, ICollection<MyGuiControlListbox.Item> selectedGpsItemList)

Parameters

Type	Name	Description
System.Collections.Generic.ICollection<Sandbox.Graphics.GUI.MyGuiControlListbox.Item>	gpsItemList
System.Collections.Generic.ICollection<Sandbox.Graphics.GUI.MyGuiControlListbox.Item>	selectedGpsItemList

FillWaypointList(ICollection<MyGuiControlListbox.Item>, ICollection<MyGuiControlListbox.Item>)

Declaration

public void FillWaypointList(ICollection<MyGuiControlListbox.Item> waypoints, ICollection<MyGuiControlListbox.Item> selectedWaypoints)

Parameters

Type	Name	Description
System.Collections.Generic.ICollection<Sandbox.Graphics.GUI.MyGuiControlListbox.Item>	waypoints
System.Collections.Generic.ICollection<Sandbox.Graphics.GUI.MyGuiControlListbox.Item>	selectedWaypoints

ForceRotateRequested(Nullable<QuaternionD>)

Declaration

public void ForceRotateRequested(Nullable<QuaternionD> rotation)

Parameters

Type	Name	Description
System.Nullable<QuaternionD>	rotation

ForceRotateToLookAtRequested(Boolean)

Declaration

public void ForceRotateToLookAtRequested(bool shouldRotate)

Parameters

Type	Name	Description
System.Boolean	shouldRotate

GetCurrentLookVector()

Declaration

public Nullable<Vector3D> GetCurrentLookVector()

Returns

Type	Description
System.Nullable<Vector3D>

GetDestinationTriggerSphereScaleFactor(MyCubeSize)

Declaration

public static double GetDestinationTriggerSphereScaleFactor(MyCubeSize gridSizeEnum)

Parameters

Type	Name	Description
MyCubeSize	gridSizeEnum

Returns

Type	Description
System.Double

Init(MyComponentDefinitionBase)

Declaration

public override void Init(MyComponentDefinitionBase definition)

Parameters

Type	Name	Description
MyComponentDefinitionBase	definition

Overrides

MyComponentBase.Init(MyComponentDefinitionBase)

InitWithObjectBuilder(MyObjectBuilder_RemoteControl)

Declaration

public void InitWithObjectBuilder(MyObjectBuilder_RemoteControl ob)

Parameters

Type	Name	Description
MyObjectBuilder_RemoteControl	ob

InitWithOwnObjectBuilder()

Declaration

public void InitWithOwnObjectBuilder()

IsSerialized()

Declaration

public override bool IsSerialized()

Returns

Type	Description
System.Boolean

Overrides

MyComponentBase.IsSerialized()

MoveSelectedWaypointsDown()

Declaration

public void MoveSelectedWaypointsDown()

MoveSelectedWaypointsUp()

Declaration

public void MoveSelectedWaypointsUp()

OnAddedToContainer()

Declaration

public override void OnAddedToContainer()

Overrides

MyEntityComponentBase.OnAddedToContainer()

OnBeforeRemovedFromContainer()

Declaration

public override void OnBeforeRemovedFromContainer()

Overrides

MyEventProxyEntityComponent.OnBeforeRemovedFromContainer()

OnEvasiveManeuversChanged(Int32, Int32)

Declaration

public void OnEvasiveManeuversChanged(int interval, int duration)

Parameters

Type	Name	Description
System.Int32	interval
System.Int32	duration

OnRemoveWaypoints(Int32[])

Declaration

[Event(null, 3282)]
[Reliable]
[Server]
[Broadcast]
public void OnRemoveWaypoints(int[] indexes)

Parameters

Type	Name	Description
System.Int32[]	indexes

PasteAutopilotSetup()

Declaration

public void PasteAutopilotSetup()

RaisePropertiesChangedRemote()

Declaration

public void RaisePropertiesChangedRemote()

RemoveAutoPilot()

Declaration

public void RemoveAutoPilot()

RemoveSelectedWaypoints()

Declaration

public void RemoveSelectedWaypoints()

RemoveWaypoint(MyAutopilotWaypoint)

Declaration

public void RemoveWaypoint(MyAutopilotWaypoint waypoint)

Parameters

Type	Name	Description
MyAutopilotWaypoint	waypoint

ResetShipControls()

Declaration

public void ResetShipControls()

ResetWaypoint()

Declaration

public void ResetWaypoint()

SelectGps(List<MyGuiControlListbox.Item>)

Declaration

public void SelectGps(List<MyGuiControlListbox.Item> selection)

Parameters

Type	Name	Description
System.Collections.Generic.List<Sandbox.Graphics.GUI.MyGuiControlListbox.Item>	selection

SelectWaypoint(List<MyGuiControlListbox.Item>)

Declaration

public void SelectWaypoint(List<MyGuiControlListbox.Item> selection)

Parameters

Type	Name	Description
System.Collections.Generic.List<Sandbox.Graphics.GUI.MyGuiControlListbox.Item>	selection

Serialize(Boolean)

Declaration

public override MyObjectBuilder_ComponentBase Serialize(bool copy = false)

Parameters

Type	Name	Description
System.Boolean	copy

Returns

Type	Description
MyObjectBuilder_ComponentBase

Overrides

MyComponentBase.Serialize(Boolean)

SetAutopilot(Boolean)

Declaration

public void SetAutopilot(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled

SetAutoPilotEnabled(Boolean)

Declaration

public void SetAutoPilotEnabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled

SetCustomAdjustWaypointAboveMinHeightFunction(CustomAdjustWaypointAboveMinHeightFunction)

Declaration

public void SetCustomAdjustWaypointAboveMinHeightFunction(CustomAdjustWaypointAboveMinHeightFunction function)

Parameters

Type	Name	Description
CustomAdjustWaypointAboveMinHeightFunction	function

SetCustomMovementFunction(CustomMovementFunction)

Declaration

public void SetCustomMovementFunction(CustomMovementFunction function)

Parameters

Type	Name	Description
CustomMovementFunction	function

SetWaitForFreeWay(Boolean)

Declaration

public void SetWaitForFreeWay(bool waitForFreeWay)

Parameters

Type	Name	Description
System.Boolean	waitForFreeWay

SetWaypoint(MyAutopilotWaypoint)

Declaration

public void SetWaypoint(MyAutopilotWaypoint waypoint)

Parameters

Type	Name	Description
MyAutopilotWaypoint	waypoint

SetWaypoints(List<MyAutopilotWaypoint>, Boolean, Boolean, Boolean)

Declaration

public void SetWaypoints(List<MyAutopilotWaypoint> newWaypoints, bool continueOnCurrentCourse, bool continueOnReversedCourse, bool fly)

Parameters

Type	Name	Description
System.Collections.Generic.List<MyAutopilotWaypoint>	newWaypoints
System.Boolean	continueOnCurrentCourse
System.Boolean	continueOnReversedCourse
System.Boolean	fly

Toolbar_ItemChanged(MyToolbar, MyToolbar.IndexArgs, Boolean)

Declaration

public void Toolbar_ItemChanged(MyToolbar self, MyToolbar.IndexArgs index, bool isGamepad)

Parameters

Type	Name	Description
Sandbox.Game.Screens.Helpers.MyToolbar	self
Sandbox.Game.Screens.Helpers.MyToolbar.IndexArgs	index
System.Boolean	isGamepad

UpdateAfterSimulation10()

Declaration

public void UpdateAfterSimulation10()

UpdateAutopilot()

Declaration

public void UpdateAutopilot()

UpdateOnceBeforeFrame()

Declaration

public void UpdateOnceBeforeFrame()

UpdateWaypointMatrix(MatrixD)

Declaration

public void UpdateWaypointMatrix(MatrixD matrix)

Parameters

Type	Name	Description
MatrixD	matrix

Events

OnBlockReachedWaypoint

Declaration

public event Action<MyCubeBlock> OnBlockReachedWaypoint

Event Type

Type	Description
System.Action<MyCubeBlock>

OnCurrentWaypointChanged

Declaration

public event Action OnCurrentWaypointChanged

Event Type

Type	Description
System.Action

OnCurrentWaypointIndexChanged

Declaration

public event Action OnCurrentWaypointIndexChanged

Event Type

Type	Description
System.Action

OnMinHeightAboveTerrainChanged

Declaration

public event Action OnMinHeightAboveTerrainChanged

Event Type

Type	Description
System.Action

OnSpeedLimitChanged

Declaration

public event Action<float> OnSpeedLimitChanged

Event Type

Type	Description
System.Action<System.Single>

OnWaypointReached

Declaration

public event Action<MyAutopilotWaypoint> OnWaypointReached

Event Type

Type	Description
System.Action<MyAutopilotWaypoint>

Extension Methods

MyEntityContainerEventExtensions.RegisterForEntityEvent(MyEntityComponentBase, MyStringHash, MyEntityContainerEventExtensions.EntityEventHandler)

MyEntityContainerEventExtensions.RegisterForEntityEvent(MyEntityComponentBase, MyEntity, MyStringHash, MyEntityContainerEventExtensions.EntityEventHandler)

MyEntityContainerEventExtensions.UnregisterForEntityEvent(MyEntityComponentBase, MyEntity, MyStringHash)

MyEntityContainerEventExtensions.RaiseEntityEvent(MyEntityComponentBase, MyStringHash, MyEntityContainerEventExtensions.EntityEventParams)