ff14bot.Navigation.Navigator Class Reference

Static Public Member Functions
static MoveResult	MoveTo (Vector3 location, string destination=null)
static MoveResult	MoveTo (MoveToParameters moveToParameters)
static MoveResult	MoveToPointWithin (Vector3 location, float radius, string destination=null)
static PathInformation	LookupPathInfo (GameObject obj, float distanceTolerance=MoveToParameters.DefaultDistanceTolerance)
	Looks up the information of a path going to an object.
static Task< List< Vector3 > >	SamplePointsAsync (SamplePointsParameters parameters)
	Samples the navigator for points.
static void	Stop ()
static void	Clear ()
static bool	InPosition (Vector3 location1, Vector3 location2, float range)
	Checks to see if location1 is within range of location2 Does XZ plane check separately from Y plane to better handle 3D locations.
static bool	AtLocation (Vector3 point1, Vector3 point2)
	Checks if one point is considered to be at another point. This should be used to check if the player is near a point.
static bool	AtLocation (Vector3 point)
	Checks if the local player is considered to be on top of a point.

Properties
static NavigationProvider	NavigationProvider [get, set]
	Gets or sets the navigation provider.
static IPlayerMover	PlayerMover [get, set]

Events
static EventHandler< NavigationProviderChangedEventArgs< NavigationProvider > >	OnNavigationProviderChanged
	Event queue for all listeners interested in OnNavigationProviderChanged events.
static EventHandler< NavigationProviderChangedEventArgs< IPlayerMover > >	OnPlayerMoverChanged
	Event queue for all listeners interested in OnPlayerMoverChanged events.

Member Function Documentation

AtLocation() [1/2]

bool ff14bot.Navigation.Navigator.AtLocation ( Vector3 point )

static

Checks if the local player is considered to be on top of a point.

Parameters

point

.

Returns

true if it succeeds, false if it fails.

AtLocation() [2/2]

bool ff14bot.Navigation.Navigator.AtLocation ( Vector3 point1, Vector3 point2 )

static

Checks if one point is considered to be at another point. This should be used to check if the player is near a point.

Exceptions

InvalidOperationException

Thrown when the requested operation is invalid.

Parameters

point1	.
point2	.

Returns

true if it succeeds, false if it fails.

Clear()

void ff14bot.Navigation.Navigator.Clear ( )

static

InPosition()

bool ff14bot.Navigation.Navigator.InPosition ( Vector3 location1, Vector3 location2, float range )

static

Checks to see if location1 is within range of location2 Does XZ plane check separately from Y plane to better handle 3D locations.

Parameters

location1
location2
range

Returns

LookupPathInfo()

PathInformation ff14bot.Navigation.Navigator.LookupPathInfo ( GameObject obj, float distanceTolerance = MoveToParameters::DefaultDistanceTolerance )

static

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.

MoveTo() [1/2]

MoveResult ff14bot.Navigation.Navigator.MoveTo ( MoveToParameters moveToParameters )

static

MoveTo() [2/2]

MoveResult ff14bot.Navigation.Navigator.MoveTo ( Vector3 location, string destination = null )

static

MoveToPointWithin()

MoveResult ff14bot.Navigation.Navigator.MoveToPointWithin ( Vector3 location, float radius, string destination = null )

static

SamplePointsAsync()

Task< List< Vector3 > > ff14bot.Navigation.Navigator.SamplePointsAsync ( SamplePointsParameters parameters )

static

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. Note that this may return fewer points than requested.

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

Stop()

void ff14bot.Navigation.Navigator.Stop ( )

static

Property Documentation

NavigationProvider

NavigationProvider ff14bot.Navigation.Navigator.NavigationProvider

staticgetset

Gets or sets the navigation provider.

The navigation provider.

Exceptions

ArgumentNullException

value is null.

When setting this property, Pathing.NavigationProvider.OnSetAsCurrent will be called on the new navigation provider, if applicable.

Similarly, Pathing.NavigationProvider.OnRemoveAsCurrent will be called on the old navigation provider, if applicable.

If an exception is thrown in any of these two functions, the state remains unchanged.

PlayerMover

IPlayerMover ff14bot.Navigation.Navigator.PlayerMover

staticgetset

Event Documentation

OnNavigationProviderChanged

EventHandler<NavigationProviderChangedEventArgs<NavigationProvider> > ff14bot.Navigation.Navigator.OnNavigationProviderChanged

static

Event queue for all listeners interested in OnNavigationProviderChanged events.

OnPlayerMoverChanged

EventHandler<NavigationProviderChangedEventArgs<IPlayerMover> > ff14bot.Navigation.Navigator.OnPlayerMoverChanged

static

Event queue for all listeners interested in OnPlayerMoverChanged events.