ff14bot.Navigation.AStarNavigator Class Reference

Inheritance diagram for ff14bot.Navigation.AStarNavigator:

Public Member Functions
	AStarNavigator ()
	AStarNavigator (Graph grh)
override bool	AtLocation (Vector3 point1, Vector3 point2)
bool	CanNavigateFully (Vector3 from, Vector3 to, float strictDistance)
bool	Clear ()
	Clears the current path in this nav provider.
Vector3[]	GeneratePath (Vector3 from, Vector3 to)
override void	OnPulse ()
override MoveResult	MoveTo (MoveToParameters parameters)
virtual MoveResult	MovePath (Vector3[] path)
Task< List< CanFullyNavigateResult > >	CanFullyNavigateToAsync (IEnumerable< CanFullyNavigateTarget > targets)
Task< List< CanFullyNavigateResult > >	CanFullyNavigateToAsync (IEnumerable< CanFullyNavigateTarget > targets, Vector3 start, ushort zoneid)
List< CanFullyNavigateResult >	CanFullyNavigateTo (IEnumerable< CanFullyNavigateTarget > targets)
MoveResult	MoveToRandomSpotWithin (Vector3 location, float radius, string destination=null)
Public Member Functions inherited from ff14bot.Pathing.NavigationProvider
void	OnPulse ()
	Pulses this provider. Called every tick.
MoveResult	MoveTo (MoveToParameters parameters)
	Moves towards the specified locations.
virtual Task< List< CanFullyNavigateResult > >	CanFullyNavigateTo (ICollection< CanFullyNavigateTarget > targets, Vector3 start, ushort zoneid)
	Check if multiple locations can be pathed to on the given zoneid.
virtual Task< List< CanFullyNavigateResult > >	CanFullyNavigateFrom (ICollection< CanFullyNavigateTarget > starts, Vector3 target, ushort zoneid)
	Check if multiple locations can be path from to one specific spot.
async Task< List< CanFullyNavigateResult > >	CanFullyNavigateTo (ICollection< CanFullyNavigateTarget > targets)
	Check if multiple locations can be pathed to on the current zone.
bool	AtLocation (Vector3 point1, Vector3 point2)
	Gets a bool that indicates whether one position is considered to be at another position. Can be used to check if the player has reached a destination, for example.
virtual void	ClearStuckInfo ()
	Clears the stuck handler information.
virtual PathInformation	LookupPathInfo (GameObject obj, float distanceTolerance=3f)
	Looks up the information of a path going to an object.
virtual Task< List< Vector3 > >	SamplePointsAsync (SamplePointsParameters parameters)
	Samples the navigator for points.
virtual void	OnSetAsCurrent ()
	Called when this NavigationProvider is set as the current by assigning it to Navigator.NavigationProvider.
virtual void	OnRemoveAsCurrent ()
	Called when this NavigationProvider is removed as the current by assigning a different provider to Navigator.NavigationProvider.

Public Attributes
Graph	Graph

Properties
Vector3[]	CurrentMovePath [get, set]
Arc[]	CurrentArcPath [get, set]
float	PathPrecisionSqr [get]
float	PathPrecision [get, set]
Properties inherited from ff14bot.Pathing.NavigationProvider
bool	IsCurrent [get]
	Gets a bool that indicates whether this is the current navigation provider.

Constructor & Destructor Documentation

AStarNavigator() [1/2]

ff14bot.Navigation.AStarNavigator.AStarNavigator

(

)

AStarNavigator() [2/2]

ff14bot.Navigation.AStarNavigator.AStarNavigator

(

Graph

grh

)

Member Function Documentation

AtLocation()

override bool ff14bot.Navigation.AStarNavigator.AtLocation	(	Vector3	point1,
		Vector3	point2 )

CanFullyNavigateTo()

List< CanFullyNavigateResult > ff14bot.Navigation.AStarNavigator.CanFullyNavigateTo

(

IEnumerable< CanFullyNavigateTarget >

targets

)

CanFullyNavigateToAsync() [1/2]

Task< List< CanFullyNavigateResult > > ff14bot.Navigation.AStarNavigator.CanFullyNavigateToAsync

(

IEnumerable< CanFullyNavigateTarget >

targets

)

CanFullyNavigateToAsync() [2/2]

Task< List< CanFullyNavigateResult > > ff14bot.Navigation.AStarNavigator.CanFullyNavigateToAsync	(	IEnumerable< CanFullyNavigateTarget >	targets,
		Vector3	start,
		ushort	zoneid )

CanNavigateFully()

bool ff14bot.Navigation.AStarNavigator.CanNavigateFully	(	Vector3	from,
		Vector3	to,
		float	strictDistance )

Clear()

bool ff14bot.Navigation.AStarNavigator.Clear ( )

virtual

Clears the current path in this nav provider.

Returns

Reimplemented from ff14bot.Pathing.NavigationProvider.

GeneratePath()

Vector3[] ff14bot.Navigation.AStarNavigator.GeneratePath	(	Vector3	from,
		Vector3	to )

MovePath()

virtual MoveResult ff14bot.Navigation.AStarNavigator.MovePath ( Vector3[] path )

virtual

MoveTo()

override MoveResult ff14bot.Navigation.AStarNavigator.MoveTo

(

MoveToParameters

parameters

)

MoveToRandomSpotWithin()

MoveResult ff14bot.Navigation.AStarNavigator.MoveToRandomSpotWithin	(	Vector3	location,
		float	radius,
		string	destination = null )

OnPulse()

override void ff14bot.Navigation.AStarNavigator.OnPulse

(

)

Member Data Documentation

Graph

Graph ff14bot.Navigation.AStarNavigator.Graph

Property Documentation

CurrentArcPath

Arc [] ff14bot.Navigation.AStarNavigator.CurrentArcPath

getset

CurrentMovePath

Vector3 [] ff14bot.Navigation.AStarNavigator.CurrentMovePath

getset

PathPrecision

float ff14bot.Navigation.AStarNavigator.PathPrecision

getset

PathPrecisionSqr

float ff14bot.Navigation.AStarNavigator.PathPrecisionSqr

get