Space Engineers
Public Member Functions | List of all members
Sandbox.Game.AI.Pathfinding.IMyPathfinding Interface Reference

A gateway to all the pathfinding tasks and queries More...

Inheritance diagram for Sandbox.Game.AI.Pathfinding.IMyPathfinding:
Sandbox.Game.AI.Pathfinding.MyExternalPathfinding Sandbox.Game.AI.Pathfinding.MyPathfinding Sandbox.Game.AI.Pathfinding.MyRDPathfinding

Public Member Functions

IMyPath FindPathGlobal (Vector3D begin, IMyDestinationShape end, MyEntity relativeEntity)
 Finds a path from the world-space point begin to the given destination shape. More...
 
bool ReachableUnderThreshold (Vector3D begin, IMyDestinationShape end, float thresholdDistance)
 Checks, whether the given destination is reachable, but stops the search after some threshold distance. More...
 
IMyPathfindingLog GetPathfindingLog ()
 For BW compatibility only. You most certainly don't need to implement this! More...
 
void Update ()
 Recieves periodic updates from the game loop More...
 
void UnloadData ()
 Gets called when the MyAIComponent is unloaded More...
 
void DebugDraw ()
 All the debug draw code should go here More...
 

Detailed Description

A gateway to all the pathfinding tasks and queries

Definition at line 15 of file IMyPathfinding.cs.

Member Function Documentation

void Sandbox.Game.AI.Pathfinding.IMyPathfinding.DebugDraw ( )
IMyPath Sandbox.Game.AI.Pathfinding.IMyPathfinding.FindPathGlobal ( Vector3D  begin,
IMyDestinationShape  end,
MyEntity  relativeEntity 
)

Finds a path from the world-space point begin to the given destination shape.

Parameters
beginFrom where to do the pathfinding
endThe destination shape for this pathfinding query
relativeEntityIf not null, the begin parameter is not in world space, but in local space relative to this entity
Returns
The found path if any, null otherwise

Implemented in Sandbox.Game.AI.Pathfinding.MyPathfinding, Sandbox.Game.AI.Pathfinding.MyExternalPathfinding, and Sandbox.Game.AI.Pathfinding.MyRDPathfinding.

IMyPathfindingLog Sandbox.Game.AI.Pathfinding.IMyPathfinding.GetPathfindingLog ( )

For BW compatibility only. You most certainly don't need to implement this!

Implemented in Sandbox.Game.AI.Pathfinding.MyExternalPathfinding, Sandbox.Game.AI.Pathfinding.MyRDPathfinding, and Sandbox.Game.AI.Pathfinding.MyPathfinding.

bool Sandbox.Game.AI.Pathfinding.IMyPathfinding.ReachableUnderThreshold ( Vector3D  begin,
IMyDestinationShape  end,
float  thresholdDistance 
)

Checks, whether the given destination is reachable, but stops the search after some threshold distance.

Parameters
beginWhere to start the search from
endThe destination for the reachability query
thresholdDistanceThe distance after which the query should stop
Returns
True if the destination is reachable, false if it could not be found after the given threshold distance

Implemented in Sandbox.Game.AI.Pathfinding.MyPathfinding, Sandbox.Game.AI.Pathfinding.MyExternalPathfinding, and Sandbox.Game.AI.Pathfinding.MyRDPathfinding.

void Sandbox.Game.AI.Pathfinding.IMyPathfinding.UnloadData ( )
void Sandbox.Game.AI.Pathfinding.IMyPathfinding.Update ( )

The documentation for this interface was generated from the following file: