ff14bot.Pathing.SamplePointsParameters Class Reference

Represents parameters for sampling points with a navigation provider. More...

Static Public Member Functions
static SamplePointsParameters	Any (IEnumerable< SampleCircle > circles, int numPoints, ushort zoneid)
	Find any points in the specified circles.
static SamplePointsParameters	HighlyConnected (IEnumerable< SampleCircle > circles, int numPoints, ushort zoneid)
	Find points in the specified circles that are highly connected (i.e. with navigability to lots of other points).
static SamplePointsParameters	NavigableTo (IEnumerable< SampleCircle > circles, int numPoints, Vector3 from, ushort zoneid)
	Find points in the specified cirles that can be navigated to from the specified location.
static SamplePointsParameters	NavigableFrom (IEnumerable< SampleCircle > circles, int numPoints, Vector3 to, ushort zoneid, float destinationTolerance=MoveToParameters.DefaultDistanceTolerance)
	Find points in the specified circles that can be navigated from to the specified location.

Properties
ushort	ZoneId [get, set]
SamplePointsType	Type [get, set]
	The type of points to sample.
IReadOnlyList< SampleCircle >	Circles [get, set]
	The circles to sample points within.
int	NumPoints [get, set]
	The number of points to try to find.
Vector3	NavigabilityLocation [get, set]
	The location that the sampled points must be navigable from or to, depending on Type.
float	NavigableFromDestinationTolerance = MoveToParameters.DefaultDistanceTolerance [get, set]
	When Type is SamplePointsType.NavigableFrom, specifies the distance we must be able to get within NavigabilityLocation from the sampled points.

Detailed Description

Represents parameters for sampling points with a navigation provider.

Member Function Documentation

Any()

SamplePointsParameters ff14bot.Pathing.SamplePointsParameters.Any ( IEnumerable< SampleCircle > circles, int numPoints, ushort zoneid )

static

Find any points in the specified circles.

Parameters

circles	The circles.
numPoints	The number of points to try to sample.

Returns

The parameters.

HighlyConnected()

SamplePointsParameters ff14bot.Pathing.SamplePointsParameters.HighlyConnected ( IEnumerable< SampleCircle > circles, int numPoints, ushort zoneid )

static

Find points in the specified circles that are highly connected (i.e. with navigability to lots of other points).

Parameters

circles	The circles to sample points in.
numPoints	The number of points to try to sample.

Returns

The parameters.

NavigableFrom()

SamplePointsParameters ff14bot.Pathing.SamplePointsParameters.NavigableFrom ( IEnumerable< SampleCircle > circles, int numPoints, Vector3 to, ushort zoneid, float destinationTolerance = MoveToParameters::DefaultDistanceTolerance )

static

Find points in the specified circles that can be navigated from to the specified location.

Parameters

circles	The circles to sample points in.
numPoints	The number of points to try to sample.
to	The location we must be able to navigate to.
destinationTolerance	The destination to get within to

Returns

The parameters.

NavigableTo()

SamplePointsParameters ff14bot.Pathing.SamplePointsParameters.NavigableTo ( IEnumerable< SampleCircle > circles, int numPoints, Vector3 from, ushort zoneid )

static

Find points in the specified cirles that can be navigated to from the specified location.

Parameters

circles	The circles to sample points in.
numPoints	The number of points to try to sample.
from	The location we must be able to navigate from. Usually our own position.

Returns

The parameters.

Property Documentation

Circles

IReadOnlyList<SampleCircle> ff14bot.Pathing.SamplePointsParameters.Circles

getset

The circles to sample points within.

NavigabilityLocation

Vector3 ff14bot.Pathing.SamplePointsParameters.NavigabilityLocation

getset

The location that the sampled points must be navigable from or to, depending on Type.

NavigableFromDestinationTolerance

float ff14bot.Pathing.SamplePointsParameters.NavigableFromDestinationTolerance = MoveToParameters.DefaultDistanceTolerance

getset

When Type is SamplePointsType.NavigableFrom, specifies the distance we must be able to get within NavigabilityLocation from the sampled points.

See MoveToParameters.DistanceTolerance.

NumPoints

int ff14bot.Pathing.SamplePointsParameters.NumPoints

getset

The number of points to try to find.

Type

SamplePointsType ff14bot.Pathing.SamplePointsParameters.Type

getset

The type of points to sample.

ZoneId

ushort ff14bot.Pathing.SamplePointsParameters.ZoneId

getset