ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider Class Reference

Latest and greatest navigation provider. More...

Inheritance diagram for ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider:

Public Member Functions
	ServiceNavigationProvider ()
	Construct a navigation provider <emp>SHOULD ONLY BE CALLED BY BOTBASES, NOT PLUGINS OR ROUTINES</emp>
override bool	Clear ()
	Clears the current path in this nav provider. Returns
override void	OnPulse ()
override void	OnSetAsCurrent ()
	Called when this NavigationProvider is set as the current by assigning it to Navigator.NavigationProvider.When this is called, the current has not yet been updated, so IsCurrent will still be false.
override void	OnRemoveAsCurrent ()
	Called when this NavigationProvider is removed as the current by assigning a different provider to Navigator.NavigationProvider.When this is called, the current has not yet been updated, so IsCurrent will still be true.
override MoveResult	MoveTo (MoveToParameters parameters)
override bool	AtLocation (Vector3 point1, Vector3 point2)
override PathInformation	LookupPathInfo (GameObject obj, float distanceTolerance)
	Looks up the information of a path going to an object. Parameters obj The object. distanceTolerance The distance to get within obj . Exceptions ArgumentNullException obj is null. Returns The path information. Always non-null. Path information lookups are in general extremely fast to perform. They require minimal CPU computation.
override async Task< List< CanFullyNavigateResult > >	CanFullyNavigateTo (ICollection< CanFullyNavigateTarget > targets, Vector3 start, ushort zoneid)
	Check if multiple locations can be pathed to on the given zoneid.This is an external asynchronous task, and should not be awaited directly from coroutines. See Coroutine.ExternalTask(Task) Parameters targets start zoneid Returns This is an external asynchronous task, and should not be awaited directly from coroutines. See Coroutine.ExternalTask(Task).
override async Task< List< CanFullyNavigateResult > >	CanFullyNavigateFrom (ICollection< CanFullyNavigateTarget > starts, Vector3 target, ushort zoneid)
	Check if multiple locations can be path from to one specific spot.This is an external asynchronous task, and should not be awaited directly from coroutines. See Coroutine.ExternalTask(Task) Parameters starts target zoneid Returns This is an external asynchronous task, and should not be awaited directly from coroutines. See Coroutine.ExternalTask(Task).
override async Task< List< Vector3 > >	SamplePointsAsync (SamplePointsParameters parameters)
	Samples the navigator for points. Parameters parameters The parameters. Exceptions ArgumentNullException parameters is null. ArgumentException parameters is in an invalid state. Returns The result of the sampling. This is an external asynchronous task, and should not be awaited directly from coroutines. See Coroutine.ExternalTask(Func<Task>).
override void	ClearStuckInfo ()
	Clears the stuck handler information.
void	Dispose ()
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.
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.

Additional Inherited Members
Properties inherited from ff14bot.Pathing.NavigationProvider
bool	IsCurrent [get]
	Gets a bool that indicates whether this is the current navigation provider.

Detailed Description

Latest and greatest navigation provider.

Constructor & Destructor Documentation

ServiceNavigationProvider()

ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.ServiceNavigationProvider

(

)

Construct a navigation provider <emp>SHOULD ONLY BE CALLED BY BOTBASES, NOT PLUGINS OR ROUTINES</emp>

Member Function Documentation

AtLocation()

override bool ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.AtLocation	(	Vector3	point1,
		Vector3	point2 )

CanFullyNavigateFrom()

override async Task< List< CanFullyNavigateResult > > ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.CanFullyNavigateFrom ( ICollection< CanFullyNavigateTarget > starts, Vector3 target, ushort zoneid )

virtual

Check if multiple locations can be path from to one specific spot.This is an external asynchronous task, and should not be awaited directly from coroutines. See Coroutine.ExternalTask(Task)

Parameters

starts
target
zoneid

Returns

This is an external asynchronous task, and should not be awaited directly from coroutines. See Coroutine.ExternalTask(Task).

Reimplemented from ff14bot.Pathing.NavigationProvider.

CanFullyNavigateTo()

override async Task< List< CanFullyNavigateResult > > ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.CanFullyNavigateTo ( ICollection< CanFullyNavigateTarget > targets, Vector3 start, ushort zoneid )

virtual

Check if multiple locations can be pathed to on the given zoneid.This is an external asynchronous task, and should not be awaited directly from coroutines. See Coroutine.ExternalTask(Task)

Parameters

targets
start
zoneid

Returns

This is an external asynchronous task, and should not be awaited directly from coroutines. See Coroutine.ExternalTask(Task).

Reimplemented from ff14bot.Pathing.NavigationProvider.

Clear()

override bool ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.Clear ( )

virtual

Clears the current path in this nav provider.

Returns

Reimplemented from ff14bot.Pathing.NavigationProvider.

ClearStuckInfo()

override void ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.ClearStuckInfo ( )

virtual

Clears the stuck handler information.

Reimplemented from ff14bot.Pathing.NavigationProvider.

Dispose()

void ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.Dispose

(

)

LookupPathInfo()

override PathInformation ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.LookupPathInfo ( GameObject obj, float distanceTolerance )

virtual

Looks up the information of a path going to an object.

Parameters

obj	The object.
distanceTolerance	The distance to get within obj .

Exceptions

ArgumentNullException

obj is null.

Returns

The path information. Always non-null.

Path information lookups are in general extremely fast to perform. They require minimal CPU computation.

Reimplemented from ff14bot.Pathing.NavigationProvider.

MoveTo()

override MoveResult ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.MoveTo

(

MoveToParameters

parameters

)

OnPulse()

override void ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.OnPulse

(

)

OnRemoveAsCurrent()

override void ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.OnRemoveAsCurrent ( )

virtual

Called when this NavigationProvider is removed as the current by assigning a different provider to Navigator.NavigationProvider.When this is called, the current has not yet been updated, so IsCurrent will still be true.

Reimplemented from ff14bot.Pathing.NavigationProvider.

OnSetAsCurrent()

override void ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.OnSetAsCurrent ( )

virtual

Called when this NavigationProvider is set as the current by assigning it to Navigator.NavigationProvider.When this is called, the current has not yet been updated, so IsCurrent will still be false.

Reimplemented from ff14bot.Pathing.NavigationProvider.

SamplePointsAsync()

override async Task< List< Vector3 > > ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.SamplePointsAsync ( SamplePointsParameters parameters )

virtual

Samples the navigator for points.

Parameters

parameters

The parameters.

Exceptions

ArgumentNullException	parameters is null.
ArgumentException	parameters is in an invalid state.

Returns

The result of the sampling.

This is an external asynchronous task, and should not be awaited directly from coroutines. See Coroutine.ExternalTask(Func<Task>).

Reimplemented from ff14bot.Pathing.NavigationProvider.