ff14bot.Pathing.MoveToParameters Class Reference

Represents parameters for NavigationProvider.MoveTo. More...

Public Member Functions
	MoveToParameters ()
	MoveToParameters (Vector3 location, string destination=null)
override string	ToString ()
	Gets a string representation of these parameters.

Public Attributes
WorldState	WorldState
	Used by deep dungeon.

Properties
Vector3	Location [get, set]
	The location to move to.
bool	UseMount = CharacterSettings.Instance.UseMount [get, set]
	Should the navigator attempt to mount up, this defaults to whatever is selected by the user.
string	Destination [get, set]
float	DistanceTolerance = DefaultDistanceTolerance [get, set]
	The distance tolerance to get within Location.
ushort?	MapId [get, set]
	The map ID of the location.
bool	MoveImmediately = true [get, set]
	If true, instructs the nav provider to move immediately once the path has been generated, so the player will start moving at the same time as MoveResult.PathGenerated is returned. If false, instructs the nav provider to wait until the next movement request after the path generation has finished to begin moving. This is for example useful for inspecting the path if it succeeds and aborting the navigation if the path generated was too long.

Detailed Description

Represents parameters for NavigationProvider.MoveTo.

Constructor & Destructor Documentation

MoveToParameters() [1/2]

ff14bot.Pathing.MoveToParameters.MoveToParameters

(

)

MoveToParameters() [2/2]

ff14bot.Pathing.MoveToParameters.MoveToParameters	(	Vector3	location,
		string	destination = null )

Member Function Documentation

ToString()

override string ff14bot.Pathing.MoveToParameters.ToString

(

)

Gets a string representation of these parameters.

Member Data Documentation

WorldState

WorldState ff14bot.Pathing.MoveToParameters.WorldState

Used by deep dungeon.

Property Documentation

Destination

string ff14bot.Pathing.MoveToParameters.Destination

getset

DistanceTolerance

float ff14bot.Pathing.MoveToParameters.DistanceTolerance = DefaultDistanceTolerance

getset

The distance tolerance to get within Location.

Exceptions

ArgumentOutOfRangeException

Thrown if the property is set to a value that is 0 or lower.

The default value for this property is 5.0f.

Location

Vector3 ff14bot.Pathing.MoveToParameters.Location

getset

The location to move to.

MapId

ushort? ff14bot.Pathing.MoveToParameters.MapId

getset

The map ID of the location.

If null, use current map.

MoveImmediately

bool ff14bot.Pathing.MoveToParameters.MoveImmediately = true

getset

If true, instructs the nav provider to move immediately once the path has been generated, so the player will start moving at the same time as MoveResult.PathGenerated is returned. If false, instructs the nav provider to wait until the next movement request after the path generation has finished to begin moving. This is for example useful for inspecting the path if it succeeds and aborting the navigation if the path generated was too long.

Default value: true.

UseMount

bool ff14bot.Pathing.MoveToParameters.UseMount = CharacterSettings.Instance.UseMount

getset

Should the navigator attempt to mount up, this defaults to whatever is selected by the user.