Inheritance diagram for ff14bot.Pathing.NavigationProvider:

Public Member Functions
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 bool	Clear ()
	Clears the current path in this nav provider.
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.

Properties
bool	IsCurrent `[get]`
	Gets a bool that indicates whether this is the current navigation provider.

Member Function Documentation

◆ AtLocation()

bool ff14bot.Pathing.NavigationProvider.AtLocation	(	Vector3	point1,
		Vector3	point2 )

abstract

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.

Parameters

point1	The first point.
point2	The second point.

Returns: True if the first point is at the second point; otherwise false.

◆ CanFullyNavigateFrom()

virtual Task< List< CanFullyNavigateResult > > ff14bot.Pathing.NavigationProvider.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 in ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.

◆ CanFullyNavigateTo() [1/2]

async Task< List< CanFullyNavigateResult > > ff14bot.Pathing.NavigationProvider.CanFullyNavigateTo ( ICollection< CanFullyNavigateTarget > targets )

Check if multiple locations can be pathed to on the current zone.

Parameters

targets

Returns

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

◆ CanFullyNavigateTo() [2/2]

virtual Task< List< CanFullyNavigateResult > > ff14bot.Pathing.NavigationProvider.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 in ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider.

◆ Clear()

virtual bool ff14bot.Pathing.NavigationProvider.Clear ( )

virtual

Clears the current path in this nav provider.

Returns

Reimplemented in ff14bot.Navigation.AStarNavigator, ff14bot.Navigation.NullProvider, ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider, and ff14bot.Pathing.Service_Navigation.WrappingNavigationProvider.

◆ ClearStuckInfo()

virtual void ff14bot.Pathing.NavigationProvider.ClearStuckInfo ( )

virtual

Clears the stuck handler information.

Reimplemented in ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider, and ff14bot.Pathing.Service_Navigation.WrappingNavigationProvider.

◆ LookupPathInfo()

virtual PathInformation ff14bot.Pathing.NavigationProvider.LookupPathInfo	(	GameObject	obj,
		float	distanceTolerance = 3f )

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 in ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider, and ff14bot.Pathing.Service_Navigation.WrappingNavigationProvider.

◆ MoveTo()

MoveResult ff14bot.Pathing.NavigationProvider.MoveTo ( MoveToParameters parameters )

abstract

Moves towards the specified locations.

Parameters

parameters The parameters.

Returns: A result that indicates what step was performed.

This function should return instantly, and should be able to be called again to perform the next step of the movement.

◆ OnPulse()

void ff14bot.Pathing.NavigationProvider.OnPulse ( )

abstract

Pulses this provider. Called every tick.

◆ OnRemoveAsCurrent()

virtual void ff14bot.Pathing.NavigationProvider.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 in ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider, and ff14bot.Pathing.Service_Navigation.WrappingNavigationProvider.

◆ OnSetAsCurrent()

virtual void ff14bot.Pathing.NavigationProvider.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 in ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider, and ff14bot.Pathing.Service_Navigation.WrappingNavigationProvider.

◆ SamplePointsAsync()

virtual Task< List< Vector3 > > ff14bot.Pathing.NavigationProvider.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 in ff14bot.Pathing.Service_Navigation.ServiceNavigationProvider, and ff14bot.Pathing.Service_Navigation.WrappingNavigationProvider.

Property Documentation

◆ IsCurrent

bool ff14bot.Pathing.NavigationProvider.IsCurrent

get

Gets a bool that indicates whether this is the current navigation provider.

Public Member Functions

Properties

Member Function Documentation

◆ AtLocation()

◆ CanFullyNavigateFrom()

◆ CanFullyNavigateTo() [1/2]

◆ CanFullyNavigateTo() [2/2]

◆ Clear()

◆ ClearStuckInfo()

◆ LookupPathInfo()

◆ MoveTo()

◆ OnPulse()

◆ OnRemoveAsCurrent()

◆ OnSetAsCurrent()

◆ SamplePointsAsync()

Property Documentation

◆ IsCurrent