_MinchinWeb_WBC_ Class Reference

Waterbody Check (deprecated) More...

Classes
class	Cost

Public Member Functions
function	InitializePath (sources, goals)
function	FindPath (iterations)
function	GetPathLength ()
	How long is the (found) path?
function	PresetSafety (Start, End)
	Caps the pathfinder as twice the Manhattan distance between the two tiles.

Private Member Functions
	constructor ()
function	_Cost (self, path, new_tile, new_direction)
function	_Estimate (self, cur_tile, cur_direction, goal_tiles)
function	_Neighbours (self, path, cur_node)
function	_CheckDirection (self, tile, existing_direction, new_direction)
function	_GetDirection (from, to)

Private Attributes
	_aystar_class = import("graph.aystar", "", 6)
	_cost_per_tile = null
	_max_cost = null
	The maximum cost for a route.
	_distance_penalty = null
	Penalty to use to speed up pathfinder, 1 is no penalty.
	_pathfinder = null
	cost = null
	Used to change the costs.
	_running = null
	Is it running?
	_my_path = null

Detailed Description

Waterbody Check (deprecated)

Version

v.1 (2012-01-05)

Author

W. Minchin (MinchinWeb)

Since

MetaLibrary v.1

Note

Waterbody Check has been deprecated in favour of _MinchinWeb_Lakes_ (Lakes).

Waterbody check is in effect a specialized pathfinder. It serves to check whether two points are in the same waterbody (i.e. a ship could travel between them). It is optimized to run extremely fast (I hope!). It can be called separately, but was originally designed as a pre-run check for my Ship Pathfinder (also included in this MetaLibrary).

It is based on the NoAI Team's Road Pathfinder v3.

Depends On:\n Graph.AyStar v6 library

See also

_MinchinWeb_ShipPathfinder_

_MinchinWeb_Lakes_

Todo

Add a cost for turns that then this would function as a 'real' pathfinder (maybe...)

Definition at line 60 of file Waterbody.Check.nut.

Member Function Documentation

_CheckDirection()

function _MinchinWeb_WBC_::_CheckDirection ( self , tile , existing_direction , new_direction  )

private

Definition at line 221 of file Waterbody.Check.nut.

_Cost()

function _MinchinWeb_WBC_::_Cost ( self , path , new_tile , new_direction  )

private

Definition at line 173 of file Waterbody.Check.nut.

_Estimate()

function _MinchinWeb_WBC_::_Estimate ( self , cur_tile , cur_direction , goal_tiles  )

private

Definition at line 190 of file Waterbody.Check.nut.

_GetDirection()

function _MinchinWeb_WBC_::_GetDirection ( from , to  )

private

Definition at line 225 of file Waterbody.Check.nut.

_Neighbours()

function _MinchinWeb_WBC_::_Neighbours ( self , path , cur_node  )

private

Todo

Add diagonals to possible neighbours

Definition at line 200 of file Waterbody.Check.nut.

constructor()

_MinchinWeb_WBC_::constructor ( )

inlineprivate

Definition at line 70 of file Waterbody.Check.nut.

FindPath()

function _MinchinWeb_WBC_::FindPath

(

iterations

)

Try to find the path as indicated with InitializePath with the lowest cost.

Parameters

iterations

After how many iterations it should abort for a moment. This value should either be -1 for infinite, or > 0. Any other value aborts immediately and will never find a path.

Returns

A route if one was found, or false if the amount of iterations was reached, or null if no path was found.

You can call this function over and over as long as it returns false, which is an indication it is not yet done looking for a route.

See also

AyStar::FindPath()

Definition at line 165 of file Waterbody.Check.nut.

GetPathLength()

function _MinchinWeb_WBC_::GetPathLength

(

)

How long is the (found) path?

Returns

Path length in tiles

Definition at line 233 of file Waterbody.Check.nut.

InitializePath()

function _MinchinWeb_WBC_::InitializePath ( sources , goals  )

inline

Initialize a path search between sources and goals.

Parameters

sources	The source tiles.
goals	The target tiles.

See also

AyStar::InitializePath()

Definition at line 86 of file Waterbody.Check.nut.

PresetSafety()

function _MinchinWeb_WBC_::PresetSafety	(	Start	,
		End	)

Caps the pathfinder as twice the Manhattan distance between the two tiles.

Definition at line 247 of file Waterbody.Check.nut.

Member Data Documentation

_aystar_class

_MinchinWeb_WBC_::_aystar_class = import("graph.aystar", "", 6)

private

Definition at line 61 of file Waterbody.Check.nut.

_cost_per_tile

_MinchinWeb_WBC_::_cost_per_tile = null

private

Definition at line 62 of file Waterbody.Check.nut.

_distance_penalty

_MinchinWeb_WBC_::_distance_penalty = null

private

Penalty to use to speed up pathfinder, 1 is no penalty.

Definition at line 64 of file Waterbody.Check.nut.

_max_cost

_MinchinWeb_WBC_::_max_cost = null

private

The maximum cost for a route.

Definition at line 63 of file Waterbody.Check.nut.

_my_path

_MinchinWeb_WBC_::_my_path = null

private

Definition at line 68 of file Waterbody.Check.nut.

_pathfinder

_MinchinWeb_WBC_::_pathfinder = null

private

Definition at line 65 of file Waterbody.Check.nut.

_running

_MinchinWeb_WBC_::_running = null

private

Is it running?

Definition at line 67 of file Waterbody.Check.nut.

cost

_MinchinWeb_WBC_::cost = null

private

Used to change the costs.

Definition at line 66 of file Waterbody.Check.nut.

---

The documentation for this class was generated from the following file:

• Waterbody.Check.nut